Installation

Sentry relies on multiple services to work, which are all orchestrated by Docker Compose in our on-premise repository.

Requirements

  • Docker 17.05.0+
  • Docker Compose 1.19.0+
  • A dedicated (sub)domain to host Sentry on (for example, sentry.yourcompany.com).
  • At least 2400MB memory
  • 2 CPU Cores

Installing Sentry Server

We strongly recommend using Docker, and specifically, our on-premise repository for installing Sentry and all its services. If you need to do something custom, you can use this repository as the basis of your setup. If you do not wish to use the Docker images we provide, you can still find Sentry on PyPI. However, we don’t recommend that method. You’ll need to work your way back from the main Sentry image and the service composition. It is not too hard, but you are likely to spend a lot more time and hit some bumps.

To install Sentry from the on-premise repository, clone the repository locally:

git clone https://github.com/getsentry/onpremise.git

Before starting the installation, we strongly recommend you to check out how to configure your Sentry instance as you’d need to rebuild your images (docker-compose build) if you ever want to change your configuration settings. You may copy and edit the example configs provided in the repository. If none exists, the install script will use these examples as the actual configurations.

To start, run the install script:

./install.sh

If the CI environment variable is set to a non-empty value, the script will assume unattended installation and will skip some steps. You can look at its source code to figure out what those steps are, which will also be logged to standard output.

If you are upgrading from an earlier version of the on-premise repository, keep in mind that it will keep your existing configuration files, which you may need to adjust based on the examples provided in the repository.

If you have any issues or questions, our community forums and Discord #sentry-server channel are always open!