These changes add a docker-compose.yml file and associated documentation to the README, as per issue #5.
I wasn't sure how best to integrate the option of installing with docker-compose into the docs, so I ended up adding it after the "If you've installed before" section. Then it was getting difficult to see the document structure so I added a Table of Contents and adjusted the headings to match, which seems to make it a bit better.
I added a few "reasonable" security configuration options and their explanations to the docker-compose.yml file, commented out to give someone a starting point if they desire one of these kinds of deployments. "Security Option 1" (default, uncommented) is autologin, no security; "Security Option 2" is if you're behind a TLS reverse proxy with an admin password; "Security Option 3" is to handle TLS directly also with an admin password. I currently use "Security Option 2" and briefly tested "Security Option 1", I did not try "Security Option 3".
One might ask of this PR:
[ ] Is this a good spot for the (admittedly light) docker compose docs?
[ ] Are the changes to the README structure ok?
[ ] Is the addition of the ToC desired?
[ ] Is the description and discussion of "Security Options" in docker-compose.yml good?
These changes add a
docker-compose.ymlfile and associated documentation to the README, as per issue #5.I wasn't sure how best to integrate the option of installing with
docker-composeinto the docs, so I ended up adding it after the "If you've installed before" section. Then it was getting difficult to see the document structure so I added a Table of Contents and adjusted the headings to match, which seems to make it a bit better.I added a few "reasonable" security configuration options and their explanations to the
docker-compose.ymlfile, commented out to give someone a starting point if they desire one of these kinds of deployments. "Security Option 1" (default, uncommented) is autologin, no security; "Security Option 2" is if you're behind a TLS reverse proxy with an admin password; "Security Option 3" is to handle TLS directly also with an admin password. I currently use "Security Option 2" and briefly tested "Security Option 1", I did not try "Security Option 3".One might ask of this PR:
docker-compose.ymlgood?