backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-28 08:32:29 +01:00
Code Issues Projects Releases Activity

README: move new features towards the top

Browse Source
This commit is contained in:
Ilya Kreymer 2015-03-24 10:56:56 -07:00
parent 3dd600c530
commit 872607c07d
1 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.rst
View File

@ -82,6 +82,37 @@ information and testing examples, and use a custom ``config.yaml`` file. These i
still compatible with pywb 0.9.0. 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 <collection> --add <template_name>``
**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 <https://github.com/ikreymer/pywb/wiki/Auto-Configuration-and-Wayback-Collections-Manager>`_ and the
and `UI Customization <https://github.com/ikreymer/pywb/wiki/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 <path/to/coll>` as a seperate program.
Samples and Tests Samples and Tests
------------------------- -------------------------
@ -196,37 +227,6 @@ For production deployments, `uWSGI <https://uwsgi-docs.readthedocs.org/en/latest
scripts in this repo provides examples of running pywb with uWSGI. scripts in this repo provides examples of running pywb with uWSGI.
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 <collection> --add <template_name>``
**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 <https://github.com/ikreymer/pywb/wiki/Auto-Configuration-and-Wayback-Collections-Manager>`_ and the
and `UI Customization <https://github.com/ikreymer/pywb/wiki/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 <path/to/coll>` as a seperate program.
Wayback Machine Compatibility Wayback Machine Compatibility
----------------------------- -----------------------------