Skip to content

Commit 177ed0e

Browse files
committed
Indicate more clearly that docker-compose is just a guideline
Fixes #5 #9 #15 #19
1 parent 8186ee2 commit 177ed0e

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docke
99

1010
## Up and Running
1111

12-
Assuming you've just cloned this repository, the following steps
12+
Assuming you've just cloned this repository, the following steps
1313
will get you up and running in no time!
1414

15+
There may need to be modifications to the included `docker-compose.yml` file to accommodate your needs or your environment. These instructions are a guideline for what you should generally do.
16+
1517
1. `mkdir -p data/{sentry,postgres}` - Make our local database and sentry config directories.
1618
This directory is bind-mounted with postgres so you don't lose state!
1719
2. `docker-compose run --rm web config generate-secret-key` - Generate a secret key.
@@ -27,7 +29,7 @@ be fine stopping and removing the containers without worry.
2729
## Securing Sentry with SSL/TLS
2830

2931
If you'd like to protect your Sentry install with SSL/TLS, there are
30-
fantastic SSL/TLS proxies like [HAProxy](http://www.haproxy.org/)
32+
fantastic SSL/TLS proxies like [HAProxy](http://www.haproxy.org/)
3133
and [Nginx](http://nginx.org/).
3234

3335
## Resources

docker-compose.yml

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# NOTE: This docker-compose.yml is meant to be just an example of how
2+
# you could accomplish this on your own. It is not intended to work in
3+
# all use-cases and must be adapted to fit your needs. This is merely
4+
# a guideline.
5+
16
# See docs.getsentry.com/on-premise/server/ for full
27
# instructions
38

0 commit comments

Comments
 (0)