From 553a489e43ca4d3ab8b0ba19a0d569e277bb06db Mon Sep 17 00:00:00 2001 From: Jafner <40403594+Jafner@users.noreply.github.com> Date: Sun, 1 Aug 2021 15:38:00 -0700 Subject: [PATCH] Minor readme cleanup --- 5etools-docker/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/5etools-docker/README.md b/5etools-docker/README.md index 51b604ce..2e5a8dd6 100644 --- a/5etools-docker/README.md +++ b/5etools-docker/README.md @@ -4,7 +4,9 @@ This is a simple image for hosting your own 5eTools instance. It is based on the ## Quickstart You can quick-start this image by running: + `docker run -d -p 80:80 --rm --name 5etools-docker -v 5etools:/usr/local/apache2/htdocs jafner/5etools-docker` + Then give the container a minute or two to come online and it will be accessible at `localhost`. When you stop the container, it will automatically delete itself, but the downloaded files will remain in the 5etools volume, so you can always start the container back up by re-running the command. @@ -28,6 +30,9 @@ Note: host directory mappings must be absolute (cannot use `.` to refer to worki Because this image is built on the auto-updater script, updating the container is very simple. Restart the container with `docker restart 5etools-docker`. When it restarts, the container will automatically check for an update and download it before starting. Note: there is no way to disable this auto-updating behavior except to never restart the container. If you want a specific version of the container, it is recommended that you look into using the `httpd` image instead. +### Using a different port +Change the value on the left side of the `-p 80:80` flag to the desired port. Leave the value on the right alone. + ### Integrating a reverse proxy Supporting integration of a reverse proxy is beyond the scope of this guide. However, any instructions which work for the base `httpd` (Apache) image, should also work for this, as it is minimally different.