Mirror of cybrespace/mastodon@cybre.tech
Go to file
Daniel Hunsaker 256e3adc1d Add Support for Nanobox (#1709)
* Nanobox Support

- Added support for running Mastodon using Nanobox, both for local development, and for deployment to production
- Dev mode tested and is working properly
- Deployment is undergoing test as of this writing. If it works, this line will be amended to state success; if not, one or more subsequent commits will provide fixes.

* [nanobox] Resolve Deploy Issues

Everything seems to work except routing to the streaming API. Will investigate with the Nanobox staff and make fix commits if needed.

Changes made:
- Also need `NODE_ENV` in production
- Node runs on `:4000`
- Use `envsubst` to commit `.env.production` values, since `dotEnv` packages don't always support referencing other variables
- Can't precompile assets after `transform` hook, but do this locally so it only has to be done once.
- Rails won't create `production.log` on its own, so we do this ourselves.
- Some `start` commands run from `/data/` for some reason, so use absolute paths in command arguments

* [nanobox] Update Ruby version

* [nanobox] Fix db.rake Ruby code style issues

* [nanobox] Minor Fixes

Some minor adjustments to improve functionality:

- Fixed routing to `web.stream` instances
- Adjust `.env.nanobox` to properly generate a default `SMTP_FROM_ADDRESS` via `envsubst`
- Update Nginx configs to properly support the needed HTTP version and headers for proper functionality (the streaming API doesn't work without some of these settings in place)

* [nanobox] Move usage info to docs repo

* [nanobox] Updates for 1.2.x

- Need to leave out `pkg-config` since Nanobox deploys without Ruby's headers - create a gem group to exclude the gem during Nanobox installs, but allow it to remain part of the default set otherwise
- Update cron jobs to cover new/updated Rake tasks
- Update `.env.nanobox` to include latest defaults and additions

* [nanobox] Fix for nokogumbo, added in 1.3.x

Apparently, nokogumbo (pulled in by sanitize, added with `OEmbed Support for PreviewCard` (#2337) - 88725d6) tries to install before nokogiri, despite needing nokogiri available to build properly. Instruct it to use the same settings as nokogiri does when building nokogiri directly, instead of via bundler.

* [nanobox] Set NODE_ENV during asset compile

The switch to WebPack will rely on the local value of the NODE_ENV evar, so set it to production during asset compilation.

* [nanobox] Rebase on master; update Nginx configs

- `pkg-config` Gem no longer causes issues in Nanobox, so revert the Gemfile change which allowed excluding it
- Update Nginx configuration files with latest recommendations from production documentation
- Rebase on master to Get This Merged™

Everything should be golden!
2017-05-23 16:54:44 +02:00
app Cover StreamEntriesController more and remove redundant instructions (#3257) 2017-05-23 15:04:23 +02:00
bin Replace sprockets/browserify with Webpack (#2617) 2017-05-03 02:04:16 +02:00
config i18n: Latest Hebew strings translated (#3250) 2017-05-23 13:08:16 +02:00
db Filter languages with opt out (#3175) 2017-05-20 17:32:44 +02:00
docs Fix redirect link on Tuning.md (#1595) 2017-04-12 12:40:37 +02:00
lib Add Support for Nanobox (#1709) 2017-05-23 16:54:44 +02:00
log Initial commit 2016-02-20 22:53:20 +01:00
nanobox Add Support for Nanobox (#1709) 2017-05-23 16:54:44 +02:00
public Add boop sounds in Vorbis format (#2963) 2017-05-10 16:58:54 +02:00
spec Cover StatusesController more (#3259) 2017-05-23 16:34:28 +02:00
storybook Improve eslint rules (#3147) 2017-05-20 17:31:47 +02:00
streaming Use local default for postgres host in node streaming service (#3240) 2017-05-22 20:27:24 -04:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.babelrc feat(babel): Strip prop types (#3122) 2017-05-19 02:42:21 +02:00
.buildpacks Add heroku APT buildpack for scalingo. (#3051) 2017-05-14 12:57:13 +02:00
.codeclimate.yml Enable CodeClimate SCSS Lint checks (#2886) 2017-05-07 20:47:31 +02:00
.dockerignore Add postgres/redis folder to .dockerignore (#2659) 2017-04-30 18:15:27 +02:00
.editorconfig Add final newline to locale files (#2890) 2017-05-07 19:55:47 +02:00
.env.nanobox Add Support for Nanobox (#1709) 2017-05-23 16:54:44 +02:00
.env.production.sample Allow alternate domains for mastodon handlers (#3187) 2017-05-22 15:40:04 +02:00
.env.test Add recovery code support for two-factor auth (#1773) 2017-04-15 13:26:03 +02:00
.env.vagrant Add a default LOCAL_DOMAIN=mastodon.dev to .env.vagrant 2017-01-26 19:22:59 +11:00
.eslintignore Dev Tooling fixes (eslint/editorconfig) (#1398) 2017-04-11 00:36:03 +02:00
.eslintrc.yml Improve eslint rules (#3147) 2017-05-20 17:31:47 +02:00
.foreman Replace sprockets/browserify with Webpack (#2617) 2017-05-03 02:04:16 +02:00
.gitignore Update .gitignore (#3197) 2017-05-21 11:24:59 +02:00
.haml-lint.yml Added haml-lint and fix warnings (#2773) 2017-05-08 03:35:25 +02:00
.nanoignore Add Support for Nanobox (#1709) 2017-05-23 16:54:44 +02:00
.nvmrc update Node to 6.x LTS (#1228) 2017-04-15 02:05:41 +02:00
.postcssrc.yml Add browserslist config for autoprefixer (#3053) 2017-05-14 12:57:54 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Fix Rubocop offences (#2630) 2017-05-01 16:31:02 +02:00
.ruby-version Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
.scss-lint.yml Enable CodeClimate SCSS Lint checks (#2886) 2017-05-07 20:47:31 +02:00
.slugignore Updates slugignore. 2017-04-06 07:53:48 -04:00
.travis.yml Enable caching dependencies in Travis CI (#3132) 2017-05-19 11:44:00 +02:00
Aptfile Use cid3 on Heroku (#3001) 2017-05-12 14:33:54 +02:00
CONTRIBUTING.md README tidy up (#2026) 2017-04-17 21:28:31 +02:00
Capfile remove capistrano/faster_assets from Capfile (#2737) 2017-05-03 12:14:52 +02:00
Dockerfile Some Dockerfile improvements (#3182) 2017-05-20 20:01:05 +02:00
Gemfile Adds bootsnap. Faster boot time (#3176) 2017-05-20 19:42:27 +02:00
Gemfile.lock Adds bootsnap. Faster boot time (#3176) 2017-05-20 19:42:27 +02:00
ISSUE_TEMPLATE.md Adds note for instance admins. (#1925) 2017-04-16 16:59:53 +02:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
Procfile More robust PuSH subscription refreshes (#2799) 2017-05-05 02:23:01 +02:00
Procfile.dev Fix sidekiq "port" being wrong (#3014) 2017-05-12 17:46:14 +02:00
README.md Update screenshot in readme (#2978) 2017-05-11 02:57:30 +02:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
Vagrantfile Use CLD3 (#2949) 2017-05-09 19:58:03 +02:00
app.json Use cid3 on Heroku (#3001) 2017-05-12 14:33:54 +02:00
boxfile.yml Add Support for Nanobox (#1709) 2017-05-23 16:54:44 +02:00
config.ru Fix rubocop issues, introduce usage of frozen literal to improve performance 2016-11-15 16:56:29 +01:00
docker-compose.yml Switch docker-compose to version 3. (#2747) 2017-05-04 15:56:05 +02:00
docker_entrypoint.sh Some Dockerfile improvements (#3182) 2017-05-20 20:01:05 +02:00
package.json Focus the submit button (#3253) 2017-05-23 13:10:41 +02:00
scalingo.json More SMTP customization (#1372) 2017-04-10 21:48:30 +02:00
yarn.lock Focus the submit button (#3253) 2017-05-23 13:10:41 +02:00

README.md

Mastodon

Build Status Code Climate

Mastodon is a free, open-source social network server. A decentralized solution to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.

An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

Click on the screenshot to watch a demo of the UI:

Screenshot

The project focus is a clean REST API and a good user interface. Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.

If you would like, you can support the development of this project on Patreon. Alternatively, you can donate to this BTC address: 17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd

Resources

Features

  • Fully interoperable with GNU social and any OStatus platform Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
  • Real-time timeline updates See the updates of people you're following appear in real-time in the UI via WebSockets
  • Federated thread resolving If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
  • Media attachments like images and WebM Upload and view images and WebM videos attached to the updates
  • OAuth2 and a straightforward REST API Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
  • Background processing for long-running tasks Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
  • Deployable via Docker You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy

Development

Please follow the development guide from the documentation repository.

Deployment

There are guides in the documentation repository for deploying on various platforms.

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. Here are the guidelines for code contributions

IRC channel: #mastodon on irc.freenode.net

Extra credits

  • The Emoji One pack has been used for the emojis
  • The error page image courtesy of Dopatwo

Mastodon error image