Your self-hosted, globally interconnected microblogging community
 
 
 
 
 
 
Go to file
Eugen Rochko 3b4e04dc32 Fixing some bugs, adding pending test examples
app Fixing some bugs, adding pending test examples
bin Initial commit
config Changing the use of config constants to the Rails configuration object
db Adding paperclip for avatars, fixing design of the public pages
lib Initial commit
log Initial commit
public Initial commit
spec Fixing some bugs, adding pending test examples
test Initial commit
vendor/assets Initial commit
.gitignore Adding avatars to profile page and statuses
.rspec Adding a Mention model, test stubs
.ruby-version Initial commit
Gemfile Refactoring Grape API methods into normal controllers & other things
Gemfile.lock Refactoring Grape API methods into normal controllers & other things
README.md Incoming Salmon requests can be turned into follows and unfollows
Rakefile Initial commit
config.ru Initial commit

README.md

Mastodon

Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

The core ideals of this project are:

  • Independence of legacy Twitter APIs - we don't want to be compatible with Twitter clients, we want our own clients
  • In that vein, a strong and clean REST API and OAuth2
  • Minimalism. Just because you can do almost anything with ActivityStreams doesn't mean you should. Limit the set of possible functions to what makes sense in a microblogging engine. This will make federation as well as UI design a lot easier
  • Ease of deployment. The end-goal of this project is to be distributable as a Docker image.

Current status of the project is early development. Documentation, licensing information &co will be added later

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
  • HUB_URL should be the URL of the PubsubHubbub service that your instance is going to use. By default it is the open service of Superfeedr