Skip to content

Commit 236dfd7

Browse files
committed
ref(self-hosted): Update docs for GeoIP update and dc up -d
Companion PR for getsentry/self-hosted#3490
1 parent 9bb2715 commit 236dfd7

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

develop-docs/self-hosted/geolocation.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ With this configuration file in place, subsequent runs of Sentry's `install.sh`
2424

2525
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.
2626

27-
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.
27+
If you ever need to manually refresh the IP address geolocation database, you can run the following command:
28+
29+
```bash
30+
./install/geoip.sh
31+
```
2832

2933
## Upgrading
3034

develop-docs/self-hosted/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To put things simply, consider self-hosted as the Business plan without any soft
2525

2626
## Getting Started
2727

28-
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/).
28+
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/).
2929

3030
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/).
3131

@@ -142,7 +142,7 @@ You very likely will want to adjust the default configuration for your Sentry in
142142

143143
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.
144144

145-
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`.
145+
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`.
146146

147147
1. [Geolocation](/self-hosted/geolocation/) uses **a custom configuration file** to conform to the underlying technology.
148148

@@ -183,11 +183,11 @@ Please keep in mind to check the `.env` file for changes, when you perform an up
183183
For all Docker Compose commands, you should specify your `.env.custom`, otherwise the default `.env` file will be used. Some examples are:
184184

185185
```bash
186-
docker compose --env-file .env.custom up -d
186+
docker compose --env-file .env.custom up --wait
187187

188188
# You can also specify the original `.env` file as a fallback if the
189189
# environment variable doesn't exists on the `.env.custom` file.
190-
docker compose --env-file .env --env-file .env.custom up -d
190+
docker compose --env-file .env --env-file .env.custom up --wait
191191
```
192192

193193
### Enhance Sentry image

develop-docs/self-hosted/releases.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ We may have some updated configuration, especially for new features, so always c
3838

3939
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.
4040

41-
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`).
41+
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`).
4242

4343
### Hard Stops
4444

develop-docs/self-hosted/troubleshooting/kafka.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The _nuclear option_ is removing all Kafka-related volumes and recreating them w
7676
```
7777
4. Start the instance:
7878
```shell
79-
docker compose up -d
79+
docker compose up --wait
8080
```
8181
## Reducing disk usage
8282

0 commit comments

Comments
 (0)