generated from DAM/ts-TEMPLATE
update for config of authentik
This commit is contained in:
parent
3c167730fa
commit
93c1062179
17
README.md
17
README.md
@ -45,7 +45,22 @@ ts-authentik/
|
||||
- CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet
|
||||
|
||||
4. Configure Authentik
|
||||
- See [docs](https://docs.goauthentik.io/docs/) for configuration options
|
||||
- Authentik uses an environment variable file, or `.env`, that is passed in the compose to handle much of the configuration options. They then turn this to yaml 🤦♂️. Maybe one day when we fork all of these projects we can standardize the config format for all services to be yaml from the start. Because of this and to stay consistent with the original [documentation](https://version-2022-9.goauthentik.io/docs/installation/docker-compose#preparation) the database username and password as well as other fields commonly found in the compose are set in the `.env`. The following directions are for generating the `.env` file from linux cli. This method is recomended to ensure a strong `AUTHENTIK_SECRET_KEY` although you could just create your own manually.
|
||||
``` sh
|
||||
# You can also use openssl instead: `openssl rand -base64 36`
|
||||
sudo apt-get install -y pwgen
|
||||
# Because of a PostgreSQL limitation, only passwords up to 99 chars are supported
|
||||
# See https://www.postgresql.org/message-id/09512C4F-8CB9-4021-B455-EF4C4F0D55A0@amazon.com
|
||||
echo "PG_PASS=$(pwgen -s 40 1)" >> .env
|
||||
echo "AUTHENTIK_SECRET_KEY=$(pwgen -s 50 1)" >> .env
|
||||
# Skip if you don't want to enable error reporting
|
||||
echo "AUTHENTIK_ERROR_REPORTING__ENABLED=true" >> .env
|
||||
```
|
||||
- **OPTIONAL** See [docs](https://version-2022-9.goauthentik.io/docs/installation/configuration) for additional configuration options
|
||||
- A note about the docker-compose values.
|
||||
- `POSTGRES_PASSWORD:` This variable holds the password for the PostgreSQL database. The `${PG_PASS:?database password required}` syntax means that if this variable is not set, the system will throw an error and prompt the user to set it.
|
||||
- `POSTGRES_USER:` This variable holds the username for the PostgreSQL database. The `${PG_USER:-authentik}` syntax means that if this variable is not set, it will default to the value authentik.
|
||||
- `POSTGRES_DB:` This variable holds the name of the PostgreSQL database. The `${PG_DB:-authentik}` syntax means that if this variable is not set, it will default to the value authentik.
|
||||
|
||||
5. Start the Services
|
||||
```bash
|
||||
|
Loading…
x
Reference in New Issue
Block a user