From c4d7d0213f67eaf4cbfe3f20066d8470c77331cb Mon Sep 17 00:00:00 2001 From: tigattack <10629864+tigattack@users.noreply.github.com> Date: Thu, 18 Jun 2020 16:59:01 +0100 Subject: [PATCH] docs(docker-compose.md): grammar and clarity Improved grammar and clarified some points. --- docs/installation/docker-compose.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installation/docker-compose.md b/docs/installation/docker-compose.md index 76b4a6a27..c8b08cce7 100644 --- a/docs/installation/docker-compose.md +++ b/docs/installation/docker-compose.md @@ -1,6 +1,6 @@ # docker-compose -This installation Method is for test-setups and small-scale productive setups. +This installation method is for test-setups and small-scale productive setups. ## Prerequisites @@ -11,16 +11,16 @@ This installation Method is for test-setups and small-scale productive setups. Download the latest `docker-compose.yml` from [here](https://raw.githubusercontent.com/BeryJu/passbook/master/docker-compose.yml). Place it in a directory of your choice. -passbook needs to know it's primary URL to create links in E-Mails and set cookies, so you have to run the following command: +passbook needs to know it's primary URL to create links in e-mails and set cookies, so you have to run the following command: ``` export PASSBOOK_DOMAIN=domain.tld # this can be any domain or IP, it just needs to point to passbook. ``` -The compose file references the current latest version, which can be overridden with the `SERVER_TAG` Environment variable. +The compose file references the current latest version, which can be overridden with the `SERVER_TAG` environment variable. -If you plan to use this setup for production, it is also advised to change the PostgreSQL Password by setting `PG_PASS` to a password of your choice. +If you plan to use this setup for production, it is also advised to change the PostgreSQL password by setting `PG_PASS` to a password of your choice. Now you can pull the Docker images needed by running `docker-compose pull`. After this has finished, run `docker-compose up -d` to start passbook. -passbook will then be reachable on Port 80. You can optionally configure the packaged traefik to use Let's Encrypt for TLS Encryption. +passbook will then be reachable on port 80. You can optionally configure the packaged traefik to use Let's Encrypt certificates for TLS Encryption.