Enhanced README with Instructions!

[InAnimaTe]

This is a PR adding instructions around utilizing the contents of this repository to lift a fully working Sentry install on Docker. It fills some gaps that the current docker related docs don't cover.

This is a bit more informative than #5 and covers some of the concerns in #2

[mattrobenolt]

I don't know if I like this super opinionated approach to the database backups and how to run a TLS proxy.

Neither of those things are projects we'd want to officially endorse in order to run Sentry.

[mattrobenolt]

I guess I'd say, this feels more like an exercise for a blog post, rather than, "How to run Sentry." Since neither of those are core components and there are many opinions on how to do those things correctly, neither of which I'd feel comfortable putting an official stamp on, since that means we're endorsing and condoning.

Not necessarily that I think they're bad. I just don't agree this is the place for that.

[InAnimaTe]

I do see what you mean. Just fyi, I'm not trying to push one thing or another, I just want to help people get ideas flowing for how they can better utilize other projects to enhance their Sentry installs based on the DevOp toolsets of modern application delivery.

Here's a couple ideas on how to change those around:

We can either do something like (a short message prior to those sections):

The following are just examples of projects which can be used to enhance your local installation of Sentry. There are a variety of options and you are encouraged to find the correct one for you ;)

Or I can just drop those sections down to something much more simplified (instead of the recommendation of a certain project and conf. details), we would have:

• If you are interested in running Sentry in a SSL/TLS configuration, there are fantastic proxy tools like HAProxy, Nginx, and Caddy.

I don't mind either way ;)

[mattrobenolt]

Just fyi, I'm not trying to push one thing or another, I just want to help people get ideas flowing for how they can better utilize other projects to enhance their Sentry installs based on the DevOp toolsets of modern application delivery.

Yeah, I understand. :) I would love to have more opinionated documentation out there, but as it is, this should be the core. However others want to scale out or "productionize" their installs is up to them. To me, this falls under the same as us suggesting say, "Run this on Carina." Sure, that works, but it will also work other ways.

Or I can just drop those sections down to something much more simplified (instead of the recommendation of a certain project and conf. details), we would have:

If you are interested in running Sentry in a SSL/TLS configuration, there are fantastic proxy tools like HAProxy, Nginx, and Caddy.

I'm ok with a light recommendation around TLS, just because I feel that's important. I also have no idea what Caddy is, so I'd never mention that in our docs. HAProxy and nginx are both fine.

And definitely remove the database backup thing, because that's just normal infrastructure common sense. You want to backup your database, so figure it out. There's plenty of documentation on it and many different ways to accomplish it. It's also very likely that they're not running Postgres inside of a container as well.

[InAnimaTe]

^^ ;)

[JeanFred]

Shouldn’t we use --rm to avoid leaving containers lying?

[InAnimaTe]

Ahh yes! Just committed the addition. Thanks for pointing that out!

[JeanFred]

I’m also running a production instance of Sentry, using roughly the same steps as this PR suggests.

In case this helps, here is mine (orchestrated using Ansible)

    - name: Build the Docker image
      command: docker-compose build

    - name: Run database migrations
      command: docker-compose run --rm web upgrade --noinput

    - name: Run missing Hipchat migrations
      command: docker-compose run --rm web django migrate sentry_hipchat_ac

    - name: Docker-compose up
      command: docker-compose up -d

[mattrobenolt]

Link to nginx.org plz. nginx.com is the commercial entity, and nginx.org is the open source.

[InAnimaTe]

Done

[InAnimaTe]

Fixed!

[InAnimaTe]

As you can tell, I'm completely noob to this new fancy review system Github has.

[InAnimaTe]

So I've made the requested changes and this has been sitting for over a week here. Is there anything else I'm supposed to do?

[mattrobenolt]

Sorry about that, we have a lot of repositories. 😛