diff --git a/README.md b/README.md index fc09409..5ec7f46 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,80 @@ # dokku-sentry -Sentry on dokku -## Prepare dokku +Deploy [Sentry](https://github.com/getsentry/sentry) 8.x on [dokku](http://dokku.viewdocs.io/dokku/) with official [postgres](https://github.com/dokku/dokku-postgres) and [redis](https://github.com/dokku/dokku-redis) plugins. + +## Install dokku plugins + Go to your dokku server and install following plugins: + +1. Install official **postgresql** plugin ``` -# Install official postgresql plugin sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres - -# Install official redis plugin +``` +2. Install official **redis** plugin +``` sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis ``` -# Setup +## Setup dokku + +1. Create dokku app +``` +ssh dokku@yourserver apps:create sentry ``` -# Create dokku app -ssh dokku@katana apps:create sentry +2. Create postgresql db and link it to the app +``` +ssh dokku@yourserver postgres:create sentry +ssh dokku@yourserver postgres:link sentry sentry +``` +3. Create redis instance and link it to the app +``` +ssh dokku@yourserver redis:create sentry +ssh dokku@yourserver redis:link sentry sentry +``` -# Create postgresql db and link it to the app -ssh dokku@katana postgres:create sentry -ssh dokku@katana postgres:link sentry sentry +4. Add remote dokku +``` +git remote add dokku dokku@yourserver:sentry +``` -# Create redis instance and link it to the app -ssh dokku@katana redis:create sentry -ssh dokku@katana redis:link sentry sentry +5. Deploy app +``` +git push dokku -# Add remote dokku -git remote add dokku dokku@katana:sentry +``` -# Deply -git push dokku +## Setup sentry + +After you have sucessfully deployed app to dokku, run following commands to finish installing sentry: + +1. Create database schema. + +In the end you will be prompted to create initial user. + +``` +ssh -t dokku@yourserver run sentry "sentry --config=sentry.conf.py upgrade" +``` + +2. Create user (Optional). Use this step if you skipped it in the previous command. +``` +ssh -t dokku@yourserver run sentry "sentry --config=sentry.conf.py createuser" + +``` + +VOILĂ€! Open your dokku app url, login and enjoy Sentry! + +## Debug + +If something goes wrong you can use dokku logs: + +``` +ssh dokku@yourserver logs sentry ``` \ No newline at end of file