Skip to content

Latest commit

 

History

History
72 lines (60 loc) · 3.91 KB

README.markdown

File metadata and controls

72 lines (60 loc) · 3.91 KB
Raw

If you can read this, you're building Water Cooler. Here are some things you need to know.

Production Site

http://watercooler.io/

How to set up a server

Use Heroku. It'll start the Rails app for you. That's 90% of what you need.

We use postgres for our database in production. If you use SQLite locally, there are occasionally issues with date representation between them. Tread carefully.

Are you sending outbound email from the WC instance?

Then you should do this:

  1. If you're not running on the top-level watercoolr.io domain, set the EMAIL_SUBDOMAIN environment variable. If EMAIL_SUBDOMAIN=kuhltank, your emails will be sent from ******@kuhltank.watercoolr.io
  2. Set the MANDRILL_APIKEY environment variable. You can find our Mandrill API keys by logging in to https://mandrillapp.com/settings/index. If you don't have access to that, ask Sean. Note that some keys are test keys that don't actually deliver mail anywhere. This can be super useful, but if you aren't paying attention, can also make you wonder why the hell Mandrill's API responses all say your mail is being delivered, but you aren't actually sending anything.
  3. For better deliverability, configure the DNS on whatever domain you're using so that this page https://mandrillapp.com/settings/sending-domains doesn't have any errors on it.

Are you getting inbound email to this WC instance?�

Then you should do this:

  1. Add the domain you're receiving email from to this page: https://mandrillapp.com/inbound. Configure the DNS settings until there aren't any errors. Pay attention to DNS propagation times if you think you have everything set up right but Mandrill is still seeing errors.
  2. Make sure you have a server with the /webhooks routes set up that's going to process this mail. Copy it's mandrill route. It'll looks something like http://kuhltank.herokuapp.com/webhooks/v0/email/mandrill .
  3. Add a route to the domain you configured in step 1. Tell it to match * and use the URL from step 2 as the POST To URL. Hit "send test". If it works, you're good.

If you want to test getting inbound email, here's a useful cURL command:

curl -X POST -d "mandrill_events=[{\"event\":\"inbound\",\"msg\":{\"from_email\":\"[email protected]\",\"text\":\"We can probably swing a few things.\n\n\nOn Thu, Nov 14, 2013 at 11:43 AM, Nick Martin <[email protected]> wrote:\n\n> Hey guys,\n>\n> We, uh, may have forgotten to bring any games besides Risk, CAH, and\n> Resistance. If you'd like to play something else I'd be thankful if you\n> could bring it.\n>\n> Nick\n>\",\"email\":\"[email protected]\",\"subject\":\"Test mail\"}}]" http://localhost:3000/webhooks/v0/email/mandrill

How to setup file uploads.

We use S3 to store uploads. You'll basically need to acquire an id and key from the AWS console (ask Nick). Then you need to set two environment variables:

export AWS_ACCESS_KEY_ID=kjsadfhksadhfkh
export AWS_SECRET_ACCESS_KEY=dsfkjhsfkfsdhkjsdfkjhdsafdshjk

You can also set S3_BUCKET_NAME to set the bucket to something specific that you have permissions for, but the defaults are sane for your environment.

Redirection

We redirect users to specific URL's as a part of the rack middleware. Since we have many different possible configurations between dev, kuhltank, and production, we're using a simple string-based scheme. Example:

export WATERCOOLER_SITE_PROTOCOL="http://"
export WATERCOOLER_SITE_URL="localcooler.io"
export WATERCOOLER_SITE_PORT=":3000"

This would result in redirection to http://localcooler.io:3000 whenever a request hits the server. By default, on a development environment, the redirection is to localhost:3000. If you need a different protocol/host/port, you can either set up environment variables in your ~/.bashrc or specify the piece you wish to change when running the server, like WATERCOOLER_SITE_URL=192.168.1.101 rails s.