FreakU
/
mastodon
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Mastodon (Freak U edition). Fork of https://github.com/glitch-soc/mastodon
This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
2,061 Commits 3 Branches 0 Tags 211 MiB
Ruby 46.6%
JavaScript 36.7%
SCSS 10.8%
Haml 3.7%
TypeScript 2%
Other 0.1%
Go to file
Matt Jankowski 64dbde0dbf Version bumps for ruby and misc gems (#1159) 
* Update rspec-rails to version 3.5.2

* Update addressable to version 2.5.1

* Update autoprefixer-rails to version 6.7.7.1

* Update bullet to version 5.5.1

* Update domain_name to version 0.5.20170404

* Update letter_opener_web to version 1.3.1

* Upate redis-rails to version 5.0.2

* Update active_record_query_trace to version 1.5.4

* Update capistrano-rails to version 1.2.3

* Update dotenv-rails to version 2.2.0

* Update pg to version 0.20.0

* Update tilt to version 2.0.7

* Update warden to version 1.2.7

* Update tins to version 1.13.2

* Update terminal-table to version 1.7.3

* Update oj to version 2.18.5

* Update simplecov to version 0.14.1

* Update uglifier to version 3.1.13

* Update hashdiff to version 0.3.2

* Update webmock to version 2.3.2

* Update devise to version 4.2.1

* Use ruby version 2.4.1

* Update sass to version 3.4.23

* Update puma to version 3.8.2

* Update will_paginate to version 3.1.5

* Update font-awesome-rails to version 4.7.0.1

* Update fuubar to version 2.2.0

* Update pry-rails to version 0.3.6

* Update simple-navigation to version 4.0.5

* Update rubocop to version 0.48.1

* Update doorkeeper to version 4.2.5

* Update faker to version 1.7.3

* Update aws-sdk to version 2.9.5

* Update fabrication to version 2.16.1

* Update hamlit-rails to version 0.2.0

* Update http to version 2.2.1

* Update httplog to version 0.99.2

* Update sidekiq to version 4.2.10

* Update rspec-sidekiq to version 3.0.0

* Update pghero to version 1.6.4

* Update rack-cors to version 0.4.1

* Update i18n-tasks to version 0.9.13

* Update ruby-oembed to version 0.12.0

* Update jquery-rails to version 4.3.1

* Update simple_form to version 3.4.0

* Update react-rails to version 1.11.0

* Update aws-sdk to version 2.9.6

* Update sidekiq-unique-jobs to version 5.0.0

* Update uglifier to version 3.2.0
 		2017-04-10 22:47:41 +02:00
app Add more specific class names to notification divs (#1120) 2017-04-10 22:41:52 +02:00
bin Upgrade to Rails 5.0.0.1 2016-08-17 17:58:00 +02:00
config Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
db Low-hanging fruit of query optimization, these indices were missing 2017-04-07 00:04:38 +02:00
docs Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
lib Adds user confirmation rake task (#1300) 2017-04-09 01:09:46 +02:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Improve emojis - use SVGs where possible 2017-03-29 22:27:24 +02:00
spec Admin base controller (#1465) 2017-04-10 21:27:03 +02:00
storybook Fix up storybook 2017-03-02 18:55:15 +01:00
streaming Add heartbeat to websockets streaming API connections 2017-04-02 21:27:14 +02:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.babelrc Debounce autosuggestions requests 2016-11-13 13:13:36 +01:00
.buildpacks Install nodejs before ruby 2017-04-05 13:53:30 +02:00
.codeclimate.yml Create .codeclimate.yml 2016-11-17 12:40:23 -05:00
.dockerignore Optimize Dockerfile 2017-04-06 15:42:16 +08:00
.env.production.sample More SMTP customization (#1372) 2017-04-10 21:48:30 +02:00
.env.test Update .env.test 2016-11-29 17:51:16 +01:00
.env.vagrant Add a default LOCAL_DOMAIN=mastodon.dev to .env.vagrant 2017-01-26 19:22:59 +11:00
.eslintrc Don't show statuses to blocked users 2016-12-26 19:13:56 +01:00
.gitignore Add capistrano to development environment 2017-01-30 20:03:17 +01:00
.nvmrc set up Mocha/Chai/Enzyme for React component unit testing 2016-10-10 22:48:58 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Fix tests, add applications to eager loading/cache for statuses, fix 2017-01-15 14:01:33 +01:00
.ruby-version Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
.slugignore Updates slugignore. 2017-04-06 07:53:48 -04:00
.travis.yml Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
CONTRIBUTING.md Corrected spelling mistake 2017-04-02 13:01:55 -04:00
Capfile Speed up capistrano deployments 2017-02-16 02:34:21 +01:00
Dockerfile Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
Gemfile Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
Gemfile.lock Version bumps for ruby and misc gems (#1159) 2017-04-10 22:47:41 +02:00
ISSUE_TEMPLATE.md Fix typo in ISSUE_TEMPLATE 2017-04-04 14:49:31 +02:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
Procfile Force UTF8 encoding on generated XML (#1140) 2017-04-07 11:09:14 +02:00
README.md fixed a sentence in readme 2017-04-07 19:48:46 -07:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
Vagrantfile Add a couple of network performance tweaks to Vagrantfile. 2017-04-06 22:34:59 +02:00
app.json More SMTP customization (#1372) 2017-04-10 21:48:30 +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 Revert "add persistance to Postresql container" (#1251) 2017-04-08 12:25:23 +02:00
package.json Improve emojis - use SVGs where possible 2017-03-29 22:27:24 +02:00
scalingo.json More SMTP customization (#1372) 2017-04-10 21:48:30 +02:00
yarn.lock Improve emojis - use SVGs where possible 2017-03-29 22:27:24 +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

Configuration

  • LOCAL_DOMAIN should be the domain/hostname of your instance. This is absolutely required as it is used for generating unique IDs for everything federation-related
  • LOCAL_HTTPS set it to true if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs

Consult the example configuration file, .env.production.sample for the full list. Among other things you need to set details for the SMTP server you are going to use.

Requirements

  • Ruby
  • Node.js
  • PostgreSQL
  • Redis
  • Nginx

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 -d

As usual, the first thing you would need to do would be to run migrations:

docker-compose run --rm web rails db:migrate

And since the instance running in the container will be running in production mode, you need to pre-compile assets:

docker-compose run --rm web rails assets:precompile

The container has two volumes, for the assets and for user uploads. The default docker-compose.yml maps them to the repository's public/assets and public/system directories, you may wish to put them somewhere else. Likewise, the PostgreSQL and Redis images have data containers that you may wish to map somewhere where you know how to find them and back them 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.

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:push:clear unsubscribes from PuSH notifications for remote users that have no local followers. You may not want to actually do that, to keep a fuller footprint of the fediverse or in case your users will soon re-follow
  • rake mastodon:push:refresh re-subscribes PuSH for expiring remote users, this should be run periodically from a cronjob and quite often as the expiration time depends on the particular hub of the remote user
  • rake mastodon:feeds:clear_all removes all timelines, which forces them to be re-built on the fly next time a user tries to fetch their home/mentions timeline. Only for troubleshooting
  • rake mastodon:feeds:clear removes timelines of users who haven't signed in lately, which allows to save RAM and improve message distribution. This is required to be run periodically so that when they login again the regeneration process will trigger

Running any of these tasks via docker-compose would look like this:

docker-compose run --rm web rake mastodon:media:clear

Updating

This approach makes updating to the latest version a real breeze.

git pull

To pull down the updates, re-run

docker-compose build

And finally,

docker-compose up -d

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.

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 for examples, configuration and instructions.

Deployment on Scalingo

Deploy on Scalingo

You can view a guide for deployment on Scalingo here.

Deployment on Heroku (experimental)

Deploy

Mastodon can theoretically run indefinitely on a free Heroku app. You can view a guide for deployment on Heroku here.

Development with Vagrant

A quick way to get a development environment up and running is with Vagrant. You will need recent versions of Vagrant and VirtualBox installed.

You can find the guide for setting up a Vagrant development environment here.

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