Skip to content

Commit 198b275

Browse files
authored
docs: Fold README into self-hosted docs (#993)
Closes #983 and closes #790. Refs getsentry/develop#355.
1 parent 1fae775 commit 198b275

File tree

1 file changed

+15
-43
lines changed

1 file changed

+15
-43
lines changed

README.md

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,27 @@ Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docke
44

55
## Requirements
66

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
1212

1313
## Setup
1414

1515
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.
1616

1717
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`.
1818

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.
2020

21-
The recommended way to customize your configuration is using the files below, in that order:
21+
## Tips & Tricks
2222

23-
* `config.yml`
24-
* `sentry.conf.py`
25-
* `.env` w/ environment variables
23+
### Event Retention
2624

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.
3026

31-
## Versioning
27+
### Installing a specific SHA
3228

3329
If you want to install a specific release of Sentry, use the tags/releases on this repo.
3430

@@ -43,49 +39,25 @@ Note that this may not work for all commit SHAs as this repository evolves with
4339
### Using Linux
4440

4541
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+
4643
```shell
4744
sudo visudo
4845
```
46+
4947
Then add the following line:
48+
5049
```shell
5150
Defaults env_keep += "SENTRY_IMAGE"
5251
```
52+
5353
Save the file then in your terminal run the following
5454

5555
```shell
5656
export SENTRY_IMAGE=us.gcr.io/sentryio/sentry:83b1380
5757
sudo ./install.sh
5858
```
59-
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).
82-
83-
## Resources
84-
85-
* [Documentation](https://develop.sentry.dev/self-hosted/)
86-
* [Bug Tracker](https://github.com/getsentry/onpremise/issues)
87-
* [Community Forums](https://forum.sentry.io/c/on-premise)
8859

60+
Where you replace `83b1380` with the sha you want to use.
8961

9062
[build-status-image]: https://github.com/getsentry/onpremise/workflows/test/badge.svg
9163
[build-status-url]: https://git.io/JUYkh

0 commit comments

Comments
 (0)