Skip to content

Commit

Permalink
docs: elaborate on docker-compose examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ikreymer committed Nov 13, 2020
1 parent d86c72d commit d16f7bd
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/manual/owb-to-pywb-deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ Working Docker Compose Examples
-------------------------------

The pywb `Deployment Examples <https://github.com/webrecorder/pywb/blob/docs/sample-deploy/>`_ include working examples of deploying pywb with Nginx, Apache and OutbackCDX
in Docker using Docker Compose.
in Docker using Docker Compose, widely available container orchestration tools.

See `Installing Docker <https://docs.docker.com/get-docker/>`_ and `Installing Docker Compose <https://docs.docker.com/compose/install/>`_ for instructions on how to install these tools.

The examples are available in the ``sample-deploy`` directory of the pywb repo. The examples include:

Expand All @@ -61,4 +63,18 @@ The examples are available in the ``sample-deploy`` directory of the pywb repo.
- ``docker-compose-apache.yaml`` -- Docker Compose config to launch pywb and latest Apache, with pywb running on subdirectory ``/wayback`` and Apache serving static files from pywb.


The examples are designed to be run one at a time, and assume port 8080 is available.

After installing Docker and Docker Compose, run either of:

- ``docker-compose -f docker-compose-outback.yaml up``
- ``docker-compose -f docker-compose-nginx.yaml up``
- ``docker-compose -f docker-compose-apache.yaml up``

This will download the standard Docker images and start all of the components in Docker.

If everything works correctly, you should be able to access: ``http://localhost:8080/pywb/https://example.com/`` to view the sample pywb collection.

Press CTRL+C to interrupt and stop the example in the console.


0 comments on commit d16f7bd

Please sign in to comment.