From 177ed0efa8df77a7e76ba557708127eddfd0d8ef Mon Sep 17 00:00:00 2001 From: Matt Robenolt Date: Thu, 10 Nov 2016 20:15:24 -0800 Subject: [PATCH] Indicate more clearly that docker-compose is just a guideline Fixes #5 #9 #15 #19 --- README.md | 6 ++++-- docker-compose.yml | 5 +++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 844ac8f..c86fc43 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,11 @@ Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docke ## Up and Running -Assuming you've just cloned this repository, the following steps +Assuming you've just cloned this repository, the following steps will get you up and running in no time! +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. + 1. `mkdir -p data/{sentry,postgres}` - Make our local database and sentry config directories. This directory is bind-mounted with postgres so you don't lose state! 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. ## 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](http://www.haproxy.org/) +fantastic SSL/TLS proxies like [HAProxy](http://www.haproxy.org/) and [Nginx](http://nginx.org/). ## Resources diff --git a/docker-compose.yml b/docker-compose.yml index 0c6ddb9..ba5d198 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,3 +1,8 @@ +# NOTE: This docker-compose.yml is meant to be just an example of how +# you could accomplish this on your own. It is not intended to work in +# all use-cases and must be adapted to fit your needs. This is merely +# a guideline. + # See docs.getsentry.com/on-premise/server/ for full # instructions