Your self-hosted, globally interconnected microblogging community
Pull request Compare This branch is 84 commits ahead, 352 commits behind tootsuite:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
.github
app
bin
config
db
docs
lib
log
nanobox
public
spec
streaming
vendor/assets
.babelrc
.buildpacks
.codeclimate.yml
.dockerignore
.editorconfig
.env.nanobox
.env.production.sample
.env.test
.env.vagrant
.eslintignore
.eslintrc.yml
.foreman
.gitattributes
.gitignore
.haml-lint.yml
.nanoignore
.nvmrc
.postcssrc.yml
.profile
.rspec
.rubocop.yml
.ruby-version
.scss-lint.yml
.slugignore
.yarnclean
AUTHORS.md
Aptfile
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Capfile
Dockerfile
Gemfile
Gemfile.lock
LICENSE
Procfile
Procfile.dev
README.md
Rakefile
Vagrantfile
app.json
boxfile.yml
config.ru
docker-compose.yml
jest.config.js
mock-qualifiers.js
package.json
priv-config
scalingo.json
yarn.lock

README.md

Feedseer

Feedseer is an instance of Mastodon that gives users more control over their feeds.

This is achieved using qualifiers and actions. Qualifiers provide a way to analyze the content of a toot and take action based on that. Based on a qualifier's output, actions can be configured to either hide a toot or move it to a folder. Users can create their own qualifiers to analyze different types of toots or provide interesting insights on a toot's content.

Feedseer is in Private Alpha. Things will break sometimes and your data may be lost. Our sincere apologies in advance.

How to use Feedseer

  • Navigate to Qualifier Store.
  • Click on a qualifier name to see a qualifier's details.
  • Read the qualifier description to understand the type of analysis performed on a toot.
  • Qualifier endpoint is where a qualifier is hosted. See the How to create qualifiers section below to understand how qualifiers access your toots. Qualifiers cannot access your profile information.
  • Add a qualifier to your profile by clicking the Install button.
  • Click the Add filter button to set up an action based on a qualifier's response. The response can be true or false based on whether or not a toot is related to what the qualifier was looking for.
    • Select a filter condition based on the qualifier's response.
    • Select the action to be taken on a toot that qualifies:
      • Set the action to Skip Inbox to remove it from your timelines.
      • Select Move to folder and provide a folder name, to move the toot to a folder.
  • Save the qualifier.
  • You can update your qualifier's configuration here.

Please write a review for the qualifiers you use so that others can benefit from it. Also, mention the version of qualifier you are reviewing.

How to create qualifiers

  • Navigate to this page.
  • Click on Add qualifier button.
  • Provide a good name and description for your qualifier.
    • Description should include the kind of content a qualifier analyzes and the corresponding response (true or false) it returns.
  • Endpoint is the HTTPS URL that will be called with a toot's content.
    • Request will have a content-type: application/json header.
    • Request body format will be:
{
  "text": "Hello seers!"
}
  • Response body format (content-type: application/json) should be:
{
  "result": true or false (Boolean)
}
  • HTTP Headers will be set on the request sent to your endpoint. It can be used to set authentication headers.
  • Version can be used to indicate improvements to your qualifier. This helps users review a specific version of a qualifier.
  • Select a category for the qualifier from the provided list.
  • Save your qualifier.

A qualifier will be called only once per toot.

Roadmap

  • Provide more qualifiers out-of-the-box.
  • Media toots with qualifiers.
  • Granular controls over enabling qualifiers.

Mastodon

Build Status Code Climate Translation status

Mastodon is a free, open-source social network server based on open web protocols like ActivityPub and OStatus. The social focus of the project is a viable decentralized alternative to commercial social media silos that returns the control of the content distribution channels to the people. The technical focus of the project is a good user interface, a clean REST API for 3rd party apps and robust anti-abuse tools.

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

Screenshot

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.


Resources

Features

No vendor lock-in: Fully interoperable with any conforming platform

It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!

Real-time timeline updates

See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!

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 short videos

Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos are looped - like vines!

OAuth2 and a straightforward REST API

Mastodon acts as an OAuth2 provider so 3rd party apps can use the API

Fast response times

Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing

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

License

Copyright (C) 2016-2018 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.


Extra credits

The elephant friend illustrations are created by Dopatwo