gearheads
/
mastodon
Archived
2
0
Fork 0
Code Releases 4 Activity

Updated README with link to production guide

gh/stable
Eugen Rochko 2016-12-02 14:21:19 +01:00
parent 58b3f4fd67
commit e3222feddb
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -58,6 +58,8 @@ Consult the example configuration file, `.env.production.sample` for the full li
## Requirements ## Requirements
- Ruby
- Node.js
- PostgreSQL - PostgreSQL
- Redis - Redis
- Nginx - 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. **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 ### 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 - `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. 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. 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 **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 [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) - The error page image courtesy of [Dopatwo](https://www.youtube.com/user/dopatwo)