backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-24 06:59:52 +01:00
Code Issues Projects Releases Activity

fix readme typos

Browse Source
This commit is contained in:
Ilya Kreymer 2015-03-17 09:28:46 -07:00
parent 0345e36daa
commit 0b8fd1e82e
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -12,7 +12,7 @@ pywb is a python implementation of web archival replay tools, sometimes also kno
pywb allows high-quality replay (browsing) of archived web data stored in standardized `ARC <http://en.wikipedia.org/wiki/ARC_(file_format)>`_ and `WARC <http://en.wikipedia.org/wiki/Web_ARChive>`_. pywb allows high-quality replay (browsing) of archived web data stored in standardized `ARC <http://en.wikipedia.org/wiki/ARC_(file_format)>`_ and `WARC <http://en.wikipedia.org/wiki/Web_ARChive>`_.
The replay system is designed to accurately replay complex dynamic sites, including ``video and audio content <https://github.com/ikreymer/pywb/wiki/Video-Replay-and-Recording>``_ and sites The replay system is designed to accurately replay complex dynamic sites, including `video and audio content <https://github.com/ikreymer/pywb/wiki/Video-Replay-and-Recording>`_ and sites
with complex JavaScript. with complex JavaScript.
The software can run as a traditional web application or an HTTP or HTTPS proxy server, and has been tested on Linux, OS X and Windows platforms. The software can run as a traditional web application or an HTTP or HTTPS proxy server, and has been tested on Linux, OS X and Windows platforms.
@ -56,13 +56,13 @@ Congrats, you are now running your own Wayback Machine!
A more `detailed tutorial is available on the wiki <https://github.com/ikreymer/pywb/wiki/Auto-Configuration-and-Wayback-Collections-Manager>`_. A more `detailed tutorial is available on the wiki <https://github.com/ikreymer/pywb/wiki/Auto-Configuration-and-Wayback-Collections-Manager>`_.
Legacy `installation instructions <https://github.com/ikreymer/pywb/blob/0.9.0b/INSTALL.rst>`_ contains additional Legacy `installation instructions <https://github.com/ikreymer/pywb/blob/0.9.0b/INSTALL.rst>`_ contain additional
installation and testing examples, using a ``config.yaml`` file. These instructions are from previous releases but information and testing examples, and use a custom ``config.yaml`` file. These instructions are from previous releases but
still apply for pywb 0.9.0. still apply for pywb 0.9.0.
Running Samples and Tests Running Samples and Tests
""""""""""""""""""""""""" -------------------------
To run the bundled samples (also used by test suite), you'll need to clone pywb locally: To run the bundled samples (also used by test suite), you'll need to clone pywb locally:
@ -155,7 +155,7 @@ To run as an HTTPS proxy server, pywb provides a facility for generating a custo
(The certificate should be used with caution within a controlled setting). (The certificate should be used with caution within a controlled setting).
Using these features requiring an extra dependency: the pyopenssl library must be installed via ``pip install pyopenssl`` Using these features requiring an extra dependency: the pyopenssl library must be installed via ``pip install pyopenssl``
For more info, see ``Proxy Mode Usage <https://github.com/ikreymer/pywb/wiki/Pywb-Proxy-Mode-Usage>``_ For more info, see `Proxy Mode Usage <https://github.com/ikreymer/pywb/wiki/Pywb-Proxy-Mode-Usage>`_
The `pywb-proxy-demo <https://github.com/ikreymer/pywb-proxy-demo>`_ project also contains a working configuration of proxy mode deployment. The `pywb-proxy-demo <https://github.com/ikreymer/pywb-proxy-demo>`_ project also contains a working configuration of proxy mode deployment.
@ -205,9 +205,9 @@ Replay: ``http://<host>/<collection>/<timestamp>/<original url>``
Query Listing: ``http://<host>/<collection>/*/<original url>`` Query Listing: ``http://<host>/<collection>/*/<original url>``
- ex: http://pywb.herokuapp.com/pywb/*/http://iana.org/ - ex: http://pywb.herokuapp.com/pywb/\*/http://iana.org/
- ex: http://web.archive.org/web/*/http://www.example.com/ - ex: http://web.archive.org/web/\*/http://www.example.com/
Additional Reference Additional Reference