Adding a docker-compose template for running Mastodon easily

1 files changed, 15 insertions, 1 deletions

diff --git a/README.md b/README.md
index 273d1a1b3..592e150c0 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,12 @@ Mastodon is a federated microblogging engine. An alternative implementation of t
 - Mentions and URLs converted to links in statuses
 - REST API, including home and mention timelines
 - OAuth2 provider system for the API
+- Upload header image for profile page
 
 Missing:
 
 - Media attachments (photos, videos)
 - UI to post, reblog, favourite, follow and unfollow
-- Upload header image for profile page
 - Deleting statuses, deletion propagation
 - Streaming API
 
@@ -34,3 +34,17 @@ Missing:
 
 - PostgreSQL
 - Redis
+
+## Running with Docker and Docker-Compose
+
+The project now includes a Dockerfile and a docker-compose.yml. You need to turn .env.production sample into .env.production with all the variables set before you can:
+
+    docker-compose build
+
+And finally
+
+    docker-compose up
+
+As usual, the first thing you would need to do would be to run migrations:
+
+    docker-compose run web rake db:migrate