mirror of
https://github.com/webrecorder/pywb.git
synced 2025-03-15 00:03:28 +01:00
6f79840b79
* metadata/coll_config: don't confuse user metadata with collection config, don't display collection config settings as metadata (ukwa/ukwa-pywb#47) - for collection template, add separate 'coll_config' dict, keep user metadata only in 'metadata' dict (default to empty) - for static collections, assume metadata is in the 'metadata' dict of collection config - for dynamic collections, load metadata.yaml into 'metadata' dict - ensure 'metadata' key is passed to frame_insert - ensure 'metadata' added consistently in framed and non-framed mode - tests: update tests to ensure metadata is added consistently - fuzzymatch: don't match 204 OPTIONS responses, update fuzzymatcher test * documentation - add documentation for metadata in ui-customization, rebuild docs, - add link to ui customization from configuring - work on access control docs * fixed small typo's in ui-customization.rst * frontendapp: fix doc string - misc: remove warning on urllib3 Retry init - set version to pywb 2.4.0rc0 Co-Authored-By: John Berlin <n0tan3rd@gmail.com>
77 lines
2.9 KiB
ReStructuredText
77 lines
2.9 KiB
ReStructuredText
Webrecorder pywb 2.4
|
|
====================
|
|
|
|
.. image:: https://travis-ci.org/webrecorder/pywb.svg?branch=master
|
|
:target: https://travis-ci.org/webrecorder/pywb
|
|
.. image:: https://ci.appveyor.com/api/projects/status/qxnbunw65o929599/branch/master?svg=true
|
|
:target: https://ci.appveyor.com/project/webrecorder/pywb/branch/master
|
|
.. image:: https://codecov.io/gh/webrecorder/pywb/branch/master/graph/badge.svg
|
|
:target: https://codecov.io/gh/webrecorder/pywb
|
|
|
|
Web Archiving Tools for All
|
|
---------------------------
|
|
|
|
`View the full pywb documentation <https://pywb.readthedocs.org>`_
|
|
|
|
**pywb** is a Python (2 and 3) web archiving toolkit for replaying web archives large and small as accurately as possible.
|
|
The toolkit now also includes new features for creating high-fidelity web archives.
|
|
|
|
This toolset forms the foundation of Webrecorder project, but also provides a generic web archiving toolkit
|
|
that is used by other web archives, including the traditional "Wayback Machine" functionality.
|
|
|
|
|
|
New Features
|
|
^^^^^^^^^^^^
|
|
|
|
The 2.x release included a major overhaul of pywb and introduces many new features, including the following:
|
|
|
|
* Dynamic multi-collection configuration system with no-restart updates.
|
|
|
|
* New recording capability to create new web archives from the live web or other archives.
|
|
|
|
* Componentized architecture with standalone Warcserver, Recorder and Rewriter components.
|
|
|
|
* Support for Memento API aggregation and fallback chains for querying multiple remote and local archival sources.
|
|
|
|
* HTTP/S Proxy Mode with customizable certificate authority for proxy mode recording and replay.
|
|
|
|
* Flexible rewriting system with pluggable rewriters for different content-types.
|
|
|
|
* Standalone, modular `client-side rewriting system (wombat.js) <https://github.com/webrecorder/wombat>`_ to handle most modern web sites.
|
|
|
|
* Improved 'calendar' query UI, grouping results by year and month, and updated replay banner.
|
|
|
|
* New with 2.4: An extensinble access control system.
|
|
|
|
|
|
Please see the `full documentation <https://pywb.readthedocs.org>`_ for more detailed info on all these features.
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
To run and install locally 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``. (The docs will be built in ``./_build/html/index.html``)
|
|
|
|
|
|
Consult the local or `online docs <https://pywb.readthedocs.org>`_ for latest usage and configuration details.
|
|
|
|
|
|
Contributions & Bug Reports
|
|
---------------------------
|
|
|
|
Users are encouraged to fork and contribute to this project to keep improving web archiving tools.
|
|
|
|
If you are interested in contributing, especially to any of these areas, please let us know!
|
|
|
|
Otherwise, please take a look at `list of current issues <https://github.com/webrecorder/pywb/issues>`_ and feel free to open new ones about any aspect of pywb, including the new documentation.
|
|
|
|
|