trustchain-oc1-orchestral
/
authentik
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/docs/installation/docker-compose.md

43 lines
1.6 KiB
Markdown
Raw Normal View History

docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
# docker-compose
docs(docker-compose.md): grammar and clarity Improved grammar and clarified some points.
2020-06-18 15:59:01 +00:00
This installation method is for test-setups and small-scale productive setups.
docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
## Prerequisites
- docker
- docker-compose
## Install
docker: fix old dockerfiles being used, remove all gitlab references
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.
docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
docs: fix environment variable for error reporting
2020-09-17 19:22:46 +00:00
To optionally enable error-reporting, run `echo PASSBOOK_ERROR_REPORTING__ENABLED=true >> .env`
docs: remove default password for docker-compose, improve instructions
2020-09-14 20:54:25 +00:00
new release: 0.10.4-stable
2020-09-19 17:40:58 +00:00
To optionally deploy a different version run `echo PASSBOOK_TAG=0.10.4-stable >> .env`
docs: remove default password for docker-compose, improve instructions
2020-09-14 20:54:25 +00:00
If this is a fresh passbook install run the following commands to generate a password:
```
sudo apt-get install -y pwgen
echo "PG_PASS=$(pwgen 40 1)" >> .env
echo "PASSBOOK_SECRET_KEY=$(pwgen 50 1)" >> .env
```
Afterwards, run these commands to finish
docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
```
docs: update docker-compose install form README
2020-06-08 20:09:04 +00:00
docker-compose pull
docker-compose up -d
docs: remove manual upgrade instructions as they are automatic now
2020-09-10 11:04:51 +00:00
docker-compose run --rm server migrate
docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
```
docs: add initial login instructions
2020-06-08 20:11:01 +00:00
docs: remove manual upgrade instructions as they are automatic now
2020-09-10 11:04:51 +00:00
The compose file statically references the latest version available at the time of downloading, which can be overridden with the `SERVER_TAG` environment variable.
docs: add initial structure, add docs for policies and factors
2019-12-09 20:00:45 +00:00
docs(docker-compose.md): grammar and clarity Improved grammar and clarified some points.
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.
docs: add initial structure, add docs for policies and factors
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.
Merge branch 'pr/77' # Conflicts: # docs/flow/flows.md # docs/installation/docker-compose.md # docs/providers.md
2020-06-18 20:10:03 +00:00
passbook will then be reachable via HTTP on port 80, and HTTPS on port 443. You can optionally configure the packaged traefik to use Let's Encrypt certificates for TLS Encryption.
docs: clarify post-installation login
2020-06-18 21:26:15 +00:00
The initial setup process also creates a default admin user, the username and password for which is `pbadmin`. It is highly recommended to change this password as soon as you log in.