Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref(self-hosted): Update docs for GeoIP update and dc up -d #12210

Merged
merged 1 commit into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion develop-docs/self-hosted/geolocation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions develop-docs/self-hosted/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion develop-docs/self-hosted/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion develop-docs/self-hosted/troubleshooting/kafka.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading