From 792e2cc961a488048447658c5278f26890407721 Mon Sep 17 00:00:00 2001 From: Burak Yigit Kaya Date: Tue, 2 Jul 2019 23:58:49 +0300 Subject: [PATCH] docs(readme): Update readme for the install script (#209) Follow up to #207. --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2518298..71d6f2c 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,35 @@ -# Sentry On-Premise +# Sentry On-Premise [![Build Status][build-status-image]][build-status-url] Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docker](https://www.docker.com/). ## Requirements * Docker 1.10.0+ - * Compose 1.17.0+ _(optional)_ - - ## Minimum Hardware Requirements: - - * You need at least 3GB Ram + * Compose 1.17.0+ -## Up and Running +## Minimum Hardware Requirements: -Assuming you've just cloned this repository, the following steps -will get you up and running in no time! + * You need at least 3GB RAM -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. +## Setup -1. `docker volume create --name=sentry-data && docker volume create --name=sentry-postgres` - Make our local database and sentry volumes - Docker volumes have to be created manually, as they are declared as external to be more durable. -2. `cp -n .env.example .env` - create env config file -3. `docker-compose build` - Build and tag the Docker services -4. `docker-compose run --rm web config generate-secret-key` - Generate a secret key. - Add it to `.env` as `SENTRY_SECRET_KEY`. -5. `docker-compose run --rm web upgrade` - Build the database. - Use the interactive prompts to create a user account. -6. `docker-compose up -d` - Lift all services (detached/background mode). -7. Access your instance at `localhost:9000`! +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. + +The recommended way to customize your configuration is using the files below, in that order: + + * `config.yml` + * `sentry.conf.py` + * `.env` w/ environment variables + +If you have any issues or questions, our [Community Forum](https://forum.sentry.io/c/on-premise) is at your service! ## 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/) -and [Nginx](http://nginx.org/). +and [Nginx](http://nginx.org/). You'll likely to add this service to your `docker-compose.yml` file. ## Updating Sentry @@ -49,6 +45,10 @@ docker-compose up -d # Recreate the services ## Resources * [Documentation](https://docs.sentry.io/server/installation/docker/) - * [Bug Tracker](https://github.com/getsentry/onpremise) + * [Bug Tracker](https://github.com/getsentry/onpremise/issues) * [Forums](https://forum.sentry.io/c/on-premise) * [IRC](irc://chat.freenode.net/sentry) (chat.freenode.net, #sentry) + + +[build-status-image]: https://api.travis-ci.com/getsentry/onpremise.svg?branch=master +[build-status-url]: https://travis-ci.com/getsentry/onpremise \ No newline at end of file