website/docs: website/integrations: update docker-compose to Docker Compose (#16945)

Updates instances of docker-compose to Docker Compose
2026-06-17 19:09:11 +03:00 · 2025-09-24 17:20:19 +03:00
parent 0496549386
commit 30fc1b93bf
15 changed files with 20 additions and 20 deletions
@@ -48,11 +48,11 @@ import Tabs from "@theme/Tabs";
 <Tabs
  defaultValue="docker-compose"
  values={[
-    {label: 'docker-compose', value: 'docker-compose'},
+    {label: 'Docker Compose', value: 'docker-compose'},
    {label: 'Kubernetes', value: 'kubernetes'},
  ]}>
  <TabItem value="docker-compose">
-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.

  </TabItem>
  <TabItem value="kubernetes">
@@ -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'},
  ]}>
  <TabItem value="standalone-traefik">
@@ -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.
@@ -22,7 +22,7 @@ To disable these outbound connections, adjust the following settings:
 <Tabs
  defaultValue="docker-compose"
  values={[
-    {label: 'docker-compose', value: 'docker-compose'},
+    {label: 'Docker Compose', value: 'docker-compose'},
    {label: 'Kubernetes', value: 'kubernetes'},
  ]}>
  <TabItem value="docker-compose">
@@ -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`.

@@ -20,7 +20,7 @@ import Tabs from "@theme/Tabs";
 <Tabs
  defaultValue="docker-compose"
  values={[
-    {label: 'docker-compose', value: 'docker-compose'},
+    {label: 'Docker Compose', value: 'docker-compose'},
    {label: 'Kubernetes', value: 'kubernetes'},
  ]}>
  <TabItem value="docker-compose">
@@ -57,7 +57,7 @@ Sign up for a free MaxMind account [here](https://www.maxmind.com/en/geolite2/si
 <Tabs
  defaultValue="docker-compose"
  values={[
-    {label: 'docker-compose', value: 'docker-compose'},
+    {label: 'Docker Compose', value: 'docker-compose'},
    {label: 'Kubernetes', value: 'kubernetes'},
  ]}>
  <TabItem value="docker-compose">
@@ -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.

@@ -14,7 +14,7 @@ ak test_email <to address> [-S <stage name>]

 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 [...]
@@ -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'},
  ]}>
  <TabItem value="docker-compose">
@@ -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/
@@ -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'},
  ]}>
  <TabItem value="docker">
@@ -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'},
  ]}>
  <TabItem value="docker">
@@ -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
@@ -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
@@ -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
@@ -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: