diff --git a/website/docs/add-secure-apps/flows-stages/stages/email/index.mdx b/website/docs/add-secure-apps/flows-stages/stages/email/index.mdx index 7ab03f38d1..69e23067ea 100644 --- a/website/docs/add-secure-apps/flows-stages/stages/email/index.mdx +++ b/website/docs/add-secure-apps/flows-stages/stages/email/index.mdx @@ -48,11 +48,11 @@ import Tabs from "@theme/Tabs"; -Place any custom templates in the `custom-templates` Folder, which is in the same folder as your docker-compose file. Afterwards, you'll be able to select the template when creating/editing an Email stage. +Place any custom templates in the `custom-templates` Folder, which is in the same folder as your Compose file. Afterwards, you'll be able to select the template when creating/editing an Email stage. diff --git a/website/docs/add-secure-apps/providers/proxy/server_traefik.mdx b/website/docs/add-secure-apps/providers/proxy/server_traefik.mdx index 6f2d726aa5..602664d963 100644 --- a/website/docs/add-secure-apps/providers/proxy/server_traefik.mdx +++ b/website/docs/add-secure-apps/providers/proxy/server_traefik.mdx @@ -13,7 +13,7 @@ import Placeholders from "./__placeholders.md"; defaultValue="standalone-traefik" values={[ {label: 'Standalone traefik', value: 'standalone-traefik'}, - {label: 'docker-compose', value: 'docker-compose'}, + {label: 'Docker Compose', value: 'docker-compose'}, {label: 'Ingress', value: 'ingress'}, ]}> diff --git a/website/docs/index.mdx b/website/docs/index.mdx index 482ad4f181..70baf3a055 100755 --- a/website/docs/index.mdx +++ b/website/docs/index.mdx @@ -66,6 +66,6 @@ Our tech docs cover the typical topics, from installation to configuration, addi ## Installation -Refer to the installation steps in either [Docker-compose](./install-config/install/docker-compose.mdx) or [Kubernetes](./install-config/install/kubernetes.md). +Refer to the installation steps for either [Docker Compose](./install-config/install/docker-compose.mdx) or [Kubernetes](./install-config/install/kubernetes.md). For more information about configuration, beta versions, and additional installation options, see our main [Installation](./install-config/index.mdx) section. diff --git a/website/docs/install-config/air-gapped.mdx b/website/docs/install-config/air-gapped.mdx index 1dbb06296e..2c268c96c7 100644 --- a/website/docs/install-config/air-gapped.mdx +++ b/website/docs/install-config/air-gapped.mdx @@ -22,7 +22,7 @@ To disable these outbound connections, adjust the following settings: diff --git a/website/docs/releases/2021/v2021.1.md b/website/docs/releases/2021/v2021.1.md index a15c436c1e..0bab9977d6 100644 --- a/website/docs/releases/2021/v2021.1.md +++ b/website/docs/releases/2021/v2021.1.md @@ -10,7 +10,7 @@ slug: "/releases/2021.1" In previous versions, you had to configure email connection details per [Email Stage](../../add-secure-apps/flows-stages/stages/email/index.mdx). Now, you can (and should) configure global settings. - This is documented under the [docker-compose](../../install-config/install/docker-compose.mdx) and [Kubernetes](../../install-config/install/kubernetes.md) sections. + This is documented under the [Docker Compose](../../install-config/install/docker-compose.mdx) and [Kubernetes](../../install-config/install/kubernetes.md) sections. - New notification system @@ -58,7 +58,7 @@ slug: "/releases/2021.1" This release does not introduce any new requirements. -### docker-compose +### Docker Compose Download the docker-compose file for 2021.1 from [here](https://goauthentik.io/version/2021.1/docker-compose.yml). Afterwards, simply run `docker-compose up -d` and then the standard upgrade command of `docker-compose run --rm server migrate`. diff --git a/website/docs/sys-mgmt/ops/geoip.mdx b/website/docs/sys-mgmt/ops/geoip.mdx index cdd4a5b62f..07a151b680 100644 --- a/website/docs/sys-mgmt/ops/geoip.mdx +++ b/website/docs/sys-mgmt/ops/geoip.mdx @@ -20,7 +20,7 @@ import Tabs from "@theme/Tabs"; @@ -57,7 +57,7 @@ Sign up for a free MaxMind account [here](https://www.maxmind.com/en/geolite2/si diff --git a/website/docs/sys-mgmt/ops/worker.md b/website/docs/sys-mgmt/ops/worker.md index 05560dd101..a4e0f30f2f 100644 --- a/website/docs/sys-mgmt/ops/worker.md +++ b/website/docs/sys-mgmt/ops/worker.md @@ -37,7 +37,7 @@ All tasks have a time limit. If running a task takes longer than than limit, the How many workers are needed will depend on what tasks are expected to run. The number of tasks that can concurrently run is calculated as follows: -- workers replicas (1 for docker-compose, defaults to 1 for the Helm chart but can be configured) _multiplied_ by [`AUTHENTIK_WORKER__PROCESSES`](../../install-config/configuration/configuration.mdx#authentik_worker__processes) _multiplied_ by [`AUTHENTIK_WORKER__THREADS`](../../install-config/configuration/configuration.mdx#authentik_worker__threads) +- workers replicas (1 for Docker Compose, defaults to 1 for the Helm chart but can be configured) _multiplied_ by [`AUTHENTIK_WORKER__PROCESSES`](../../install-config/configuration/configuration.mdx#authentik_worker__processes) _multiplied_ by [`AUTHENTIK_WORKER__THREADS`](../../install-config/configuration/configuration.mdx#authentik_worker__threads) For example, let's say an LDAP source is configured with 1000 users and 200 groups. The LDAP source syncs the users first, then the groups, and finally memberships. All those steps are done by splitting the objects to synchronize into pages, of size [`AUTHENTIK_LDAP__PAGE_SIZE`](../../install-config/configuration/configuration.mdx#authentik_ldap__page_size). Let's say that setting is 50. That means there are `1000 / 50 = 20` pages of users, `200 / 50 = 4` pages of groups. We won't worry about the number of membership pages, because those are usually smaller than the previous ones. diff --git a/website/docs/troubleshooting/emails.md b/website/docs/troubleshooting/emails.md index d686035720..6fa47e69ac 100644 --- a/website/docs/troubleshooting/emails.md +++ b/website/docs/troubleshooting/emails.md @@ -14,7 +14,7 @@ ak test_email [-S ] If you omit the `-S` parameter, the email will be sent using the global settings. Otherwise, the settings of the specified stage will be used. -To run this command with docker-compose, use +To run this command with Docker Compose, use ```shell docker compose exec worker ak test_email [...] diff --git a/website/docs/troubleshooting/forward_auth/general.mdx b/website/docs/troubleshooting/forward_auth/general.mdx index aa22dd1f66..d1d4f854f1 100644 --- a/website/docs/troubleshooting/forward_auth/general.mdx +++ b/website/docs/troubleshooting/forward_auth/general.mdx @@ -19,7 +19,7 @@ Set the authentik log level to `TRACE`: groupId="platform" defaultValue="docker-compose" values={[ - {label: 'docker-compose', value: 'docker-compose'}, + {label: 'Docker Compose', value: 'docker-compose'}, {label: 'Kubernetes', value: 'kubernetes'}, ]}> diff --git a/website/docs/troubleshooting/image_upload.md b/website/docs/troubleshooting/image_upload.md index d57a0bebe9..a4f37a535a 100644 --- a/website/docs/troubleshooting/image_upload.md +++ b/website/docs/troubleshooting/image_upload.md @@ -3,14 +3,14 @@ title: Errors when uploading icons --- :::info -This is specific to the docker-compose installation, if you're running into issues on Kubernetes please open a GitHub issue. +This is specific to the Docker Compose installation, if you're running into issues on Kubernetes please open a GitHub issue. ::: This issue is most likely caused by permissions. Docker creates bound volumes as root, but the authentik processes don't run as root. This will cause issues with icon uploads (for Applications), background uploads (for Flows) and local backups. -To fix these issues, run these commands in the folder of your docker-compose file: +To fix these issues, run these commands in the folder of your Docker Compose file: ```shell sudo chown 1000:1000 media/ diff --git a/website/docs/troubleshooting/logs.mdx b/website/docs/troubleshooting/logs.mdx index 732abdeb29..475fda7c9c 100644 --- a/website/docs/troubleshooting/logs.mdx +++ b/website/docs/troubleshooting/logs.mdx @@ -17,7 +17,7 @@ import Tabs from "@theme/Tabs"; groupId="platform" defaultValue="docker" values={[ - {label: 'docker-compose', value: 'docker'}, + {label: 'Docker Compose', value: 'docker'}, {label: 'Kubernetes', value: 'kubernetes'}, ]}> @@ -57,7 +57,7 @@ To enable `trace` logging, follow the platform-specific steps below: groupId="platform" defaultValue="docker" values={[ - {label: 'docker-compose', value: 'docker'}, + {label: 'Docker Compose', value: 'docker'}, {label: 'Kubernetes', value: 'kubernetes'}, ]}> diff --git a/website/integrations/chat-communication-collaboration/rocketchat/index.md b/website/integrations/chat-communication-collaboration/rocketchat/index.md index 711765d6b4..77a516af8a 100644 --- a/website/integrations/chat-communication-collaboration/rocketchat/index.md +++ b/website/integrations/chat-communication-collaboration/rocketchat/index.md @@ -11,7 +11,7 @@ support_level: community > -- https://github.com/RocketChat/Rocket.Chat :::note -This is based on authentik 2022.3.1 and Rocket.chat 4.5.1 using the [Docker-Compose install](https://docs.rocket.chat/quick-start/installing-and-updating/rapid-deployment-methods/docker-and-docker-compose/docker-containers). Instructions may differ between versions. +This is based on authentik 2022.3.1 and Rocket.chat 4.5.1 using the [Docker Compose install](https://docs.rocket.chat/quick-start/installing-and-updating/rapid-deployment-methods/docker-and-docker-compose/docker-containers). Instructions may differ between versions. ::: ## Preparation diff --git a/website/integrations/chat-communication-collaboration/vikunja/index.md b/website/integrations/chat-communication-collaboration/vikunja/index.md index 0ba6e9d84d..0460f5c07e 100644 --- a/website/integrations/chat-communication-collaboration/vikunja/index.md +++ b/website/integrations/chat-communication-collaboration/vikunja/index.md @@ -11,7 +11,7 @@ support_level: community > -- https://vikunja.io/ :::note -This is based on authentik 2021.7.3 and Vikunja V0.17.1 using the Docker-Compose install https://vikunja.io/docs/full-docker-example/. Instructions may differ between versions. +This is based on authentik 2021.7.3 and Vikunja V0.17.1 using the Docker Compose install https://vikunja.io/docs/full-docker-example/. Instructions may differ between versions. ::: ## Preparation diff --git a/website/integrations/documentation/paperless-ng/index.md b/website/integrations/documentation/paperless-ng/index.md index 255e02e3ed..0f1c373770 100644 --- a/website/integrations/documentation/paperless-ng/index.md +++ b/website/integrations/documentation/paperless-ng/index.md @@ -30,7 +30,7 @@ Also set up your proxy server to use forward auth with paperless.company: https: ## Paperless -Start by adding the following environment variables to your Paperless-ng setup. If you are using docker-compose, then add the following to your docker-compose.env file: +Start by adding the following environment variables to your Paperless-ng setup. If you are using Docker Compose, then add the following to your Compose file: ``` PAPERLESS_ENABLE_HTTP_REMOTE_USER=TRUE diff --git a/website/integrations/infrastructure/powerdns-admin/index.md b/website/integrations/infrastructure/powerdns-admin/index.md index 6ab827a342..831dda17e9 100644 --- a/website/integrations/infrastructure/powerdns-admin/index.md +++ b/website/integrations/infrastructure/powerdns-admin/index.md @@ -61,7 +61,7 @@ SAML_CERT=/saml.crt You must mount the certificate selected in authentik as a file in the Docker container. The path in the container must match the path in the env variable `SAML_CERT`. -### docker-compose +### Docker Compose ```yaml services: