kmlabz/sentry-onpremise
kmlabz/sentry-onpremise
Archived
2
0
Fork 0
Code Pull Requests Releases Activity
Clean and backupable on-premise deployment of Sentry using Docker COmpose
This repository has been archived on 2020-07-19. You can view files and clone it, but cannot push or open issues or pull requests.
131 Commits 1 Branch 0 Tags 305 KiB
Shell 56.4%
Python 34.7%
Nginx 7%
Dockerfile 1.9%
6979959a71
Go to file
Burak Yigit Kaya 6979959a71
fix(postgres): Fix postgres suddenly failing after their 'patch' release 
See
https://github.com/docker-library/postgres/pull/658#pullrequestreview-336007842
2020-02-15 01:39:55 +03:00
cron feat(sentry10): Make on-premise work for Sentry 10 (#220) 2019-11-12 02:18:59 +03:00
sentry fix(config): Enable http-chunked-input for UWSGI (#376) 2020-02-03 19:15:40 +03:00
.env ref(env): Set docker-compose project name (#305) 2019-12-26 08:26:28 +03:00
.gitignore feat(install): Add automatic logs to install script (#312) 2020-01-03 13:17:35 +03:00
.travis.yml feat(sentry10): Make on-premise work for Sentry 10 (#220) 2019-11-12 02:18:59 +03:00
docker-compose.yml fix(postgres): Fix postgres suddenly failing after their 'patch' release 2020-02-15 01:39:55 +03:00
install.sh fix(install): Update exit status and fix premature exit (#375) 2020-02-03 21:01:12 +03:00
LICENSE license: Update BSL change date 2020-02-03 18:39:08 +00:00
README.md docs(upgrade): Add note regarding min Sentry 9.1.2 requirement (#380) 2020-02-05 23:59:15 +03:00
test.sh feat(sentry10): Make on-premise work for Sentry 10 (#220) 2019-11-12 02:18:59 +03:00

README.md

Sentry 10 On-Premise Build Status

Official bootstrap for running your own Sentry with Docker.

Requirements

  • Docker 17.05.0+
  • Compose 1.19.0+

Minimum Hardware Requirements:

  • You need at least 2400MB RAM

Setup

To get started with all the defaults, simply clone the repo and run ./install.sh in your local check-out.

There may need to be modifications to the included example config files (sentry/config.example.yml and sentry/sentry.conf.example.py) to accommodate your needs or your environment (such as adding GitHub credentials). If you want to perform these, do them before you run the install script and copy them without the .example extensions in the name (such as sentry/sentry.conf.py) before running the install.sh script.

The recommended way to customize your configuration is using the files below, in that order:

  • config.yml
  • sentry.conf.py
  • .env w/ environment variables

We currently support a very minimal set of environment variables to promote other means of configuration.

If you have any issues or questions, our Community Forum is at your service! Everytime you run the install script, it will generate a log file, sentry_install_log-<ISO_TIMESTAMP>.txt with the output. Sharing these logs would help people diagnose any issues you might be having.

Event Retention

Sentry comes with a cleanup cron job that prunes events older than 90 days by default. If you want to change that, you can change the SENTRY_EVENT_RETENTION_DAYS environment variable in .env or simply override it in your environment. If you do not want the cleanup cron, you can remove the sentry-cleanup service from the docker-compose.ymlfile.

Securing Sentry with SSL/TLS

If you'd like to protect your Sentry install with SSL/TLS, there are fantastic SSL/TLS proxies like HAProxy and Nginx. You'll likely want to add this service to your docker-compose.yml file.

Updating Sentry

You need to be on at least Sentry 9.1.2 to be able to upgrade automatically to the latest version. If you are not, upgrade to 9.1.2 first by checking out the 9.1.2 tag on this repo.

The included install.sh script is meant to be idempotent and to bring you to the latest version. What this means is you can and should run install.sh to upgrade to the latest version available. Remember that the output of the script will be stored in a log file, sentry_install_log-<ISO_TIMESTAMP>.txt, which you may share for diagnosis if anything goes wrong.

Resources