diff options
| author | Eugen Rochko <eugen@zeonfederated.com> | 2016-12-02 14:21:19 +0100 |
|---|---|---|
| committer | Eugen Rochko <eugen@zeonfederated.com> | 2016-12-02 14:21:19 +0100 |
| commit | e3222feddb8335af5d1c9ac8b46730a2ca6d6502 (patch) | |
| tree | 74cac16b8820d086e101ac36cf6fb7a5abf8050a | |
| parent | 58b3f4fd674d29c444b236ad3936dbd04c6e175e (diff) | |
Updated README with link to production guide
| -rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md index 59741e0c9..0eb9bbe3e 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ Consult the example configuration file, `.env.production.sample` for the full li ## Requirements +- Ruby +- Node.js - PostgreSQL - Redis - Nginx @@ -84,10 +86,6 @@ The container has two volumes, for the assets and for user uploads. The default **Note**: The `--rm` option for docker-compose will remove the container that is created to run a one-off command after it completes. As data is stored in volumes it is not affected by that container clean-up. -### Static files and production - -You will also need to set up a static file server when running in production. See the [production guide](https://github.com/Gargron/mastodon/wiki/Production-guide) for a sample Nginx configuration and instructions. - ### Tasks - `rake mastodon:media:clear` removes uploads that have not been attached to any status after a while, you would want to run this from a periodic cronjob @@ -116,13 +114,17 @@ And finally, Which will re-create the updated containers, leaving databases and data as is. Depending on what files have been updated, you might need to re-run migrations and asset compilation. -### Contributing +## Deployment without Docker + +Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the [production guide](https://github.com/Gargron/mastodon/wiki/Production-guide) for examples, configuration and instructions. + +## Contributing You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. This section may be updated with more details in the future. **IRC channel**: #mastodon on irc.freenode.net -### Extra credits +## Extra credits - The [Emoji One](https://github.com/Ranks/emojione) pack has been used for the emojis - The error page image courtesy of [Dopatwo](https://www.youtube.com/user/dopatwo) |