From 236dfd7c75225ed292e82040746df5602b95e39c Mon Sep 17 00:00:00 2001 From: Burak Yigit Kaya Date: Mon, 23 Dec 2024 15:46:30 +0300 Subject: [PATCH] ref(self-hosted): Update docs for GeoIP update and `dc up -d` Companion PR for getsentry/self-hosted#3490 --- develop-docs/self-hosted/geolocation.mdx | 6 +++++- develop-docs/self-hosted/index.mdx | 8 ++++---- develop-docs/self-hosted/releases.mdx | 2 +- develop-docs/self-hosted/troubleshooting/kafka.mdx | 2 +- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/develop-docs/self-hosted/geolocation.mdx b/develop-docs/self-hosted/geolocation.mdx index 9c7f2aaba6846..ea976c1a5777a 100644 --- a/develop-docs/self-hosted/geolocation.mdx +++ b/develop-docs/self-hosted/geolocation.mdx @@ -24,7 +24,11 @@ With this configuration file in place, subsequent runs of Sentry's `install.sh` 1. For the `web` service: **User Settings > Security > Session History** should display country code and region (for example, "US (CA)") underneath the IP addresses in the table. -It's normal to see the `sentry_self_hosted_geoipupdate_1` container exit soon after startup, since updating the geolocation database is a one-off batch process and not a long-running job. +If you ever need to manually refresh the IP address geolocation database, you can run the following command: + +```bash +./install/geoip.sh +``` ## Upgrading diff --git a/develop-docs/self-hosted/index.mdx b/develop-docs/self-hosted/index.mdx index 52d6ee91017d5..a943abaa9c8e5 100644 --- a/develop-docs/self-hosted/index.mdx +++ b/develop-docs/self-hosted/index.mdx @@ -25,7 +25,7 @@ To put things simply, consider self-hosted as the Business plan without any soft ## Getting Started -Our recommendation is to download the [latest release of the self-hosted repository](https://github.com/getsentry/self-hosted/releases/latest), and then run `./install.sh` inside this directory. This script will take care of all the things you need to get started, including a base-line configuration, and then will tell you to run `docker compose up -d` to start Sentry. Sentry binds to port `9000` by default. You should be able to reach the login page at [http://127.0.0.1:9000](http://127.0.0.1:9000/). +Our recommendation is to download the [latest release of the self-hosted repository](https://github.com/getsentry/self-hosted/releases/latest), and then run `./install.sh` inside this directory. This script will take care of all the things you need to get started, including a base-line configuration, and then will tell you to run `docker compose up --wait` to start Sentry. Sentry binds to port `9000` by default. You should be able to reach the login page at [http://127.0.0.1:9000](http://127.0.0.1:9000/). To have easy maintainability for future upgrades, it is recommended to use Git workflow by cloning the self-hosted repository and check out to a specific CalVer tag. More about this on [Releases & Upgrading](/self-hosted/releases/). @@ -142,7 +142,7 @@ You very likely will want to adjust the default configuration for your Sentry in 1. **`sentry/enhance-image.sh`**—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. After making modifications to `sentry/enhance-image.sh`, run `./install.sh` again to apply them. -1. **Environment variables**—The available keys are defined in [.env](https://github.com/getsentry/self-hosted/blob/master/.env). Use some system-dependent means of setting environment variables if you need to override any of them. To avoid Git changes, simply create a file called `.env.custom` and insert your system-dependent environment variables there. In order to use this, please use `docker compose --env-file /path/to/.env.custom up -d`. +1. **Environment variables**—The available keys are defined in [.env](https://github.com/getsentry/self-hosted/blob/master/.env). Use some system-dependent means of setting environment variables if you need to override any of them. To avoid Git changes, simply create a file called `.env.custom` and insert your system-dependent environment variables there. In order to use this, please use `docker compose --env-file /path/to/.env.custom up --wait`. 1. [Geolocation](/self-hosted/geolocation/) uses **a custom configuration file** to conform to the underlying technology. @@ -183,11 +183,11 @@ Please keep in mind to check the `.env` file for changes, when you perform an up 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 +docker compose --env-file .env.custom up --wait # 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 +docker compose --env-file .env --env-file .env.custom up --wait ``` ### Enhance Sentry image diff --git a/develop-docs/self-hosted/releases.mdx b/develop-docs/self-hosted/releases.mdx index 5c0c05b95265f..e5b20d08e9e7f 100644 --- a/develop-docs/self-hosted/releases.mdx +++ b/develop-docs/self-hosted/releases.mdx @@ -38,7 +38,7 @@ We may have some updated configuration, especially for new features, so always c 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`). +Finally, to upgrade, run `./install.sh`. Upon completion, run `docker compose up --wait` (or if you have `.env.custom` file, run `docker compose --env-file .env --env-file .env.custom up --wait`). ### Hard Stops diff --git a/develop-docs/self-hosted/troubleshooting/kafka.mdx b/develop-docs/self-hosted/troubleshooting/kafka.mdx index 17c8868f4983d..1e5e272aefbf9 100644 --- a/develop-docs/self-hosted/troubleshooting/kafka.mdx +++ b/develop-docs/self-hosted/troubleshooting/kafka.mdx @@ -76,7 +76,7 @@ The _nuclear option_ is removing all Kafka-related volumes and recreating them w ``` 4. Start the instance: ```shell - docker compose up -d + docker compose up --wait ``` ## Reducing disk usage