You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-43Lines changed: 15 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,31 +4,27 @@ Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docke
4
4
5
5
## Requirements
6
6
7
-
* Docker 19.03.6+
8
-
* Compose 1.24.1+
9
-
* 4 CPU Cores
10
-
* 8 GB RAM
11
-
* 20 GB Free Disk Space
7
+
* Docker 19.03.6+
8
+
* Compose 1.24.1+
9
+
* 4 CPU Cores
10
+
* 8 GB RAM
11
+
* 20 GB Free Disk Space
12
12
13
13
## Setup
14
14
15
15
To get started with all the defaults, simply clone the repo and run `./install.sh` in your local check-out. Sentry uses Python 3 by default since December 4th, 2020 and Sentry 21.1.0 is the last version to support Python 2.
16
16
17
17
During the install, a prompt will ask if you want to create a user account. If you require that the install not be blocked by the prompt, run `./install.sh --no-user-prompt`.
18
18
19
-
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.
19
+
Please visit [our documentation](https://develop.sentry.dev/self-hosted/) for everything else.
20
20
21
-
The recommended way to customize your configuration is using the files below, in that order:
21
+
## Tips & Tricks
22
22
23
-
*`config.yml`
24
-
*`sentry.conf.py`
25
-
*`.env` w/ environment variables
23
+
### Event Retention
26
24
27
-
We currently support a very minimal set of environment variables to promote other means of configuration.
28
-
29
-
If you have any issues or questions, our [Community Forum](https://forum.sentry.io/c/on-premise) 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.
25
+
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.
30
26
31
-
##Versioning
27
+
### Installing a specific SHA
32
28
33
29
If you want to install a specific release of Sentry, use the tags/releases on this repo.
34
30
@@ -43,49 +39,25 @@ Note that this may not work for all commit SHAs as this repository evolves with
43
39
### Using Linux
44
40
45
41
If you are using Linux and you need to use `sudo` when running `./install.sh`, modifying the version of Sentry is slightly different. First, run the following:
42
+
46
43
```shell
47
44
sudo visudo
48
45
```
46
+
49
47
Then add the following line:
48
+
50
49
```shell
51
50
Defaults env_keep += "SENTRY_IMAGE"
52
51
```
52
+
53
53
Save the file then in your terminal run the following
Where you replace `83b1380` with the sha you want to use.
60
-
61
-
## Event Retention
62
-
63
-
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.
64
-
65
-
## Securing Sentry with SSL/TLS
66
-
67
-
If you'd like to protect your Sentry install with SSL/TLS, there are
68
-
fantastic SSL/TLS proxies like [HAProxy](http://www.haproxy.org/)
69
-
and [Nginx](http://nginx.org/). Our recommendation is running an external Nginx instance or your choice of load balancer that does the TLS termination and more. Read more over at our [productionalizing self-hosted docs](https://develop.sentry.dev/self-hosted/#productionalizing).
70
-
71
-
## Updating Sentry
72
-
73
-
_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](https://github.com/getsentry/onpremise/tree/9.1.2) on this repo._
74
-
75
-
We recommend (and sometimes require) you to upgrade Sentry one version at a time. That means if you are running 20.6.0, instead of going directly to 20.8.0, first go through 20.7.0. Skipping versions would work most of the time, but there will be times that we require you to stop at specific versions to ensure essential data migrations along the way.
76
-
77
-
Pull the version of the repository that you wish to upgrade to by checking out the tagged release of this repo. Make sure to check for any difference between the example config files and your current config files in use. There might be new configuration that has to be added to your adjusted files such as feature flags or server configuration.
78
-
79
-
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.
80
-
81
-
For more information regarding updating your Sentry installation, please visit [our documentation](https://develop.sentry.dev/self-hosted/#upgrading).
0 commit comments