OpenSource/mastodon
OpenSource/mastodon
1
0
Fork 0
mirror of https://github.com/mastodon/mastodon.git synced 2024-12-22 18:45:41 +01:00
Code Issues Projects Releases Packages Wiki Activity
Your self-hosted, globally interconnected microblogging community https://joinmastodon.org
34 commits 132 branches 269 tags 1.1 GiB
Ruby 64.1%
JavaScript 17.6%
TypeScript 8.7%
SCSS 4.7%
Haml 4.4%
Other 0.5%
Find a file
Eugen Rochko 7e93da3f8d Removing grape and adding devise
2016-03-05 13:12:24 +01:00
app Removing grape and adding devise 2016-03-05 13:12:24 +01:00
bin Initial commit 2016-02-20 22:53:20 +01:00
config Removing grape and adding devise 2016-03-05 13:12:24 +01:00
db Removing grape and adding devise 2016-03-05 13:12:24 +01:00
lib Initial commit 2016-02-20 22:53:20 +01:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Initial commit 2016-02-20 22:53:20 +01:00
spec Fixing some bugs, adding pending test examples 2016-03-05 12:50:59 +01:00
test Initial commit 2016-02-20 22:53:20 +01:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.gitignore Adding avatars to profile page and statuses 2016-02-28 00:51:05 +01:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.ruby-version Initial commit 2016-02-20 22:53:20 +01:00
config.ru Initial commit 2016-02-20 22:53:20 +01:00
Gemfile Removing grape and adding devise 2016-03-05 13:12:24 +01:00
Gemfile.lock Removing grape and adding devise 2016-03-05 13:12:24 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
README.md Incoming Salmon requests can be turned into follows and unfollows 2016-02-23 22:17:07 +01:00

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