diff --git a/README.rst b/README.rst index 936ff044..10725a55 100644 --- a/README.rst +++ b/README.rst @@ -82,6 +82,37 @@ information and testing examples, and use a custom ``config.yaml`` file. These i still compatible with pywb 0.9.0. +Custom UI and User Metadata +--------------------------- + +**pywb** makes it easy to customize most aspects of the UI around archived content, including a custom banner insert, query calendar, search and home pages, +via HTML Jinja2 templates. + +You can see a list of all available UI templates by running: ``wayback-manager template --list`` + +To copy a default template to the file system (for modification), you can run ``wayback-manager template --add `` + +**pywb** now supports custom user metadata for each collection. The metadata may be specified in the ``metadata.yaml`` in each collection's directory. + +The metadata is accessible to all UI templates and may be displayed to the user as needed. + +See the `Wayback Manager Tutorial `_ and the +and `UI Customization `_ page for more details. + + +Automatic Indexing +------------------ + +**pywb** now also includes support for automatic indexing of any web archive files (WARC or ARC). + +Whenever a WARC/ARC file is added or changed, pywb will update the internal index automatically and make the archived content +instantly available for replay, without manual intervention or restart. (Of course, indexing will take some time if adding +many gigabytes of data all at once, but is quite useful for smaller archive updates). + +To enable auto-indexing, you can run the `wayback -a` when running command line, or run +`wb-manager autoindex ` as a seperate program. + + Samples and Tests ------------------------- @@ -196,37 +227,6 @@ For production deployments, `uWSGI --add `` - -**pywb** now supports custom user metadata for each collection. The metadata may be specified in the ``metadata.yaml`` in each collection's directory. - -The metadata is accessible to all UI templates and may be displayed to the user as needed. - -See the `Wayback Manager Tutorial `_ and the -and `UI Customization `_ page for more details. - - -Automatic Indexing ------------------- - -**pywb** now also includes support for automatic indexing of any web archive files (WARC or ARC). - -Whenever a WARC/ARC file is added or changed, pywb will update the internal index automatically and make the archived content -instantly available for replay, without manual intervention or restart. (Of course, indexing will take some time if adding -many gigabytes of data all at once, but is quite useful for smaller archive updates). - -To enable auto-indexing, you can run the `wayback -a` when running command line, or run -`wb-manager autoindex ` as a seperate program. - - Wayback Machine Compatibility -----------------------------