1
0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 00:03:28 +01:00
pywb/README.rst
Ilya Kreymer 02bc7776ca config and docs work: (#255)
config and docs work:
- autoindexing now set in config via 'autoindex: <secs>' option
- autoindexing only runs in first uwsgi worker if in uwsgi
- recorder config: rename props to 'rollover_' to match docs
- docs: write configuring.rst section for recording mode, autoindexing and proxy mode!
- update README for new pywb release, point to new docs!
2017-10-15 22:47:23 -07:00

30 lines
998 B
ReStructuredText

Webrecorder pywb 2.0
====================
.. image:: https://travis-ci.org/ikreymer/pywb.svg?branch=master
:target: https://travis-ci.org/ikreymer/pywb
.. image:: https://coveralls.io/repos/ikreymer/pywb/badge.svg?branch=master
:target: https://coveralls.io/r/ikreymer/pywb?branch=master
**pywb** is a Python (2 and 3) web archive replay and recording toolkit.
This toolset forms the foundation of Webrecorder, but also provides a variety of web archiving tools,
such as the traditional "Wayback Machine" functionality.
Note: this version, which represents a major overhaul of pywb, is not yet released on pypi, but you can:
* Install with ``python setup.py install``
* Run tests with ``python setup.py test``
* Run Wayback with ``wayback`` (see docs for info on how to setup collections)
* Build docs locally with: ``cd docs; make html``
* ..and a lot more!
Please see the `Webrecorder pywb documentation for usage and configuration info <https://pywb.readthedocs.org>`_