kmlabz/sentry-onpremise
kmlabz/sentry-onpremise
Archived
2
0
Fork 0
Code Pull Requests Releases Activity

docs(readme): Update readme for the install script (#209)

Browse Source 
Follow up to #207.
This commit is contained in:
Burak Yigit Kaya 2019-07-02 23:58:49 +03:00 committed by GitHub
parent 8b5b724d1e
commit 792e2cc961
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -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/). Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docker](https://www.docker.com/).
## Requirements ## Requirements
* Docker 1.10.0+ * Docker 1.10.0+
* Compose 1.17.0+ _(optional)_ * Compose 1.17.0+
## Minimum Hardware Requirements: ## Minimum Hardware Requirements:
* You need at least 3GB Ram * You need at least 3GB RAM
## Up and Running ## Setup
Assuming you've just cloned this repository, the following steps To get started with all the defaults, simply clone the repo and run `./install.sh` in your local check-out.
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. 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.
1. `docker volume create --name=sentry-data && docker volume create --name=sentry-postgres` - Make our local database and sentry volumes The recommended way to customize your configuration is using the files below, in that order:
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 * `config.yml`
3. `docker-compose build` - Build and tag the Docker services * `sentry.conf.py`
4. `docker-compose run --rm web config generate-secret-key` - Generate a secret key. * `.env` w/ environment variables
Add it to `.env` as `SENTRY_SECRET_KEY`.
5. `docker-compose run --rm web upgrade` - Build the database. If you have any issues or questions, our [Community Forum](https://forum.sentry.io/c/on-premise) is at your service!
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`!
## Securing Sentry with SSL/TLS ## Securing Sentry with SSL/TLS
If you'd like to protect your Sentry install with SSL/TLS, there are 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/). and [Nginx](http://nginx.org/). You'll likely to add this service to your `docker-compose.yml` file.
## Updating Sentry ## Updating Sentry
@ -49,6 +45,10 @@ docker-compose up -d # Recreate the services
## Resources ## Resources
* [Documentation](https://docs.sentry.io/server/installation/docker/) * [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) * [Forums](https://forum.sentry.io/c/on-premise)
* [IRC](irc://chat.freenode.net/sentry) (chat.freenode.net, #sentry) * [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