about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorJonathan Hurter <john@scalingo.com>2017-04-05 16:00:48 +0200
committerJonathan Hurter <john@scalingo.com>2017-04-05 16:00:48 +0200
commitd6bab0c71cd94bff4f775b79a55493b6e02215a0 (patch)
tree3476b27a3ecc8417659a8fe2db484a76ae93579c /docs
parent5e7ec0fe573f11d9c853981ac0ae57a8b27cf9ce (diff)
Add doc
Diffstat (limited to 'docs')
-rw-r--r--docs/Running-Mastodon/Scalingo-guide.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/Running-Mastodon/Scalingo-guide.md b/docs/Running-Mastodon/Scalingo-guide.md
new file mode 100644
index 000000000..6552056a8
--- /dev/null
+++ b/docs/Running-Mastodon/Scalingo-guide.md
@@ -0,0 +1,13 @@
+Scalingo guide
+==============
+
+[![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy?source=https://github.com/tootsuite/mastodon#master)
+
+1. Click the above button.
+2. Fill in the options requested.
+  * You can use a .scalingo.io domain, which will be simple to set up, or you can use a custom domain.
+  * You will want Amazon S3 for file storage. The only exception is for development purposes, where you may not care if files are not saved. Follow a guide online for creating a free Amazon S3 bucket and Access Key, then enter the details.
+  * If you want your Mastodon to be able to send emails, configure SMTP settings here (or later). Consider using [Mailgun](https://mailgun.com) or similar, who offer free plans that should suit your interests.
+3. Deploy! The app should be set up, with a working web interface and database. You can change settings and manage versions from the Heroku dashboard.
+
+You may need to use the `scalingo` CLI application to run `USERNAME=yourUsername rails mastodon:make_admin` to make yourself an admin.