mirror of
https://github.com/webrecorder/pywb.git
synced 2025-03-15 00:03:28 +01:00
final README.rst edits
This commit is contained in:
parent
18f7031423
commit
2c65521ea3
20
README.rst
20
README.rst
@ -18,20 +18,22 @@ pywb Tools
|
||||
|
||||
In addition to the standard wayback machine (explained further below), pywb tool suite includes a
|
||||
number of useful command-line and web server tools. The tools should be available to run after
|
||||
running ``python setup.py install``
|
||||
running ``python setup.py install``:
|
||||
|
||||
* ``live-rewrite-server`` -- a demo live rewriting web server which accepts requests using wayback machine url format at ``/rewrite/`` path, eg, ``/rewrite/http://example.com/`` and applies the same url rewriting rules as are used for archived content.
|
||||
This is useful for checking how live content will appear when archived before actually creating any archive files, or for recording data.
|
||||
The `webrecorder.io <https://webrecorder.io>`_ service is built using this tool.
|
||||
|
||||
* ``live-rewrite-server`` -- a demo live rewriting web server which accepts requests using wayback machine url format at ``/rewrite/`` path, eg, ``/rewrite/http://example.com/``
|
||||
and applies the same url rewriting rules as are used for archived content.
|
||||
This is useful for checking how live content will appear when archived before actually creating any archive files, or for recording data.
|
||||
The `webrecorder.io <https://webrecorder.io>`_ service is built using this tool.
|
||||
|
||||
* ``cdx-indexer`` -- a command-line tool for creating CDX indexs from WARC and ARC files. Supports SURT and
|
||||
non-SURT based cdx files and optional sorting. See ``cdx-indexer -h`` for all options.
|
||||
for all options.
|
||||
non-SURT based cdx files and optional sorting. See ``cdx-indexer -h`` for all options.
|
||||
for all options.
|
||||
|
||||
|
||||
* ``cdx-server`` -- a CDX API only server which returns a responses about CDX captures in bulk.
|
||||
Includes most of the features of the `original cdx server implementation <https://github.com/internetarchive/wayback/tree/master/wayback-cdx-server>`_,
|
||||
updated documentation coming soon.
|
||||
Includes most of the features of the `original cdx server implementation <https://github.com/internetarchive/wayback/tree/master/wayback-cdx-server>`_,
|
||||
updated documentation coming soon.
|
||||
|
||||
|
||||
* ``wayback`` -- The full Wayback Machine application, further explained below.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user