diff --git a/develop-docs/self-hosted/index.mdx b/develop-docs/self-hosted/index.mdx index ce425c4ad6b15..0789365bcf52f 100644 --- a/develop-docs/self-hosted/index.mdx +++ b/develop-docs/self-hosted/index.mdx @@ -178,6 +178,16 @@ By default, there exists no `.env.custom` file. In this case, you can manually a Please keep in mind to check the `.env` file for changes, when you perform an upgrade of Sentry, so that you can adjust your `.env.custom` accordingly, if required, as `.env` is ignored entirely if `.env.custom` is present. +For all Docker Compose commands, you should specify your `.env.custom`, otherwise the default `.env` file will be used. Some examples are: + +```bash +docker compose --env-file .env.custom up -d + +# You can also specify the original `.env` file as a fallback if the +# environment variable doesn't exists on the `.env.custom` file. +docker compose --env-file .env --env-file .env.custom up -d +``` + ### Enhance Sentry image To install plugins and their dependencies or make other modifications to the Sentry base image, copy `sentry/enhance-image.example.sh` to `sentry/enhance-image.sh` and add necessary steps there. For example, you can use `apt-get` to install dependencies and use `pip` to install plugins. diff --git a/develop-docs/self-hosted/releases.mdx b/develop-docs/self-hosted/releases.mdx index 3bf93c03adee9..dc0b3366dbb91 100644 --- a/develop-docs/self-hosted/releases.mdx +++ b/develop-docs/self-hosted/releases.mdx @@ -36,8 +36,9 @@ git checkout 23.11.0 We may have some updated configuration, especially for new features, so always check the example config files under the sentry directory and see if you need to update your existing configuration. We do our best to automate critical configuration updates, but you should always check your configs during upgrades. -Finally, to upgrade, just run `./install.sh`. +If you have a `.env.custom` file, make sure to copy new environment variables from the `.env` file into the `.env.custom` file before running the install script. +Finally, to upgrade, run `./install.sh`. Upon completion, run `docker compose up -d` (or if you have `.env.custom` file, run `docker compose --env-file .env --env-file .env.custom up -d`). ### Hard Stops