2019-12-09 20:00:45 +00:00
# docker-compose
2020-06-18 15:59:01 +00:00
This installation method is for test-setups and small-scale productive setups.
2019-12-09 20:00:45 +00:00
## Prerequisites
- docker
- docker-compose
## Install
2019-12-30 09:34:31 +00:00
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.
2019-12-09 20:00:45 +00:00
2020-06-18 15:59:01 +00:00
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:
2019-12-09 20:00:45 +00:00
```
export PASSBOOK_DOMAIN=domain.tld # this can be any domain or IP, it just needs to point to passbook.
```
2020-06-18 15:59:01 +00:00
The compose file references the current latest version, which can be overridden with the `SERVER_TAG` environment variable.
2019-12-09 20:00:45 +00:00
2020-06-18 15:59:01 +00:00
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.
2019-12-09 20:00:45 +00:00
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.
2020-06-18 15:59:01 +00:00
passbook will then be reachable on port 80. You can optionally configure the packaged traefik to use Let's Encrypt certificates for TLS Encryption.
