feat(sentry10): Make on-premise work for Sentry 10 (#220)
This commit is contained in:
16
README.md
16
README.md
@@ -1,21 +1,23 @@
|
||||
# Sentry On-Premise [![Build Status][build-status-image]][build-status-url]
|
||||
# Sentry 10 On-Premise BETA [![Build Status][build-status-image]][build-status-url]
|
||||
|
||||
Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docker](https://www.docker.com/).
|
||||
|
||||
**NOTE:** If you are not installing Sentry from scratch, visit [On-Premise Stable for Sentry 9.1.2](https://github.com/getsentry/onpremise/tree/stable) as this version is not fully backward compatible.
|
||||
|
||||
## Requirements
|
||||
|
||||
* Docker 17.05.0+
|
||||
* Compose 1.17.0+
|
||||
* Compose 1.19.0+
|
||||
|
||||
## Minimum Hardware Requirements:
|
||||
|
||||
* You need at least 3GB RAM
|
||||
* 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 `docker-compose.yml` file 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.
|
||||
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:
|
||||
|
||||
@@ -23,8 +25,14 @@ The recommended way to customize your configuration is using the files below, in
|
||||
* `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](https://forum.sentry.io/c/on-premise) is at your service!
|
||||
|
||||
## 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.yml`file.
|
||||
|
||||
## Securing Sentry with SSL/TLS
|
||||
|
||||
If you'd like to protect your Sentry install with SSL/TLS, there are
|
||||
|
||||
Reference in New Issue
Block a user