mirror of
https://github.com/webrecorder/pywb.git
synced 2025-03-14 15:53:28 +01:00
* docs work on OpenWayback -> pywb transition, part 1 * docs: add config change examples, exclusions and deploy recommendations * update with path index example * update terms with collection info * docs update: - add zipnum examples to owb-to-pywb config transition - add working docker compose examples for nginx subdirectory, apache subdirectory and outback cdx deployment in ./sample-deploy - update usage and owb-to-pywb deployment docs with updated subdiretory deployment info + sample-deploy links * tweak exclusion info, deploy title * add missing filee uwsgi_subdir.ini * Docs: fix typos and clarifications from review (thanks @ldko!) Co-authored-by: Lauren Ko <lauren.ko@unt.edu> * docs: explain that existing cdx can be added to outbackcdx, explain reindexing is optional * docs: elaborate on docker-compose examples * minor tweaks * update to latest wombat 3.0.2 * update CHANGES.rst * bump version to 2.5.0 for release Co-authored-by: Lauren Ko <lauren.ko@unt.edu>
33 lines
882 B
ReStructuredText
33 lines
882 B
ReStructuredText
.. pywb documentation master file, created by
|
|
sphinx-quickstart on Thu Sep 21 01:58:55 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Webrecorder pywb documentation!
|
|
================================
|
|
|
|
The Webrecorder (:mod:`pywb`) toolkit is a full-featured, advanced web archiving capture and replay framework for python.
|
|
It provides command-line tools and an extensible framework for high-fidelity web archive access and creation.
|
|
A subset of features provides the basic functionality of a "Wayback Machine".
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
manual/usage
|
|
manual/configuring
|
|
manual/access-control
|
|
manual/ui-customization
|
|
manual/architecture
|
|
manual/apis
|
|
manual/owb-transition
|
|
code/pywb
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|