diff options
| author | Eugen <eugen@zeonfederated.com> | 2017-04-11 18:03:02 +0200 |
|---|---|---|
| committer | Shel R <shelraphen@gmail.com> | 2017-04-11 12:03:02 -0400 |
| commit | 1236529e39a7e2534fdd34686a749b5a386c109b (patch) | |
| tree | 5d970d939bfdb37c343caddea291fcc8a6f03b79 /docs | |
| parent | b723ee73fc7d74fd5908eb09a8f6b98e73597c2b (diff) | |
Moving docs to tootsuite/documentation (#1550)
Diffstat (limited to 'docs')
41 files changed, 23 insertions, 1837 deletions
diff --git a/docs/Contributing-to-Mastodon/Sponsors.md b/docs/Contributing-to-Mastodon/Sponsors.md index 131f5fabe..8fc22b6bb 100644 --- a/docs/Contributing-to-Mastodon/Sponsors.md +++ b/docs/Contributing-to-Mastodon/Sponsors.md @@ -1,46 +1 @@ -Sponsors -======== - -These people make the development of Mastodon possible through [Patreon](https://www.patreon.com/user?u=619786): - -**Extra special Patrons** - -- [World'sTallestLadder](https://mastodon.social/users/carcinoGeneticist) -- [Jimmy Tidey](https://mastodon.social/users/jimmytidey) -- [Kurtis Rainbolt-Greene](https://mastodon.social/users/krainboltgreene) -- [Kit Redgrave](https://socially.constructed.space/users/KitRedgrave) -- [Zeipher](https://mastodon.social/users/Zeipher) -- [Effy Elden](https://mastodon.social/users/effy) -- [Zoë Quinn](https://mastodon.social/users/zoequinn) - -**Thank you to the following people** - -- [Harris Bomberguy](https://mastodon.social/users/Hbomberguy) -- [Edward Saperia](https://nwspk.com) -- [Yoz Grahame](http://yoz.com/) -- [Jenn Kaplan](https://gay.crime.team/users/jkap) -- [Natalie Weizenbaum](https://mastodon.social/users/nex3) -- [Matteo De Micheli](http://matteodem.ch/) -- [BirdMachine](https://mastodon.social/users/BirdMachine) -- [Jessica Hayley](https://mastodon.social/users/jayhay) -- [Niels Roesen Abildgaard](http://hypesystem.dk/) -- [Zatnosk](https://github.com/Zatnosk) -- [Spex Bluefox](https://mastodon.social/users/Spex) -- [J. C. Holder](http://jcholder.com/) -- [glocal](https://mastodon.social/users/glocal) -- [jk](https://mastodon.social/users/jk) -- [C418](https://mastodon.social/users/C418) -- [halcy](https://icosahedron.website/users/halcy) -- [Extropic](https://gnusocial.no/extropic) -- [Pat Monaghan](http://iwrite.software/) -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD -- TBD +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Contributing-to-Mastodon/Sponsors.md) diff --git a/docs/Contributing-to-Mastodon/Translating.md b/docs/Contributing-to-Mastodon/Translating.md index 7319375ee..1671645ee 100644 --- a/docs/Contributing-to-Mastodon/Translating.md +++ b/docs/Contributing-to-Mastodon/Translating.md @@ -1,48 +1 @@ -Translating -=========== - -If you want to localise Mastodon into your language, here is how. - -There are two parts to Mastodon, the server and the web client. The translations for the web client are in `app/assets/javascripts/components/locales`. For the server-side, the translations live in `config/locales` and are divided into different files. Here are all the files you’ll need to translate: - -| Original file (English) | Location | Description | -|---|---|---| -| [`en.jsx`](/app/assets/javascripts/components/locales/en.jsx) | `app/assets/javascripts/components/locales/en.jsx` | Strings for the web client | -| [`en.yml`](/config/locales/en.yml) | `config/locales/en.yml` | Strings for general use | -| [`simple_form.en.yml`](/config/locales/simple_form.en.yml) | `config/locales/simple_form.en.yml` | Strings for the settings area | -| [`devise.en.yml`](/config/locales/devise.en.yml) | `config/locales/devise.en.yml` | Generic strings for Devise | -| [`doorkeeper.en.yml`](/config/locales/doorkeeper.en.yml) | `config/locales/doorkeeper.en.yml` | Generic strings for Doorkeeper | - -## Translating - -If you use Github, first clone the Mastodon repository to your account. - -1. Duplicate the files in their folder and replace `en` in the filenames by your language’s standard two-letters code ([ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)). - For instance `simple_form.en.yml` becomes `simple_form.es.yml` in the Spanish translation. -2. Also replace the language code in the first lines of all the files, and the last line of the `.jsx` file. -3. Translate the right-side values from English to your language. Keep the indentation and punctuation. - -Since Devise and Doorkeeper are popular libraries, there may already be translation files for your language available on the Internet. - -## Declaring the language - -The locales are mentioned in several other files. To activate your translation, add your language code to the different lists present in these files: - -| File | Location | Comment | -|---|---|---| -| [`index.jsx`](/app/assets/javascripts/components/locales/index.jsx) | `app/assets/javascripts/components/locales/index.jsx` | 2 lines to add | -|[`mastodon.jsx`](/app/assets/javascripts/components/containers/mastodon.jsx) | `app/assets/javascripts/components/containers/mastodon.jsx` | 1 line to add + 1 list to complete | -| [`settings_helper.rb`](/app/helpers/settings_helper.rb) | `app/helpers/settings_helper.rb` | 1 line to add + your language’s name | -| [`application.rb`](/config/application.rb) | `config/application.rb` | 1 list to complete | - -## Sending the translation - -You can then push the files to git and submit a pull request. - -## Testing the translation - -Once the pull request is accepted, wait for the code to be deployed on a Mastodon instance. Log-in with your account there, and change the locale in the settings. Browse and use the website. See if everything makes sense in context and if anything seems out of place or breaks the layout. Invite other Mastodon users speaking your language to try it and give feedback. Make changes accordingly and update the translation. - -## Updating the translation - -Keep an eye on the original English files in `app/assets/javascripts/components/locales` and `config/locales`. When they are updated, pass on the changes to your language files. For new strings, add the new lines to the same position and translate them. Once you’re finished with the updates, you can submit a new pull request. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Contributing-to-Mastodon/Translating.md) diff --git a/docs/Extensions.md b/docs/Extensions.md index cf79379eb..be4c6eabd 100644 --- a/docs/Extensions.md +++ b/docs/Extensions.md @@ -1,50 +1 @@ -Protocol extensions -=================== - -Some functionality in Mastodon required some additions to the protocols to enable seamless federation of those features: - -### Federation of blocks/unblocks - -ActivityStreams was lacking verbs for block/unblock. Mastodon creates Salmon slaps for block and unblock events, which are not part of a user's public feed, but are nevertheless delivered to the target user. The intent of these Salmon slaps is not to notify the target user, but to notify the target user's server, so that it can perform any number of UX-related tasks such as removing the target user as a follower of the blocker, and/or displaying a message to the target user such as "You can't follow this person because you've been blocked" - -The Salmon slaps have the exact same structure as standard follow/unfollow slaps, the verbs are namespaced: - -- `http://mastodon.social/schema/1.0/block` -- `http://mastodon.social/schema/1.0/unblock` - -### Federation of sensitive material - -Statuses can be marked as containing sensitive (or not safe for work) media. This is symbolized by a `<category term="nsfw" />` on the Atom entry - -### Federation of privacy features -#### Locked accounts and status privacy levels - -Accounts and statuses have an access "scope": - -Accounts can be "private" or "public". The former requires a follow request to be approved before a follow relationship can be established, the latter can be followed directly. - -Statuses can be "private", "unlisted" or "public". Private must only be shown to the followers of the account or people mentioned in the status; public can be displayed publicly. Unlisted statuses may be displayed publicly but preferably outside of any spotlights e.g. "whole known network" or "public" timelines. - -Namespace of the scope element is `http://mastodon.social/schema/1.0`. Example: - -```xml -<entry> - <!-- ... --> - <author> - <!-- ... --> - <mastodon:scope>private</mastodon:scope> - </author> - <!-- ... --> - <mastodon:scope>private</mastodon:scope> -</entry> -``` - -#### Follow requests - -Mastodon uses the following Salmon slaps to signal a follow request, a follow request authorization and a follow request rejection: - -- `http://activitystrea.ms/schema/1.0/request-friend` -- `http://activitystrea.ms/schema/1.0/authorize` -- `http://activitystrea.ms/schema/1.0/reject` - -The activity object of the request-friend slap is the account in question. The activity object of the authorize and reject slaps is the original request-friend activity. Request-friend slap is sent to the locked account, when the end-user of that account decides, the authorize/reject decision slap is sent back to the requester. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Extensions.md) diff --git a/docs/README.md b/docs/README.md index abf6fcc4b..63bcf5a24 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,36 +1 @@ -Index -===== - -**Mastodon** is a free, open-source GNU social-compatible social network server. A decentralized alternative 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. - -### Using Mastodon -- [Frequently Asked Questions](Using-Mastodon/FAQ.md) -- [List of Mastodon instances](Using-Mastodon/List-of-Mastodon-instances.md) -- [Apps](Using-Mastodon/Apps.md) -- [User Guide](Using-Mastodon/User-guide.md) - -### Using the API -- [API documentation](Using-the-API/API.md) -- [Streaming API documentation](Using-the-API/Streaming-API.md) -- [Testing the API with cURL](Using-the-API/Testing-with-cURL.md) -- [OAuth details](Using-the-API/OAuth-details.md) -- [Tips for app developers](Using-the-API/Tips-for-app-developers.md) -- [Push notifications](Using-the-API/Push-notifications.md) - -### Running Mastodon -- [Production guide](Running-Mastodon/Production-guide.md) -- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md) -- [Development guide](Running-Mastodon/Development-guide.md) -- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md) -- [Administration guide](Running-Mastodon/Administration-guide.md) -- [Tuning Mastodon](Running-Mastodon/Tuning.md) - -### Contributing to Mastodon -- [Sponsors](Contributing-to-Mastodon/Sponsors.md) -- [Translate Mastodon in your language](Contributing-to-Mastodon/Translating.md) -- [Report bugs and submit ideas](https://github.com/tootsuite/mastodon/issues) - -### Protocols - -- [List of used specs and RFCs for the federation](Specs-and-RFCs-used.md) -- [Extensions of the above protocols](Extensions.md) +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/README.md) diff --git a/docs/Running-Mastodon/Administration-guide.md b/docs/Running-Mastodon/Administration-guide.md index 8bcfe7c9e..e7571be3a 100644 --- a/docs/Running-Mastodon/Administration-guide.md +++ b/docs/Running-Mastodon/Administration-guide.md @@ -1,45 +1 @@ -Administration guide -==================== - -So, you have a working Mastodon instance... now what? - -## Turning into an admin - -The following rake task: - - RAILS_ENV=production bundle exec rails mastodon:make_admin USERNAME=alice - -Would turn the local user "alice" into an admin. - -## Administration web interface - -A user that is designated as `admin = TRUE` in the database is able to access a suite of administration tools: - -* View, edit, silence, or suspend users - https://yourmastodon.instance/admin/accounts -* View PubSubHubbub subscriptions - https://yourmastodon.instance/admin/pubsubhubbub -* View domain blocks - https://yourmastodon.instance/admin/domain_blocks -* Sidekiq dashboard - https://yourmastodon.instance/sidekiq -* PGHero dashboard for PostgreSQL - https://yourmastodon.instance/pghero -* Edit site settings - https://yourmastodon.instance/admin/settings - -## Site settings - -Your site settings are stored in the `settings` database table, and editable through the admin interface at https://yourmastodon.instance/admin/settings. - -You are able to set the following settings: - -- Site title -- Contact username -- Contact email -- Site description -- Site extended description - -You may wish to use the extended description (shown at https://yourmastodon.instance/about/more ) to display content guidelines or a user agreement (see https://mastodon.social/about/more for an example). - -## Confirming Users Manually - -The following rake task: - - RAILS_ENV=production bundle exec rails mastodon:confirm_email USER_EMAIL=alice@alice.com - -Will confirm a user manually, in case they don't have access to their confirmation email for whatever reason. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Administration-guide.md) diff --git a/docs/Running-Mastodon/Development-guide.md b/docs/Running-Mastodon/Development-guide.md index 27efa346e..10ed64087 100644 --- a/docs/Running-Mastodon/Development-guide.md +++ b/docs/Running-Mastodon/Development-guide.md @@ -1,50 +1 @@ -Development guide -================= - -**Don't use Docker to do development**. It's a quick way to get Mastodon running in production, it's **really really inconvenient for development**. Normally in Rails development environment you get hot reloading of backend code and on-the-fly compilation of assets like JS and CSS, but you lose those benefits by compiling a Docker image. If you want to contribute to Mastodon, it is worth it to simply set up a proper development environment. - -In fact, all you need is described in the [production guide](Production-guide.md), **with the following exceptions**. You **don't** need: - -- Nginx -- SystemD -- An `.env.production` file. If you need to set any environment variables, you can use an `.env` file -- To prefix any commands with `RAILS_ENV=production` since the default environment is "development" anyway -- Any cronjobs - -The command to install project dependencies does not require any flags, i.e. simply - - bundle install - -By default the development environment wants to connect to a `mastodon_development` database on localhost using your user/ident to login to Postgres (i.e. not a md5 password) - -You can run Mastodon with: - - rails s - -And open `http://localhost:3000` in your browser. Background jobs run inline (aka synchronously) in the development environment, so you don't need to run a Sidekiq process. - -By default, your development environment will have an admin account created for you to use - the email address will be `admin@YOURDOMAIN` (e.g. admin@localhost:3000) and the password will be `mastodonadmin`. - -You can run tests with: - - rspec - -You can check localization status with: - - i18n-tasks health - -You can check code quality with: - - rubocop - -## Development tips - -You can use a localhost->world tunneling service like ngrok if you want to test federation, **however** that should not be your primary mode of operation. If you want to have a permanently federating server, set up a proper instance on a VPS with a domain name, and simply keep it up to date with your own fork of the project while doing development on localhost. - -Ngrok and similar services give you a random domain on each start up. This is good enough to test how the code you're working on handles real-world situations. But as soon as your domain changes, for everybody else concerned you're a different instance than before. - -Generally, federation bits are tricky to work on for exactly this reason - it's hard to test. And when you are testing with a disposable instance you are polluting the databases of the real servers you're testing against, usually not a big deal but can be annoying. The way I have handled this so far was thus: I have used ngrok for one session, and recorded the exchanges from its web interface to create fixtures and test suites. From then on I've been working with those rather than live servers. - -I advise to study the existing code and the RFCs before trying to implement any federation-related changes. It's not *that* difficult, but I think "here be dragons" applies because it's easy to break. - -If your development environment is running remotely (e.g. on a VPS or virtual machine), setting the `REMOTE_DEV` environment variable will swap your instance from using "letter opener" (which launches a local browser) to "letter opener web" (which collects emails and displays them at /letter_opener ). \ No newline at end of file +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) diff --git a/docs/Running-Mastodon/Heroku-guide.md b/docs/Running-Mastodon/Heroku-guide.md index 4978a20ac..aa5abc1f5 100644 --- a/docs/Running-Mastodon/Heroku-guide.md +++ b/docs/Running-Mastodon/Heroku-guide.md @@ -1,86 +1 @@ -Heroku guide -============ - -[](https://dashboard.heroku.com/new?button-url=https://github.com/tootsuite/mastodon&template=https://github.com/tootsuite/mastodon) - -Mastodon can be run on a free [Heroku](https://heroku.com) app. It should be -noted this has limited testing and could have unpredictable results. - -## Basic setup - -Click the button above to start creating a Heroku app with the Mastodon repo as -the source. This tells Heroku to use the `app.json` file which does things like -prompt for config variables, set up the right buildpacks, run a postdeploy task, -and add the appropriate addons. - -If you don't use the deploy button and app.json approach, you will need to do -some of that manually. - -## Domain names and SSL - -You can add your domain name to the Heroku app's setting, and then also use -Heroku's (free) auto renewal program for Lets Encrypt certificates, by -requesting a cert from the settings screen. You'll have to point your hostname -DNS at Heroku using the values heroku gives you on this screen, using whatever -method is appropriate for your DNS setup. - -You should set the Heroku config vars of `LOCAL_DOMAIN` to your hostname, and -`LOCAL_HTTPS` to "true" as well. - -## Email - -Consider using [Mailgun](https://mailgun.com) or similar, who offer free plans -that should suit your interests. Look in `production.rb` to see which config -variables need to be set on Heroku for outgoing email to work. - -## File storage - -You will want Amazon S3 for file storage. The only exception is for development -purposes, where you may not care if files are not saved. Follow a guide online -for creating a free Amazon S3 bucket and Access Key, then enter the details. - -If you deploy from the web, the format for all the S3 bits use Paperclip conventions: - -S3 Bucket is just the name of the bucket, e.g. `bucketname` not the full ARN. - -S3 Region is the AWS code for the region e.g. `ap-northeast-1` not the name of the city displayed on the AWS Dashboard. - -To protect the privacy of the users of the your instance, you should have permissons on the your S3 bucket set to no-read and no-write for the public and non-application-specific AWS users, with only one authorized IAM user or group set up to be able to upload or display content. This is an example of an IAM policy used for the S3 bucket used Mastadon instance hentai.loan: - - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "s3:ListAllMyBuckets" - ], - "Resource": [ - "arn:aws:s3:::*" - ] - }, - { - "Effect": "Allow", - "Action": [ - "s3:*" - ], - "Resource": [ - "arn:aws:s3:::hentailoan”, - "arn:aws:s3:::hentailoan/*" - ] - } - ] - } - - -## Deployment - -You can deploy from the Heroku web interface or from the command line. Run: - - `heroku run rails db:migrate` - -after you first deploy to set up the first database. - -To make yourself an admin, you may need to use the `heroku` CLI application after creating an account online: - - `heroku rake mastodon:make_admin USERNAME=yourUsername` +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Heroku-guide.md) diff --git a/docs/Running-Mastodon/Production-guide.md b/docs/Running-Mastodon/Production-guide.md index 49f3e59b2..08649e9ce 100644 --- a/docs/Running-Mastodon/Production-guide.md +++ b/docs/Running-Mastodon/Production-guide.md @@ -1,261 +1 @@ -Production guide -================ - -## Nginx - -Regardless of whether you go with the Docker approach or not, here is an example Nginx server configuration: - -```nginx -map $http_upgrade $connection_upgrade { - default upgrade; - '' close; -} - -server { - listen 80; - listen [::]:80; - server_name example.com; - return 301 https://$host$request_uri; -} - -server { - listen 443 ssl; - server_name example.com; - - ssl_protocols TLSv1.2; - ssl_ciphers EECDH+AESGCM:EECDH+AES; - ssl_ecdh_curve prime256v1; - ssl_prefer_server_ciphers on; - ssl_session_cache shared:SSL:10m; - - ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; - ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; - - keepalive_timeout 70; - sendfile on; - client_max_body_size 0; - - root /home/mastodon/live/public; - - gzip on; - gzip_disable "msie6"; - gzip_vary on; - gzip_proxied any; - gzip_comp_level 6; - gzip_buffers 16 8k; - gzip_http_version 1.1; - gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; - - - add_header Strict-Transport-Security "max-age=31536000; includeSubDomains"; - - location / { - try_files $uri @proxy; - } - - location @proxy { - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto https; - proxy_set_header Proxy ""; - proxy_pass_header Server; - - proxy_pass http://localhost:3000; - proxy_buffering off; - proxy_redirect off; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection $connection_upgrade; - - tcp_nodelay on; - } - - location /api/v1/streaming { - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto https; - proxy_set_header Proxy ""; - - proxy_pass http://localhost:4000; - proxy_buffering off; - proxy_redirect off; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection $connection_upgrade; - - tcp_nodelay on; - } - - error_page 500 501 502 503 504 /500.html; -} -``` - -## Running in production without Docker - -It is recommended to create a special user for mastodon on the server (you could call the user `mastodon`), though remember to disable outside login for it. You should only be able to get into that user through `sudo su - mastodon`. - -## General dependencies - - sudo apt-get install imagemagick ffmpeg libpq-dev libxml2-dev libxslt1-dev nodejs file git curl - curl -sL https://deb.nodesource.com/setup_4.x | sudo bash - - - sudo apt-get install nodejs - - sudo npm install -g yarn - -## Redis - - sudo apt-get install redis-server redis-tools - -## Postgres - - sudo apt-get install postgresql postgresql-contrib - -Setup a user and database for Mastodon: - - sudo su - postgres - psql - -In the prompt: - - CREATE USER mastodon CREATEDB; - \q - -## Rbenv - -It is recommended to use rbenv (exclusively from the `mastodon` user) to install the desired Ruby version. Follow the guides to [install rbenv][1] and [rbenv-build][2] (I recommend checking the [prerequisites][3] for your system on the rbenv-build project and installing them beforehand, obviously outside the unprivileged `mastodon` user) - -[1]: https://github.com/rbenv/rbenv#installation -[2]: https://github.com/rbenv/ruby-build#installation -[3]: https://github.com/rbenv/ruby-build/wiki#suggested-build-environment - -Then once `rbenv` is ready, run `rbenv install 2.4.1` to install the Ruby version for Mastodon. - -## Git - -You need the `git-core` package installed on your system. If it is so, from the `mastodon` user: - - cd ~ - git clone https://github.com/tootsuite/mastodon.git live - cd live - -Then you can proceed to install project dependencies: - - gem install bundler - bundle install --deployment --without development test - yarn install - -## Configuration - -Then you have to configure your instance: - - cp .env.production.sample .env.production - nano .env.production - -Fill in the important data, like host/port of the redis database, host/port/username/password of the postgres database, your domain name, SMTP details (e.g. from Mailgun or equivalent transactional e-mail service, many have free tiers), whether you intend to use SSL, etc. If you need to generate secrets, you can use: - - rake secret - -To get a random string. If you are setting up on one single server (most likely), then `REDIS_HOST` is localhost and `DB_HOST` is `/var/run/postgresql`, `DB_USER` is `mastodon` and `DB_NAME` is `mastodon_production` while `DB_PASS` is empty because this setup will use the ident authentication method (system user "mastodon" maps to postgres user "mastodon"). - -## Setup - -And setup the database for the first time, this will create the tables and basic data: - - RAILS_ENV=production bundle exec rails db:setup - -Finally, pre-compile all CSS and JavaScript files: - - RAILS_ENV=production bundle exec rails assets:precompile - -## Systemd - -Example systemd configuration for the web workers, to be placed in `/etc/systemd/system/mastodon-web.service`: - -```systemd -[Unit] -Description=mastodon-web -After=network.target - -[Service] -Type=simple -User=mastodon -WorkingDirectory=/home/mastodon/live -Environment="RAILS_ENV=production" -Environment="PORT=3000" -ExecStart=/home/mastodon/.rbenv/shims/bundle exec puma -C config/puma.rb -TimeoutSec=15 -Restart=always - -[Install] -WantedBy=multi-user.target -``` - -Example systemd configuration for the background workers, to be placed in `/etc/systemd/system/mastodon-sidekiq.service`: - -```systemd -[Unit] -Description=mastodon-sidekiq -After=network.target - -[Service] -Type=simple -User=mastodon -WorkingDirectory=/home/mastodon/live -Environment="RAILS_ENV=production" -Environment="DB_POOL=5" -ExecStart=/home/mastodon/.rbenv/shims/bundle exec sidekiq -c 5 -q default -q mailers -q pull -q push -TimeoutSec=15 -Restart=always - -[Install] -WantedBy=multi-user.target -``` - -Example systemd configuration file for the streaming API, to be placed in `/etc/systemd/system/mastodon-streaming.service`: - -```systemd -[Unit] -Description=mastodon-streaming -After=network.target - -[Service] -Type=simple -User=mastodon -WorkingDirectory=/home/mastodon/live -Environment="NODE_ENV=production" -Environment="PORT=4000" -ExecStart=/usr/bin/npm run start -TimeoutSec=15 -Restart=always - -[Install] -WantedBy=multi-user.target -``` - -This allows you to `sudo systemctl enable /etc/systemd/system/mastodon-*.service` and `sudo systemctl start mastodon-web.service mastodon-sidekiq.service mastodon-streaming.service` to get things going. - -## Cronjobs - -I recommend creating a couple cronjobs for the following tasks: - -- `RAILS_ENV=production bundle exec rake mastodon:media:clear` -- `RAILS_ENV=production bundle exec rake mastodon:push:refresh` -- `RAILS_ENV=production bundle exec rake mastodon:feeds:clear` - -You may want to run `which bundle` first and copypaste that full path instead of simply `bundle` in the above commands because cronjobs usually don't have all the paths set. The time and intervals of when to run these jobs are up to you, but once every day should be enough for all. - -You can edit the cronjob file for the `mastodon` user by running `sudo crontab -e -u mastodon` (outside of the mastodon user). - -## Things to look out for when upgrading Mastodon - -You can upgrade Mastodon with a `git pull` from the repository directory. You may need to run: - -- `RAILS_ENV=production bundle exec rails db:migrate` -- `RAILS_ENV=production bundle exec rails assets:precompile` - -Depending on which files changed, e.g. if anything in the `/db/` or `/app/assets` directory changed, respectively. Also, Mastodon runs in memory, so you need to restart it before you see any changes. If you're using systemd, that would be: - - sudo systemctl restart mastodon-*.service +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Production-guide.md) diff --git a/docs/Running-Mastodon/Scalingo-guide.md b/docs/Running-Mastodon/Scalingo-guide.md index 9329f753e..8c986f750 100644 --- a/docs/Running-Mastodon/Scalingo-guide.md +++ b/docs/Running-Mastodon/Scalingo-guide.md @@ -1,13 +1 @@ -Scalingo guide -============== - -[](https://my.scalingo.com/deploy?source=https://github.com/tootsuite/mastodon#master) - -1. Click the above button. -2. Fill in the options requested. - * You can use a .scalingo.io domain, which will be simple to set up, or you can use a custom domain. - * You will want Amazon S3 for file storage. The only exception is for development purposes, where you may not care if files are not saved. Follow a guide online for creating a free Amazon S3 bucket and Access Key, then enter the details. - * If you want your Mastodon to be able to send emails, configure SMTP settings here (or later). Consider using [Mailgun](https://mailgun.com) or similar, who offer free plans that should suit your interests. -3. Deploy! The app should be set up, with a working web interface and database. You can change settings and manage versions from the Scalingo dashboard. - -To make yourself an admin, you can use the `scalingo` CLI: `scalingo run -e USERNAME=yourusername rails mastodon:make_admin`. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Scalingo-guide.md) diff --git a/docs/Running-Mastodon/Tuning.md b/docs/Running-Mastodon/Tuning.md index c4acb9927..41fa93ef3 100644 --- a/docs/Running-Mastodon/Tuning.md +++ b/docs/Running-Mastodon/Tuning.md @@ -1,104 +1 @@ -Tuning Mastodon -=============== - -Mastodon has three types of processes: - -- web -- streaming API -- background processing - -By default, the web type spawns two worker processes with 5 threads each, the streaming API is a single thread/process with 10 database pool connections, and background processing spawns one process with 5 threads. - -### Web - -The web process serves short-lived HTTP requests for most of the application. The following environment variables control it: - -- `WEB_CONCURRENCY` controls the number of worker processes -- `MAX_THREADS` controls the number of threads per process - -The default is 2 workers with 5 threads each. Threads share the memory of their parent process. Different processes allocate their own memory each. Threads in Ruby are not native threads, so it's more or less: threads equal concurrency, processes equal parallelism. A larger number of threads maxes out your CPU first, a larger number of processes maxes out your RAM first. - -These values affect how many HTTP requests can be served at the same time. When not enough threads are available, requests are queued until they can be answered. - -For a single-user instance, 1 process with 5 threads should be more than enough. - -### Streaming API - -The streaming API handles long-lived HTTP and WebSockets connections, through which clients receive real-time updates. It is a single-threaded process. By default it has a database connection pool of 10, which means 10 different database queries can run *at the same time*. The database is not heavily used in the streaming API, only for initial authentication of the request, and for some special receiver-specific filter queries when receiving new messages. At the time of writing this value cannot be reconfigured, but mostly doesn't need to. - -If you need to scale up the streaming API, spawn more separate processes on different ports (e.g. 4000, 4001, 4003, etc) and load-balance between them with nginx. - -### Background processing - -Many tasks in Mastodon are delegated to background processing to ensure the HTTP requests are fast, and to prevent HTTP request aborts from affecting the execution of those tasks. Sidekiq is a single process, with a configurable numbero of threads. By default, it is 5. That means, 5 different jobs can be executed at the same time. Others will be queued until they can be processed. - -While the amount of threads in the web process affects the responsiveness of the Mastodon instance to the end-user, the amount of threads allocated to background processing affects how quickly posts can be delivered from the author to anyone else, how soon e-mails are sent out, etc. - -The amount of threads is not controlled by an environment variable in this case, but a command line argument in the invocation of Sidekiq: - - bundle exec sidekiq -c 15 -q default -q mailers -q push - -Would start the sidekiq process with 15 threads. Please mind that each threads needs to be able to connect to the database, which means that the database pool needs to be large enough to support all the threads. The database pool size is controlled with the `DB_POOL` environment variable, and defaults to the value of `MAX_THREADS` (therefore, is 5 by default). - -You might notice that the above command specifies three queues to be processed: - -- "default" contains most tasks such as delivering messages to followers and processing incoming notifications from other instances -- "mailers" contains tasks that send e-mails -- "push" contains tasks that deliver messages to other instances - -If you wish, you could start three different processes for each queue, to ensure that even when there is a lot of tasks of one type, important tasks of other types still get executed in a timely manner. - -___ - -### How to set environment variables -#### With systemd - -In the `.service` file: - -```systemd -... -Environment="WEB_CONCURRENCY=1" -Environment="MAX_THREADS=5" -ExecStart="..." -... -``` - -Don't forget to `sudo systemctl daemon-reload` before restarting the services so that the changes would take effect! - -#### With docker-compose - -Edit `docker-compose.yml`: - -```yml -... - web: - restart: always - build: . - env_file: .env.production - environment: - - WEB_CONCURRENCY=1 - - MAX_THREADS=5 -... -``` - -Re-create the containers with `docker-compose up -d` for the changes to take effect. - -You can also scale the number of containers per "service" (where service is "web", "sidekiq" and "streaming"): - - docker-compose scale web=1 sidekiq=2 streaming=3 - -Realistically the `docker-compose.yml` file needs to be modified a bit further for the above to work, because by default it wants to bind the web container to host port 3000 and streaming container to host port 4000, of either of which there is only one on the host system. However, if you change: - -```yml -ports: - - "3000:3000" -``` - -to simply: - -```yml -ports: - - "3000" -``` - -for each service respectively, Docker will allocate random host ports of the services, allowing multiple containers to run alongside each other. But it will be on you to look up which host ports those are (e.g. with `docker ps`), and they will be different on each container restart. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Tuning-guide.md) diff --git a/docs/Running-Mastodon/Vagrant-guide.md b/docs/Running-Mastodon/Vagrant-guide.md index 83a892408..c5823b09b 100644 --- a/docs/Running-Mastodon/Vagrant-guide.md +++ b/docs/Running-Mastodon/Vagrant-guide.md @@ -1,66 +1 @@ -Vagrant guide -============= - -A quick way to get a development environment up and running is with Vagrant. You will need recent versions of [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) installed. - -## Basic setup - -Install the latest versions of Vagrant and VirtualBox for your operating systems, and then run: - - vagrant plugin install vagrant-hostsupdater - -This is optional, but will update your 'hosts' file when you start the virtual machine, allowing you to access the site at http://mastodon.dev (instead of http://localhost:3000). - -To create and provision a new virtual machine for Mastodon development: - - git clone git@github.com:tootsuite/mastodon.git - cd mastodon - vagrant up - -**Note:** On Linux hosts, you will need to [enable NFS support](https://www.vagrantup.com/docs/synced-folders/nfs.html). - -Running `vagrant up` for the first time will run provisioning, which will: - -- Download the Ubuntu 14.04 base image, if there isn't already a copy on your machine -- Create a new VirtualBox virtual machine from that image -- Run the provisioning script (located inside the Vagrantfile), which installs the system packages, Ruby gems, and JS modules required for Mastodon -- Run the startup script - -## Starting the server - -The Vagrant box will automatically start after provisioning. It can be started in future with `vagrant up` from the mastodon directory. - -Once the Ubuntu virtual machine has booted, it will run the startup script, which loads the environment variables from `.env.vagrant` and then runs `rails s -d -b 0.0.0.0`. This will start a Rails server. You can then access your development site at http://mastodon.dev (or at http://localhost:3000 if you haven't installed vagrants-hostupdater). By default, your development environment will have an admin account created for you to use - the email address will be `admin@mastodon.dev` and the password will be `mastodonadmin`. - -To stop the server, simply run `vagrant halt`. - -## Using the server - -You should now have a working Mastodon instance, although it will not federate, as it is not publicly accessible. Should you need temporary federation for development and testing, see the Ngrok information in the [Development Guide](Development-guide.md). - -By default, your instance's ActionMailer will use "Letter Opener Web" for email. This means that any email that would normally be sent, will instead be stored, and accessible at http://mastodon.dev/letter_opener - you can use this to verify a registered user account. - -## Making changes/developing - -You are able to set environment variables, which are used for Mastodon configuration, by editing the `.env.vagrant` file. Any changes you make will take effect after a Vagrant restart. - -Vagrant has mounted your mastodon folder inside the virtual machine. This means that any change to the files in the folder(e.g. the Rails controllers or the React components in /app) should immediately take effect on the live server. This allows you to make and test changes, and create new commits, without ever needing to access the virtual machine. - -Should you need to access the virtual machine (for example, to manually restart the Rails process without restarting the box), run `vagrant ssh` from the mastodon folder. You will now be logged in as the `vagrant` user on the VirtualBox Ubuntu VM. You will want to `cd /vagrant` to see the app folder. - -## Debugging - -You can find the Rails server logs in in the `log` folder, which will often have the information you need. - -If your Mastodon instance or Vagrant box are really not behaving, you can re-run the provisioning process. Stop the box with `vagrant halt`, and then run `vagrant destroy` - this will delete the virtual machine. You may then run `vagrant up` to create a new box, and re-run provisioning. - -## Testing - -To run the `rspec` tests and `rubocop` style checker, you may either: - -* Install the relevant gems locally, or -* SSH into the virtual machine, `cd /vagrant`, and then run the commands - -## Support/help - -If you are confused, or having any issues with the above, the Mastodon IRC channel ( irc.freenode.net #mastodon ) is a good place to find assistance. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Vagrant-guide.md) diff --git a/docs/Specs-and-RFCs-used.md b/docs/Specs-and-RFCs-used.md index 9bb1bb622..89a4dd313 100644 --- a/docs/Specs-and-RFCs-used.md +++ b/docs/Specs-and-RFCs-used.md @@ -1,12 +1 @@ -Specs and RFCs used -=================== - -* [OStatus](https://www.w3.org/community/ostatus/wiki/images/9/93/OStatus_1.0_Draft_2.pdf) -* [Salmon](http://www.salmon-protocol.org/salmon-protocol-summary) -* [Portable Contacts](https://web.archive.org/web/20160305010620/http://portablecontacts.net/draft-spec.html) -* [Atom](https://tools.ietf.org/html/rfc4287) -* [Atom ActivityStreams](http://activitystrea.ms/specs/atom/1.0/) -* [Atom Threading](https://tools.ietf.org/html/rfc4685) -* [PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html) -* [Webfinger](https://tools.ietf.org/html/rfc7033) -* [Link-based Resource Descriptor Discovery](https://tools.ietf.org/html/rfc6415) +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Specs-and-RFCs-used.md) diff --git a/docs/Using-Mastodon/2FA.md b/docs/Using-Mastodon/2FA.md index 663563a28..d5c6985b7 100644 --- a/docs/Using-Mastodon/2FA.md +++ b/docs/Using-Mastodon/2FA.md @@ -1,44 +1 @@ -# 2-Factor Authentication - -2-Factor Authentication is a security mechanism that requires you to enter a computer generated code from your phone every time you log into Mastodon. - -We highly recommend that you set up 2-factor authentication as it prevents malicious users from logging into your account if they obtain your password. - -## Warning - -If you lose access to your 2-factor authentication (such as by losing your phone or performing a factory reset) and you do cannot log in, you will not be able to access your account and will need to contact an instance admin to remove 2-factor authentication from your account. - -## Setup - -1. Open your [settings page](https://mastodon.social/settings/two_factor_auth) and navigate to the Two-factor Authentication page -2. Press the big blue "Enable" button that appears on the right  -3. Follow instructions below to install an authenticator for your smartphone - -## Android - -__Recommended Application:__ [Google -Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) - -4. Download the above application on your phone -5. Open the "Authenticator" app -6. Press the + button in the bottom right-hand corner -7. Press "Scan a barcode" -8. Line up the black and white QR code with the target box that appears on your camera -9. Now, whenever you log in to Mastodon, open the Authenticator app and enter the 6 digit code that appears above the "mastodon.social (email address)" text - -## iPhone - -__Recommended Application:__ iPhone: [Authenticator by Matt -Ruben](https://itunes.apple.com/us/app/authenticator/id766157276?mt=8) - -4. Download the above application on your phone -5. Open the "Authenticator" app -6. Press the + button in the bottom right-hand corner -7. Authenticator should prompt you for access to your camera- hit "OK" -8. Line up the black and white QR code with the target box that appears on your camera -9. Now, whenever you log in to Mastodon, open the Authenticator app and enter the 6 digit code that appears above the "mastodon.social (email address)" text - -# Disabling 2-factor Authentication - -1. Go to [the 2-factor authentication settings page](https://mastodon.social/settings/two_factor_auth) -2. Press the big blue "Disable" button underneath your QR code  +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/2FA.md) diff --git a/docs/Using-Mastodon/Apps.md b/docs/Using-Mastodon/Apps.md index ce3f2f1fc..c2ced4457 100644 --- a/docs/Using-Mastodon/Apps.md +++ b/docs/Using-Mastodon/Apps.md @@ -1,19 +1 @@ -List of apps -============ - -Some people have started working on apps for the Mastodon API. Here is a list of them: - -|App|Platform|Link|Developer(s)| -|---|--------|----|------------| -|[Tusky](https://play.google.com/store/apps/details?id=com.keylesspalace.tusky)|Android|<https://github.com/Vavassor/Tusky>|[@Vavassor@mastodon.social](https://mastodon.social/users/Vavassor)| -|mastodroid|Android|<https://github.com/alin-rautoiu/mastodroid>|[@charlag@mastodon.social](https://mastodon.social/users/charlag)| -|TootyFruity|Android|<https://play.google.com/store/apps/details?id=ch.kevinegli.tootyfruity221258>|[@eggplant@mastodon.social](https://mastodon.social/users/eggplant)| -|11t|iOS/Android|<https://github.com/jeroensmeets/mastodon-app>|[@jeroensmeets@mastodon.social](https://mastodon.social/users/jeroensmeets)| -|[Amaroq](https://itunes.apple.com/us/app/amarok-for-mastodon/id1214116200?ls=1&mt=8)|iOS|<https://itunes.apple.com/us/app/amarok-for-mastodon/id1214116200?ls=1&mt=8>|[@eurasierboy@mastodon.social](https://mastodon.social/users/eurasierboy)| -|Albatross|iOS||[@goldie_ice@mastodon.social](https://mastodon.social/users/goldie_ice)| -|Tooter|Chrome|<https://github.com/ineffyble/tooter>|[@effy@mastodon.social](https://mastodon.social/users/effy)| -|tootstream|CLI|<https://github.com/magicalraccoon/tootstream>|[@Raccoon@mastodon.social](https://mastodon.social/users/Raccoon)| -|HackerNewsBot|CLI|<https://github.com/raymestalez/mastodon-hnbot>|[@rayalez@hackertribe.io](https://hackertribe.io/users/rayalez)| -|Mastodon.tools|Wordpress, web browser, social network|<https://github.com/davidlibeau/mastodon-tools>|[@David@mastodon.xyz](https://mastodon.xyz/users/David)| - -If you have a project like this, let me know so I can add it to the list! +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md) diff --git a/docs/Using-Mastodon/FAQ.md b/docs/Using-Mastodon/FAQ.md index 3b03a8ee4..d50e63b93 100644 --- a/docs/Using-Mastodon/FAQ.md +++ b/docs/Using-Mastodon/FAQ.md @@ -1,44 +1 @@ -Frequently Asked Questions -========================== - -#### What is a Mastodon? - -A prehistoric animal, predecessor of the mammoth. - -#### Why the name Mastodon? - -There's a progressive metal band with the same name that I'm a fan of that brought the animal to my attention. I thought it's a pretty cool name/animal. - -#### How exactly is it decentralized? - -There are different ways in which something can be decentralized; in this case, Mastodon is the "federated" kind. Think e-mail, not BitTorrent. There are different servers (instances), users have an account on one of them, but can interact and follow each other regardless of where their account is. - -#### Technically, how does the federation work? - -We are using the OStatus suite of protocols: - -1. Webfinger for user-on-domain lookup -2. Atom feeds with ActivityStreams, Portable Contacts, Threads extensions for the actual content -3. PubSubHubbub for subscribing to Atom feeds -4. Salmon for delivering certain items from the Atom feeds to interested parties such as the mentioned user, author of the status being replied to, person being followed, etc - -#### What is mastodon.social? - -The "flagship" instance of Mastodon, aka the server I run myself with the latest code. It's not supposed to be the only instance in the end. - -#### What else is part of the federated network? - -Let's call it the "fediverse". It has existed for a longer while, populated by GNU social servers, Friendica, Hubzilla, Diaspora etc. Not every one of those servers is fully compatible with every other. Mastodon strives to be fully standards-compliant and compatibility with GNU social is higher in priority than the others. - -#### I tried logging into a GNU social client app with Mastodon and it didn't work, why? - -While Mastodon is compatible with GNU social in terms of server to server communication, the client to server API (aka how you access Mastodon) is different. Therefore, client apps that were made for specifically GNU social will not work with Mastodon. The reason for this is half technical, half ideological. - -Because Mastodon has been created from a blank slate, it is much simpler to have the API mirror internal structures as closely as possible, rather than build an emulation layer. Secondly, the GNU social client API is actually a half-way implementation of the legacy Twitter API - that's the reason why it works with some older Twitter client apps. However, many of those apps are not maintained anymore, the GNU social API does not actually keep up with the real Twitter API and never fully implemented all its features; at the same time, the Twitter API was never meant for a federated service and so obscures some of the functionality. - - -#### How is Mastodon funded? - -Development of Mastodon and hosting of mastodon.social is funded through my [Patreon (also BTC/PayPal donations)](https://www.patreon.com/user?u=619786). Beyond that, I am not interested in VC funding, monetizing, advertising, or anything of that sort. I could offer setup/maintenance services on demand. - -The software is free and open source and communities should host their own servers if they can, that way the costs are more or less distributed. Obviously it'd be hard for me to pay the bills if literally everyone decided to use the mastodon.social instance only. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md) diff --git a/docs/Using-Mastodon/List-of-Mastodon-instances.md b/docs/Using-Mastodon/List-of-Mastodon-instances.md index 49b2c2012..0e2d08643 100644 --- a/docs/Using-Mastodon/List-of-Mastodon-instances.md +++ b/docs/Using-Mastodon/List-of-Mastodon-instances.md @@ -1,82 +1 @@ -List of Known Mastodon instances -========================== - -There is also a list at [instances.mastodon.xyz](https://instances.mastodon.xyz) showing realtime information about instances. - -| Name | Theme/Notes, if applicable | Open Registrations | IPv6 | -| -------------|-------------|---|---| -| [mastodon.social](https://mastodon.social) |Flagship, quick updates|No|No| -| [securitymastod.one](https://securitymastod.one/) |Information security enthusiasts and pros|Yes|Yes| -| [mastodon.nuzgo.net](https://mastodon.nuzgo.net/) |Mastodon instance hosted in Paris |Yes|Yes| -| [mastodon.cx](https://mastodon.cx/) |Alternative Mastodon instance hosted in France|Yes|Yes| -| [mastodon.network](https://mastodon.network) |N/A|Yes|Yes| -| [awoo.space](https://awoo.space) |Intentionally moderated, only federates with mastodon.social|Yes|No| -| [animalliberation.social](https://animalliberation.social) |Animal Rights|Yes|No| -| [socially.constructed.space](https://socially.constructed.space) |Single user|No|No| -| [epiktistes.com](https://epiktistes.com) |N/A|Yes|No| -| [fern.surgeplay.com](https://fern.surgeplay.com) |Federates everywhere, Minecraft-focused|Yes|No -| [gay.crime.team](https://gay.crime.team) |the place for doin' gay crime online (please don't actually do crime here)|No|No| -| [icosahedron.website](https://icosahedron.website/) |Icosahedron-themed (well, visually), open registration.|Yes|No| -| [memetastic.space](https://memetastic.space) |Memes|Yes|No| -| [masto.razrnet.fr](https://masto.razrnet.fr) |Instance Française pour tout le monde ! Développeurs, gamers, etc...|Yes|No| -| [social.diskseven.com](https://social.diskseven.com) |Single user|No|Yes| -| [social.gestaltzerfall.net](https://social.gestaltzerfall.net) |Single user|No|No| -| [mastodon.xyz](https://mastodon.xyz) |N/A|Yes|Yes| -| [mastodon.land](https://mastodon.land) |N/A|Yes|Yes| -| [mastodon.partipirate.org](https://mastodon.partipirate.org) |French Pirate Party Instance - Politics and stuff|Yes|No| -| [social.targaryen.house](https://social.targaryen.house) |Federates everywhere, quick updates.|Yes|Yes| -| [masto.themimitoof.fr](https://masto.themimitoof.fr) |N/A|Yes|Yes| -| [mstdn.io](https://mstdn.io) |N/A|Yes|Yes| -| [social.imirhil.fr](https://social.imirhil.fr) |N/A|No|Yes| -| [social.wxcafe.net](https://social.wxcafe.net) |Open registrations, queer people, activists, safe as much as possible |Yes|Yes| -| [octodon.social](https://octodon.social) |Open registrations, federates everywhere, cutest instance yet|Yes|Yes| -| [mastodon.club](https://mastodon.club)|Open Registration, Open Federation, Mostly Canadians|Yes|No| -| [mastodon.irish](https://mastodon.irish)|Open Registration|Yes|No| -| [hostux.social](https://hostux.social) |N/A|Yes|Yes| -| [social.alex73630.xyz](https://social.alex73630.xyz) |Francophones|Yes|Yes| -| [oc.todon.fr](https://oc.todon.fr) |Modérée et principalement francophone, pas de tolérances pour misogynie/LGBTphobies/validisme/etc.|Yes|Yes| -| [maly.io](https://maly.io) |N/A|Yes|No| -| [social.lou.lt](https://social.lou.lt) |Francophones|Yes|No| -| [mastodon.ninetailed.uk](https://mastodon.ninetailed.uk) |Open registrations, furry-friendly, UK-based|Yes|No| -| [soc.louiz.org](https://soc.louiz.org) |"Coucou"|Yes|No| -| [7nw.eu](https://7nw.eu) |N/A|Yes|No| -| [mastodon.gougere.fr](https://mastodon.gougere.fr)|N/A|Yes|No| -| [aleph.land](https://aleph.land)|N/A|Yes|No| -| [share.elouworld.org](https://share.elouworld.org)|N/A|No|No| -| [social.lkw.tf](https://social.lkw.tf)|N/A|No|No| -| [manowar.social](https://manowar.social)|N/A|No|No| -| [social.ballpointcarrot.net](https://social.ballpointcarrot.net)|N/A|No|No| -| [social.nasqueron.org](https://social.nasqueron.org) |Dreamers, open source developers, free culture|Yes|Yes| -| [status.dissidence.ovh](https://status.dissidence.ovh)|N/A|Yes|Yes| -| [mastodon.cc](https://mastodon.cc)|Art|Yes|No| -| [mastodon.technology](https://mastodon.technology)|Open registrations, federates everywhere, for tech folks|Yes|No| -| [mastodon.systemlab.fr](https://mastodon.systemlab.fr/)|Le mastodon Français, informatique, jeux-vidéos, gaming et hébergement.|Yes| -| [mastodon.top](https://mastodon.top) |N/A|Yes|Yes| -| [niu.moe](https://niu.moe/)|:dolls: The most cutest node ever, FR/EN, anime and computer :balloon:|Yes|Yes| -| [im-in.space](https://im-in.space/)|SPAAAAACE! Probably with a lot of French people. (Invite-only, might randomly open registrations)|No|Yes| -| [social.bytestemplar.com](https://social.bytestemplar.com)|N/A|Yes|No| -| [digitalhumanities.club](http://www.digitalhumanities.club)|[Digital humanities](http://whatisdigitalhumanities.com) community; invitations will open once code of conduct drafted.|No|No -| [design.vu](https://design.vu)|— what's your design view‽|Yes|No| -| [masto.raildecake.fr](https://masto.raildecake.fr)|Hebergé chez un FAI associatif dans le sud de la france, grillons & pins en options|Yes|No| -| [good-dragon.com](https://good-dragon.com/)|Quick updates, Relaxed Moderation, Federates Everywhere, Furries|Yes|No| -| [rich.gop](https://rich.gop/)|Federates everywhere, Open registration, Privacy respected|Yes|Yes| -| [social.nowa.re](https://social.nowa.re)|Open Registration|Yes|No| -| [mastodon.ml](http://mastodon.ml) |A chill place to hangout and chat about anime, programming and movies.|Yes|Yes| -| [off-the-clock.us](https://off-the-clock.us/)|The work day is over.|Yes|No| -| [infinimatix.net](https://infinimatix.net)|Informatics|Yes|Yes| -| [social.0day.agency](https://social.0day.agency)|Infosec, Hacking, Fun (only protonmail)|Yes|Yes| -| [kagrumez.lerk.io](https://kagrumez.lerk.io)|Open registration. German end english.|Yes|No| -| [meow.social](https://meow.social)|A furry fandom focused instance|Yes|No| -| [neumastodon.com](https://neumastodon.com/)|Northeastern University Mastodon |Yes|No| -| [dancingbanana.party](https://dancingbanana.party)|La banane qui danse.|Yes|No| -| [mastodon.brussels](https://mastodon.brussels/)|Le mastodon pour les belges, si vous aimez la bonne ambiance venez nous rejoindre !|Yes|Yes| -| [mastodon.llamasweet.tech](https://mastodon.llamasweet.tech/)|Mastodon about Android developement|Yes|No| -| [manx.social](https://manx.social/)|Instance for the Isle of Man|Yes|Yes| -| [mastodon.host](https://mastodon.host/)|Lightly moderated, federates everywhere and has a follow bot ( Huge federated timeline )|Yes|No| -| [mastodon.fun](https://mastodon.fun/)|Mastodon for everyone ! |Yes|Yes| -| [oulipo.social](https://oulipo.social/)|An Oulipo Mastodon in which that fifth symbol in Latin script is taboo|Yes|No| -| [indigo.zone](https://indigo.zone)|Open Registrations, General Purpose|Yes|No| -| [mastodon.cloud](https://mastodon.cloud)|An open Mastodon instance with people from all around the world|Yes|Yes| -| [mst3k.interlinked.me](https://mst3k.interlinked.me)|Open registrations, general purpose|Yes|Yes| - -We are no longer maintaining this list as instances are popping up too quickly for using GitHub to be a tenable system for tracking them. Please standby while we work on another solution +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md) diff --git a/docs/Using-Mastodon/User-guide.md b/docs/Using-Mastodon/User-guide.md index e456de29d..7ef5a117b 100644 --- a/docs/Using-Mastodon/User-guide.md +++ b/docs/Using-Mastodon/User-guide.md @@ -1,206 +1 @@ -Mastodon User's Guide -===================== - -* [Intro](User-guide.md#intro) - * [Decentralization and Federation](User-guide.md#decentralization-and-federation) -* [Getting Started](User-guide.md#getting-started) - * [Setting Up Your Profile](User-guide.md#setting-up-your-profile) - * [E-Mail Notifications](User-guide.md#e-mail-notifications) - * [Text Posts](User-guide.md#text-posts) - * [Content Warnings](User-guide.md#content-warnings) - * [Hashtags](User-guide.md#hashtags) - * [Boosts and Favourites](User-guide.md#boosts-and-favourites) - * [Posting Images](User-guide.md#posting-images) - * [Following Other Users](User-guide.md#following-other-users) - * [Notifications](User-guide.md#notifications) - * [Mobile Apps](User-guide.md#mobile-apps) - * [The Federated Timeline](User-guide.md#the-federated-timeline) - * [The Local Timeline](User-guide.md#the-local-timeline) - * [Searching](User-guide.md#searching) -* [Privacy, Safety and Security](User-guide.md#privacy-safety-and-security) - * [Two-Factor Authentication](User-guide.md#two-factor-authentication) - * [Account Privacy](User-guide.md#account-privacy) - * [Toot Privacy](User-guide.md#toot-privacy) - * [Blocking](User-guide.md#blocking) - * [Reporting Toots or Users](User-guide.md#reporting-toots-or-users) - -## Intro - -Mastodon is a social network application based on the OStatus protocol. It behaves a lot like other social networks, especially Twitter, with one key difference - it is open-source and anyone can start their own server (also called an "*instance*"), and users of any instance can interact freely with those of other instances (called "*federation*"). Thus, it is possible for small communities to set up their own servers to use amongst themselves while also allowing interaction with other communities. - -#### Decentralization and Federation - -Mastodon is a system decentralized through a concept called "*federation*" - rather than depending on a single person or organization to run its infrastructure, anyone can download and run the software and run their own server. Federation means different Mastodon servers can interact with each other seamlessly, similar to e.g. e-mail. - -As such, anyone can download Mastodon and e.g. run it for a small community of people, but any user registered on that instance can follow, send, and read posts from other Mastodon instances (as well as servers running other OStatus-compatible services, such as GNU Social and postActiv). This means that not only is users' data not inherently owned by a company with an interest in selling it to advertisers, but also that if any given server shuts down its users can set up a new one or migrate to another instance, rather than the entire service being lost. - -Within each Mastodon instance, usernames just appear as `@username`, similar to other services such as Twitter. Users from other instances appear, and can be searched for and followed, as `@user@servername.ext` - so e.g. `@gargron` on the `mastodon.social` instance can be followed from other instances as `@gargron@mastodon.social`). - -Posts from users on external instances are "*federated*" into the local one, i.e. if `user1@mastodon1` follows `user2@gnusocial2`, any posts `user2@gnusocial2` makes appear in both `user1@mastodon1`'s Home feed and the public timeline on the `mastodon1` server. Mastodon server administrators have some control over this and can exclude users' posts from appearing on the public timeline; post privacy settings from users on Mastodon instances also affect this, see below in the [Toot Privacy](User-guide.md#toot-privacy) section. - -## Getting Started - -#### Setting Up Your Profile - -You can customise your Mastodon profile in a number of ways - you can set a custom "display" name, a profile "avatar" picture, a background image for your profile page header, and a short "bio" that summarises you or your account. - - To edit your profile, click the Preferences icon in the Compose column and select "Edit Profile" on the left-hand menu on the Preferences page. Your display name is limited to 30 characters, your bio to 160. Avatars and header pictures can be uploaded as png, gif or jpg images and cannot be larger than 2MB. They will be resized to standard sizes - 120x120 pixels for avatars, 700x335 pixels for header pictures. - -#### E-Mail Notifications - - Mastodon can notify you of activity via e-mail if you so choose. To adjust your settings for receiving e-mail notifications, click the Preferences icon in the Compose column and select the "Preferences" page from the left-hand menu. Here you will find a number of checkboxes to enable or disable e-mail notifications for various types of activity. - -#### Text Posts - -The most basic way to interact with Mastodon is to make a text post, also called a *Toot*. In order to toot, simply enter the message you want to post into the "What is on your mind?" text box in the Compose column and click "TOOT". There is a limit of up to 500 characters per toot; if you really do need more than this you can reply to your own toots so they will appear like a conversation. - -If you want to reply to another user's toot, you can click the "Reply" icon on it. This will add their username to your input box along with a preview of the message you're replying to, and the user will receive a notification of your response. - -Similarly, in order to start a conversation with another user, just mention their user name in your toot. When you type the @ symbol followed directly (without a space) by any character in a message, Mastodon will automatically start suggesting users that match the username you're typing. Like with replies, mentioning a user like this will send them a notification. If the post starts with a mention, it will be treated as a reply and will only appear in the Home timelines of users who follow both you and the user you are mentioning. It will still be visible on your profile depending on privacy settings. - -##### Content Warnings - -When you want to post something that you don't want to be immediately visible - for example, spoilers for that film that's just come out, or some personal thoughts that mention potentially upsetting topics, you can "hide" it behind a Content Warning. - -To do this, click the  "CW" switch under the Compose box. This will add another text box labeled "Content warning"; you should enter a short summary of what the "body" of your post contains here while your actual post goes into the "What is on your mind?" box as normal. - - - -This will cause the body of your post to be hidden behind a "Show More" button in the timeline, with only the content warning and any mentioned users visible by default: - - - -**NOTE** that this will not hide images included in your post - images can be marked as "sensitive" separately to hide them from view until clicked on. To find out how to do this, see the [Posting Images](User-guide.md#posting-images) section of this user guide. - -##### Hashtags - -If you're making a post belonging to a wider subject, it might be worth adding a "hashtag" to it. This can be done simply by writing in the post a # sign followed by a phrase, e.g. #introductions (which is popular on mastodon.social for new users to introduce themselves to the community), or #politics for political discussions, etc. Clicking on a hashtag in a toot will show a timeline consisting only of public posts that include this hashtag (i.e. it's a shortcut to searching for it). This allows users to group messages of similar subjects together, forming a separate "timeline" for people interested in that subject. Hashtags can also be searched for from the search bar above the compose box. - -##### Boosts and Favourites - -You can *favourite* another user's toot by clicking the star icon underneath. This will send the user a notification that you have marked their post as a favourite; the meaning of this varies widely by context from a general "I'm listening" to signalling agreement or offering support for the ideas expressed. - -Additionally you can *boost* toots by clicking the "circular arrows" icon. Boosting a toot will show it on your profile timeline and make it appear to all your followers, even if they aren't following the user who made the original post. This is helpful if someone posts a message you think others should see, as it increases the message's reach while keeping the author information intact. - -#### Posting Images - - In order to post an image, simply click or tap the "image" icon in your Compose column and select a file to upload. - -If the image is "not safe for work" or has otherwise sensitive content, you can select the  "NSFW" button which appears once you have added an image. This will hide the image in your post by default, making it clickable to show the preview. This is the "visual" version of [content warnings](User-guide.md#content-warnings) and could be combined with them if there is text to accompany the image - otherwise it's fine to just mark the image as sensitive and make the body of your post the content warning. - -You can also attach video files or GIF animations to Toots. However, there is a 4MB file size limit for these files and videos must be in .webm or .mp4 format. - -#### Following Other Users - -Following another user will make all of their toots as well as other users' toots which they [boost](User-guide.md#boosts-and-favourites) appear in your Home column. This gives you a separate timeline from the [public timelines](User-guide.md#the-public-timelines) in which you can read what particular people are up to without the noise of general conversation. - - In order to follow a user, click their name or avatar to open their profile, then click the Follow icon in the top left of their profile view. - -If their account has a padlock icon  next to their user name, they will receive a notification of your request to follow them and they will need to approve this before you are added to their follower list (and thus see their toots). To show you that you are waiting for someone to approve your follow request, the Follow icon  on their profile will be replaced with an hourglass icon . The requirement for new followers to be approved is something you can enable for your own profile under preferences. - -Once you follow a user, the Follow icon will be highlighted in blue on their profile ; you can unfollow them again by clicking this. - -If you know someone's user name you can also open their profile for following by entering it in the [Search box](User-guide.md#searching) in the Compose column. This also works for remote users, though depending on whether they are known to your home instance you might have to enter their full name including the domain (e.g. `gargron@mastodon.social`) into the search box before their profile will appear in the suggestions. - -Alternately, if you already have a user's profile open in a separate browser tab, most OStatus-related networks should have a "Follow" or "Subscribe" button on their profile page. This will ask you to enter the full user name to follow **from** (ie. if your account is on mastodon.social you would want to enter this as `myaccount@mastodon.social`) - -#### Notifications - -When someone follows your account or requests to follow you, mentions your user name, or boosts or favourites one of your toots, you will receive a notification for this. These will appear as desktop notifications on your computer (if your web browser supports this and you've enabled them) as well as in your "Notifications" column. - - You can filter what kind of notifications you see in the Notifications column by clicking the Notification Settings icon at the top of the column and ticking or un-ticking what you do or don't want to see notifications for. - - If your notifications become cluttered, you can clear the column by clicking the Clear icon at the top of the column; this will wipe its contents. - - You can also disable notifications from people you don't follow or who don't follow you entirely - to do this, click the Preferences icon in the Compose column, select "Preferences" on the left-hand menu and check either of the respective "Block notifications" options. - -#### Mobile Apps - -Mastodon has an open API, so anyone can develop a client or app to use Mastodon from anything. Many people have already developed mobile apps for iOS and Android. You can find a list of these [here](Apps.md). Many of these projects are also open source and welcome collaborators. - -#### The Public Timelines - -In addition to your Home timeline, there are two public timelines available. The Federated Timeline and the Local Timeline. These are both a good way to meet new people to follow or interact with. - -##### The Federated Timeline - -The Federated Timeline shows all public posts from all users "known" to your instance. This means the user is either on the same instance as you, or somebody on your instance follows that user. The Federated Timeline is a great way to engage in the broad chatter of the world. Following users on remote instances who you meet on the Federated Timeline can lead to meeting more users on more instances and further connecting your instance to more and more of the entire Mastodon and OStatus network. - - To view the federated timeline, click the "Federated Timeline" icon in your Compose column or the respective button on the Getting Started panel. To hide the federated timeline again, simply click the "Back" link at the top of the column while you're viewing it. - -#### The Local Timeline - -The Local Timeline only shows public posts made by users on your home instance. This can be useful if your instance has particular community norms that users on other instances may not have, such as particular topics that get put under content warnings; or particular in-jokes and shared interests. To view the Local Timeline, click the  Menu icon on the Compose pane and then select "Local Timeline" on the rightmost column. - -#### Searching - -Mastodon has a search function - you can use it to search for users and [hashtags](User-guide.md#hashtags). The search does not look through the entire text of posts, only hashtags. In order to start a search, just type into the search box in the Compose column and hit *enter*; This will open the search pane. The search pane will show suggestions as you type. Selecting any of these will open the user's profile or a view of all toots on the hashtag. - -## Privacy, Safety and Security - -Mastodon has a number of advanced security, privacy and safety features over more public networks such as Twitter. Particularly the privacy controls are fairly granular; this section will explain how these features work. - -#### Two-Factor Authentication - -Two-Factor Authentication (2FA) is a mechanism that improves the security of your Mastodon account by requiring a numeric code from another device (most commonly mobile phones) linked to your Mastodon account when you log in - this means that even if someone gets hold of both your e-mail address and your password, they cannot take over your Mastodon account as they would need a physical device you own to log in. - -Mastodon's 2FA uses Google Authenticator (or compatible apps, such as Authy). You can install this for free to your [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) or [iOS](https://itunes.apple.com/gb/app/google-authenticator/id388497605) device; [this Wikipedia page](https://en.wikipedia.org/wiki/Google_Authenticator#Implementations) lists further versions of the app for other systems. - - In order to enable 2FA for your Mastodon account, click the Preferences icon in the Compose column, click "Two-factor Authentication" in the left menu on the settings page and follow the instructions. Once activated, every time you log in you will need a one-time code generated by the Authenticator app on the device you've linked to your account. - -#### Account Privacy - -To allow you more control over who can see your toots, Mastodon supports "private" or "locked" accounts. If your account is set to private, you will be notified every time someone tries to follow you, and you will be able to allow or deny the follow request. Additionally, if your account is private, any new toots you compose will default to being private (see the [Toot Privacy](User-guide.md#toot-privacy) section below). - - To make your account private, click the Preferences icon in the Compose pane, select "Edit Profile" and tick the "Make account private" checkbox, then click "Save Changes". - - - -#### Toot Privacy - -Toot privacy is handled independently of account privacy, and individually for each toot. The four tiers of visibility for toots are Public (default), Unlisted, Private, and Direct. In order to select your privacy level, click the  globe icon. Changes to this setting are remembered between posts, i.e. if you make one private toot, each toot you make will be private until you change it back to public. You can change your default post privacy under preferences. - -**Public** is the default status of toots on most accounts. Public toots are visible to any other user on the public timelines, federate to other Mastodon and OStatus instances without restriction, and appear on your user profile page to anyone including search engine bots and visitors who aren't logged into a Mastodon account. - -**Unlisted** toots are public, except that they do not appear in the public timelines or search results. They are visible to anyone following you and appear on your profile page to the public even without a Mastodon login. Other than not appearing in the public timelines or search results, they function identically to public posts. - -**Private** toots do not appear in the public timeline nor on your profile page to anyone viewing it unless they are on your Followers list. The option is of limited use if your account is not also set to require approval of new followers (as anyone can follow you without confirmation and thus see your private toots). However the separation of this means that if you *do* set your entire account to private, you can switch this option off on a toot to make unlisted or even public toots from your otherwise private account. - -Private toots cannot be boosted. If someone you follow makes a private toot, it will appear in your timeline with a padlock icon in place of the Boost icon. **NOTE** that remote instances may not respect this. - -Private toots do not federate to other instances, unless you @mention a remote user. In this case, they will federate to their instance, and users on that instance who follow both you and the @mentioned user will see it in their Home timelines. There is no reliable way to check if an instance will actually respect post privacy. Non-Mastodon servers, such as a GNU Social server, do not support Mastodon privacy settings. A user on GNU Social who you @mention in a private post would not even be aware that the post is intended to be private and would be able to boost it, which would undo the privacy setting. There is also no way to guarantee that someone could not just modify the code on their particular Mastodon instance to not respect private post restrictions. A warning will be displayed if you're composing a private toot that will federate to another instance. You should thus think through how much you trust the user you are @mentioning and the instance they are on. - -Private posts are not encrypted. Make sure you trust your instance admin not to just read your private posts on the back-end. Do not say anything you would not want potentially intercepted. - -**Direct** posts are only visible to users you have @mentioned in them and cannot be boosted. Like with private posts, you should be mindful that the remote instance may not respect this protocol. If you are discussing a sensitive matter you should move the conversation off of Mastodon. - -To summarise: - -Toot Privacy | Visible on Profile | Visible on Public Timeline | Federates to other instances ------------- | ------------------ | -------------------------- | --------------------------- -Public | Anyone incl. anonymous viewers | Yes | Yes -Unlisted | Anyone incl. anonymous viewers | No | Yes -Private | Followers only | No | Only remote @mentions -Direct | No | No | Only remote @mentions - -#### Blocking - -You can block a user to stop them contacting you. To do this, you can click or tap the Menu icon on either a toot of theirs or their profile view and select "Block". - -**NOTE** that this will stop them from seeing your public toots while they are logged in, but they *will* be able to see your public toots by simply opening your profile in another browser that isn't logged into Mastodon (or logged into a different account that you have not blocked). - -Mentions, favourites, boosts or any other interaction with you from a blocked user will be hidden from your view. You will not see replies to a blocked person, even if the reply mentions you, nor will you see their toots if someone boosts them. - -The blocked user will not be notified of your blocking them. They will be removed from your followers. - -#### Muting - -If you do not wish to see posts from a particular user, but do not care about if they see your posts, you may choose to *mute* them. You can mute a user from the same menu on their profile page that you would block them from. You will not see posts from a muted user unless they @mention you. A muted user will have no way to know that you have them muted. - -#### Reporting Toots or Users - -If you encounter a toot or a user that is breaking the rules of your instance or that you otherwise want to draw the instance administrators' attention to (e.g. if someone is harassing another user, spamming pornography or posting illegal content), you can click the "..." menu button on the toot or the "hamburger" menu on the profile and select to report this. The rightmost column will then switch over to the following form: - - - -In this form, you can select any toots you would like to report to the instance administrators and fill in any comment that might be helpful in identifying or handling the issue (from "is a spammer" to "this post contains untagged pornography"). The report will be visible to server administrators once it is sent so they can take appropriate action, for example hiding the user's posts from the public timeline or banning their account. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/User-guide.md) diff --git a/docs/Using-Mastodon/screenshots/2fa/disable.png b/docs/Using-Mastodon/screenshots/2fa/disable.png deleted file mode 100644 index f008c27b3..000000000 --- a/docs/Using-Mastodon/screenshots/2fa/disable.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/2fa/enable.png b/docs/Using-Mastodon/screenshots/2fa/enable.png deleted file mode 100644 index ea82a0afd..000000000 --- a/docs/Using-Mastodon/screenshots/2fa/enable.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/compose-cw.png b/docs/Using-Mastodon/screenshots/compose-cw.png deleted file mode 100644 index 584080a53..000000000 --- a/docs/Using-Mastodon/screenshots/compose-cw.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/compose-media.png b/docs/Using-Mastodon/screenshots/compose-media.png deleted file mode 100644 index 7a63c196c..000000000 --- a/docs/Using-Mastodon/screenshots/compose-media.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/compose-nsfw.png b/docs/Using-Mastodon/screenshots/compose-nsfw.png deleted file mode 100644 index a4ff5ed7b..000000000 --- a/docs/Using-Mastodon/screenshots/compose-nsfw.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/compose-privacy.png b/docs/Using-Mastodon/screenshots/compose-privacy.png deleted file mode 100644 index b18ed2043..000000000 --- a/docs/Using-Mastodon/screenshots/compose-privacy.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/content-warning.gif b/docs/Using-Mastodon/screenshots/content-warning.gif deleted file mode 100644 index 2e4720618..000000000 --- a/docs/Using-Mastodon/screenshots/content-warning.gif +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/cw-toot.gif b/docs/Using-Mastodon/screenshots/cw-toot.gif deleted file mode 100644 index 5329933a6..000000000 --- a/docs/Using-Mastodon/screenshots/cw-toot.gif +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/federated-timeline.png b/docs/Using-Mastodon/screenshots/federated-timeline.png deleted file mode 100644 index d74b089fd..000000000 --- a/docs/Using-Mastodon/screenshots/federated-timeline.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/follow-icon.png b/docs/Using-Mastodon/screenshots/follow-icon.png deleted file mode 100644 index ee516c2f5..000000000 --- a/docs/Using-Mastodon/screenshots/follow-icon.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/following-icon.png b/docs/Using-Mastodon/screenshots/following-icon.png deleted file mode 100644 index bccdc110e..000000000 --- a/docs/Using-Mastodon/screenshots/following-icon.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/locked-icon.png b/docs/Using-Mastodon/screenshots/locked-icon.png deleted file mode 100644 index d199f1f12..000000000 --- a/docs/Using-Mastodon/screenshots/locked-icon.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/notifications-clear.png b/docs/Using-Mastodon/screenshots/notifications-clear.png deleted file mode 100644 index 7d0922ccb..000000000 --- a/docs/Using-Mastodon/screenshots/notifications-clear.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/notifications-settings.png b/docs/Using-Mastodon/screenshots/notifications-settings.png deleted file mode 100644 index 3a3417e7d..000000000 --- a/docs/Using-Mastodon/screenshots/notifications-settings.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/pending-icon.png b/docs/Using-Mastodon/screenshots/pending-icon.png deleted file mode 100644 index 777b3c391..000000000 --- a/docs/Using-Mastodon/screenshots/pending-icon.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/preferences.png b/docs/Using-Mastodon/screenshots/preferences.png deleted file mode 100644 index 943413feb..000000000 --- a/docs/Using-Mastodon/screenshots/preferences.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/private.png b/docs/Using-Mastodon/screenshots/private.png deleted file mode 100644 index cf338aad0..000000000 --- a/docs/Using-Mastodon/screenshots/private.png +++ /dev/null Binary files differdiff --git a/docs/Using-Mastodon/screenshots/report.png b/docs/Using-Mastodon/screenshots/report.png deleted file mode 100644 index 5ce401ee7..000000000 --- a/docs/Using-Mastodon/screenshots/report.png +++ /dev/null Binary files differdiff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md index fee1fde94..6de61e196 100644 --- a/docs/Using-the-API/API.md +++ b/docs/Using-the-API/API.md @@ -1,535 +1 @@ -API overview -============ - -## Contents - -- [Available libraries](#available-libraries) -- [Notes](#notes) -- [Methods](#methods) - - [Accounts](#accounts) - - [Apps](#apps) - - [Blocks](#blocks) - - [Favourites](#favourites) - - [Follow Requests](#follow-requests) - - [Follows](#follows) - - [Instances](#instances) - - [Media](#media) - - [Mutes](#mutes) - - [Notifications](#notifications) - - [Reports](#reports) - - [Search](#search) - - [Statuses](#statuses) - - [Timelines](#timelines) -- [Entities](#entities) - - [Account](#account) - - [Application](#application) - - [Attachment](#attachment) - - [Card](#card) - - [Context](#context) - - [Error](#error) - - [Instance](#instance) - - [Mention](#mention) - - [Notification](#notification) - - [Relationship](#relationship) - - [Results](#results) - - [Status](#status) - - [Tag](#tag) - -___ - -## Available libraries - -- [For Ruby](https://github.com/tootsuite/mastodon-api) -- [For Python](https://github.com/halcy/Mastodon.py) -- [For JavaScript](https://github.com/Zatnosk/libodonjs) -- [For JavaScript (Node.js)](https://github.com/jessicahayley/node-mastodon) -- [For Elixir](https://github.com/milmazz/hunter) - -___ - -## Notes - -### Parameter types - -When an array parameter is mentioned, the Rails convention of specifying array parameters in query strings is meant. -For example, a ruby array like `foo = [1, 2, 3]` can be encoded in the params as `foo[]=1&foo[]=2&foo[]=3`. -Square brackets can be indexed but can also be empty. - -When a file parameter is mentioned, a form-encoded upload is expected. - -### Selecting ranges - -For most `GET` operations that return arrays, the query parameters `max_id` and `since_id` can be used to specify the range of IDs to return. -API methods that return collections of items can return a `Link` header containing URLs for the `next` and `prev` pages. -See the [Link header RFC](https://tools.ietf.org/html/rfc5988) for more information. - -### Errors - -If the request you make doesn't go through, Mastodon will usually respond with an [Error](#error). - -___ - -## Methods - -### Accounts - -#### Fetching an account: - - GET /api/v1/accounts/:id - -Returns an [Account](#account). - -#### Getting the current user: - - GET /api/v1/accounts/verify_credentials - -Returns the authenticated user's [Account](#account). - -#### Updating the current user: - - PATCH /api/v1/accounts/update_credentials - -Form data: - -- `display_name`: The name to display in the user's profile -- `note`: A new biography for the user -- `avatar`: A base64 encoded image to display as the user's avatar (e.g. `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAADrCAYAAAA...`) -- `header`: A base64 encoded image to display as the user's header image (e.g. `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAADrCAYAAAA...`) - -#### Getting an account's followers: - - GET /api/v1/accounts/:id/followers - -Returns an array of [Accounts](#account). - -#### Getting who account is following: - - GET /api/v1/accounts/:id/following - -Returns an array of [Accounts](#account). - -#### Getting an account's statuses: - - GET /api/v1/accounts/:id/statuses - -Query parameters: - -- `only_media` (optional): Only return statuses that have media attachments -- `exclude_replies` (optional): Skip statuses that reply to other statuses - -Returns an array of [Statuses](#status). - -#### Following/unfollowing an account: - - GET /api/v1/accounts/:id/follow - GET /api/v1/accounts/:id/unfollow - -Returns the target [Account](#account). - -#### Blocking/unblocking an account: - - GET /api/v1/accounts/:id/block - GET /api/v1/accounts/:id/unblock - -Returns the target [Account](#account). - -#### Muting/unmuting an account: - - GET /api/v1/accounts/:id/mute - GET /api/v1/accounts/:id/unmute - -Returns the target [Account](#account). - -#### Getting an account's relationships: - - GET /api/v1/accounts/relationships - -Query parameters: - -- `id` (can be array): Account IDs - -Returns an array of [Relationships](#relationships) of the current user to a list of given accounts. - -#### Searching for accounts: - - GET /api/v1/accounts/search - -Query parameters: - -- `q`: What to search for -- `limit`: Maximum number of matching accounts to return (default: `40`) - -Returns an array of matching [Accounts](#accounts). -Will lookup an account remotely if the search term is in the `username@domain` format and not yet in the database. - -### Apps - -#### Registering an application: - - POST /api/v1/apps - -Form data: - -- `client_name`: Name of your application -- `redirect_uris`: Where the user should be redirected after authorization (for no redirect, use `urn:ietf:wg:oauth:2.0:oob`) -- `scopes`: This can be a space-separated list of the following items: "read", "write" and "follow" (see [this page](OAuth-details.md) for details on what the scopes do) -- `website`: (optional) URL to the homepage of your app - -Creates a new OAuth app. -Returns `id`, `client_id` and `client_secret` which can be used with [OAuth authentication in your 3rd party app](Testing-with-cURL.md). - -These values should be requested in the app itself from the API for each new app install + mastodon domain combo, and stored in the app for future requests. - -### Blocks - -#### Fetching a user's blocks: - - GET /api/v1/blocks - -Returns an array of [Accounts](#account) blocked by the authenticated user. - -### Favourites - -#### Fetching a user's favourites: - - GET /api/v1/favourites - -Returns an array of [Statuses](#status) favourited by the authenticated user. - -### Follow Requests - -#### Fetching a list of follow requests: - - GET /api/v1/follow_requests - -Returns an array of [Accounts](#account) which have requested to follow the authenticated user. - -#### Authorizing or rejecting follow requests: - - POST /api/v1/follow_requests/authorize - POST /api/v1/follow_requests/reject - -Form data: - -- `id`: The id of the account to authorize or reject - -Returns an empty object. - -### Follows - -#### Following a remote user: - - POST /api/v1/follows - -Form data: - -- `uri`: `username@domain` of the person you want to follow - -Returns the local representation of the followed account, as an [Account](#account). - -### Instances - -#### Getting instance information: - - GET /api/v1/instance - -Returns the current [Instance](#instance). -Does not require authentication. - -### Media - -#### Uploading a media attachment: - - POST /api/v1/media - -Form data: - -- `file`: Media to be uploaded - -Returns an [Attachment](#attachment) that can be used when creating a status. - -### Mutes - -#### Fetching a user's mutes: - - GET /api/v1/mutes - -Returns an array of [Accounts](#account) muted by the authenticated user. - -### Notifications - -#### Fetching a user's notifications: - - GET /api/v1/notifications - -Returns a list of [Notifications](#notification) for the authenticated user. - -#### Getting a single notification: - - GET /api/v1/notifications/:id - -Returns the [Notification](#notification). - -#### Clearing notifications: - - POST /api/v1/notifications/clear - -Deletes all notifications from the Mastodon server for the authenticated user. -Returns an empty object. - -### Reports - -#### Fetching a user's reports: - - GET /api/v1/reports - -Returns a list of [Reports](#report) made by the authenticated user. - -#### Reporting a user: - - POST /api/v1/reports - -Form data: - -- `account_id`: The ID of the account to report -- `status_ids`: The IDs of statuses to report (can be an array) -- `comment`: A comment to associate with the report. - -Returns the finished [Report](#report). - -### Search - -#### Searching for content: - - GET /api/v1/search - -Form data: - -- `q`: The search query -- `resolve`: Whether to resolve non-local accounts - -Returns [Results](#results). -If `q` is a URL, Mastodon will attempt to fetch the provided account or status. -Otherwise, it will do a local account and hashtag search. - -### Statuses - -#### Fetching a status: - - GET /api/v1/statuses/:id - -Returns a [Status](#status). - -#### Getting status context: - - GET /api/v1/statuses/:id/context - -Returns a [Context](#context). - -#### Getting a card associated with a status: - - GET /api/v1/statuses/:id/card - -Returns a [Card](#card). - -#### Getting who reblogged/favourited a status: - - GET /api/v1/statuses/:id/reblogged_by - GET /api/v1/statuses/:id/favourited_by - -Returns an array of [Accounts](#account). - -#### Posting a new status: - - POST /api/v1/statuses - -Form data: - -- `status`: The text of the status -- `in_reply_to_id` (optional): local ID of the status you want to reply to -- `media_ids` (optional): array of media IDs to attach to the status (maximum 4) -- `sensitive` (optional): set this to mark the media of the status as NSFW -- `spoiler_text` (optional): text to be shown as a warning before the actual content -- `visibility` (optional): either "direct", "private", "unlisted" or "public" - -Returns the new [Status](#status). - -#### Deleting a status: - - DELETE /api/v1/statuses/:id - -Returns an empty object. - -#### Reblogging/unreblogging a status: - - POST /api/v1/statuses/:id/reblog - POST /api/v1/statuses/:id/unreblog - -Returns the target [Status](#status). - -#### Favouriting/unfavouriting a status: - - POST /api/v1/statuses/:id/favourite - POST /api/v1/statuses/:id/unfavourite - -Returns the target [Status](#status). - -### Timelines - -#### Retrieving a timeline: - - GET /api/v1/timelines/home - GET /api/v1/timelines/public - GET /api/v1/timelines/tag/:hashtag - -Query parameters: - -- `local` (optional; public and tag timelines only): Only return statuses originating from this instance - -Returns an array of [Statuses](#status), most recent ones first. -___ - -## Entities - -### Account - -| Attribute | Description | -| ------------------------ | ----------- | -| `id` | The ID of the account | -| `username` | The username of the account | -| `acct` | Equals `username` for local users, includes `@domain` for remote ones | -| `display_name` | The account's display name | -| `note` | Biography of user | -| `url` | URL of the user's profile page (can be remote) | -| `avatar` | URL to the avatar image | -| `header` | URL to the header image | -| `locked` | Boolean for when the account cannot be followed without waiting for approval first | -| `created_at` | The time the account was created | -| `followers_count` | The number of followers for the account | -| `following_count` | The number of accounts the given account is following | -| `statuses_count` | The number of statuses the account has made | - -### Application - -| Attribute | Description | -| ------------------------ | ----------- | -| `name` | Name of the app | -| `website` | Homepage URL of the app | - -### Attachment - -| Attribute | Description | -| ------------------------ | ----------- | -| `id` | ID of the attachment | -| `type` | One of: "image", "video", "gifv" | -| `url` | URL of the locally hosted version of the image | -| `remote_url` | For remote images, the remote URL of the original image | -| `preview_url` | URL of the preview image | -| `text_url` | Shorter URL for the image, for insertion into text (only present on local images) | - -### Card - -| Attribute | Description | -| ------------------------ | ----------- | -| `url` | The url associated with the card | -| `title` | The title of the card | -| `description` | The card description | -| `image` | The image associated with the card, if any | - -### Context - -| Attribute | Description | -| ------------------------ | ----------- | -| `ancestors` | The ancestors of the status in the conversation, as a list of [Statuses](#status) | -| `descendants` | The descendants of the status in the conversation, as a list of [Statuses](#status) | - -### Error - -| Attribute | Description | -| ------------------------ | ----------- | -| `error` | A textual description of the error | - -### Instance - -| Attribute | Description | -| ------------------------ | ----------- | -| `uri` | URI of the current instance | -| `title` | The instance's title | -| `description` | A description for the instance | -| `email` | An email address which can be used to contact the instance administrator | - -### Mention - -| Attribute | Description | -| ------------------------ | ----------- | -| `url` | URL of user's profile (can be remote) | -| `username` | The username of the account | -| `acct` | Equals `username` for local users, includes `@domain` for remote ones | -| `id` | Account ID | - -### Notification - -| Attribute | Description | -| ------------------------ | ----------- | -| `id` | The notification ID | -| `type` | One of: "mention", "reblog", "favourite", "follow" | -| `created_at` | The time the notification was created | -| `account` | The [Account](#account) sending the notification to the user | -| `status` | The [Status](#status) associated with the notification, if applicable | - -### Relationship - -| Attribute | Description | -| ------------------------ | ----------- | -| `following` | Whether the user is currently following the account | -| `followed_by` | Whether the user is currently being followed by the account | -| `blocking` | Whether the user is currently blocking the account | -| `muting` | Whether the user is currently muting the account | -| `requested` | Whether the user has requested to follow the account | - -### Report - -| Attribute | Description | -| ------------------------ | ----------- | -| `id` | The ID of the report | -| `action_taken` | The action taken in response to the report | - -### Results - -| Attribute | Description | -| ------------------------ | ----------- | -| `accounts` | An array of matched [Accounts](#account) | -| `statuses` | An array of matchhed [Statuses](#status) | -| `hashtags` | An array of matched hashtags, as strings | - -### Status - -| Attribute | Description | -| ------------------------ | ----------- | -| `id` | The ID of the status | -| `uri` | A Fediverse-unique resource ID | -| `url` | URL to the status page (can be remote) | -| `account` | The [Account](#account) which posted the status | -| `in_reply_to_id` | `null` or the ID of the status it replies to | -| `in_reply_to_account_id` | `null` or the ID of the account it replies to | -| `reblog` | `null` or the reblogged [Status](#status) | -| `content` | Body of the status; this will contain HTML (remote HTML already sanitized) | -| `created_at` | The time the status was created | -| `reblogs_count` | The number of reblogs for the status | -| `favourites_count` | The number of favourites for the status | -| `reblogged` | Whether the authenticated user has reblogged the status | -| `favourited` | Whether the authenticated user has favourited the status | -| `sensitive` | Whether media attachments should be hidden by default | -| `spoiler_text` | If not empty, warning text that should be displayed before the actual content | -| `visibility` | One of: `public`, `unlisted`, `private`, `direct` | -| `media_attachments` | An array of [Attachments](#attachment) | -| `mentions` | An array of [Mentions](#mention) | -| `tags` | An array of [Tags](#tag) | -| `application` | [Application](#application) from which the status was posted | - -### Tag - -| Attribute | Description | -| ------------------------ | ----------- | -| `name` | The hashtag, not including the preceding `#` | -| `url` | The URL of the hashtag | +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md) diff --git a/docs/Using-the-API/OAuth-details.md b/docs/Using-the-API/OAuth-details.md index e88a25682..6a6926bb9 100644 --- a/docs/Using-the-API/OAuth-details.md +++ b/docs/Using-the-API/OAuth-details.md @@ -1,12 +1 @@ -OAuth details -============= - -We use the [Doorkeeper gem for OAuth](https://github.com/doorkeeper-gem/doorkeeper/wiki), so you can refer to their docs on specifics of the end-points. - -The API is divided up into access scopes: - -- `read`: Read data -- `write`: Post statuses and upload media for statuses -- `follow`: Follow, unfollow, block, unblock - -Multiple scopes can be requested during the authorization phase with the `scope` query param (space-separate the scopes). If you do not specify a `scope` in your authorization request, the resulting access token will default to `read` access. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/OAuth-details.md) diff --git a/docs/Using-the-API/Push-notifications.md b/docs/Using-the-API/Push-notifications.md index fc373e723..3292c0a6e 100644 --- a/docs/Using-the-API/Push-notifications.md +++ b/docs/Using-the-API/Push-notifications.md @@ -1,4 +1 @@ -Push notifications -================== - -See <https://github.com/Gargron/tusky-api> for an example of how to create push notifications for a mobile app. It involves using the Mastodon streaming API on behalf of the app's users, as a sort of proxy. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Push-notifications.md) diff --git a/docs/Using-the-API/Streaming-API.md b/docs/Using-the-API/Streaming-API.md index b6d41ab0e..482f901c0 100644 --- a/docs/Using-the-API/Streaming-API.md +++ b/docs/Using-the-API/Streaming-API.md @@ -1,40 +1 @@ -Streaming API -============= - -Your application can use a server-sent events endpoint to receive updates in real-time. Server-sent events is an incredibly simple transport method that relies entirely on chunked-encoding transfer, i.e. the HTTP connection is kept open and receives new data periodically. - -### Endpoints: - -**GET /api/v1/streaming/user** - -Returns events that are relevant to the authorized user, i.e. home timeline and notifications - -**GET /api/v1/streaming/public** - -Returns all public statuses - -**GET /api/v1/streaming/hashtag** - -Returns all public statuses for a particular hashtag (query param `tag`) - -### Stream contents - -The stream will contain events as well as heartbeat comments. Lines that begin with a colon (`:`) can be ignored by parsers, they are simply there to keep the connection open. Events have this structure: - -``` -event: name -data: payload - -``` - -[See MDN](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) - -### Event types - -|Event|Description|What's in the payload| -|-----|-----------|---------------------| -|`update`|A new status has appeared!|Status| -|`notification`|A new notification|Notification| -|`delete`|A status has been deleted|ID of the deleted status| - -The payload is JSON-encoded. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md) diff --git a/docs/Using-the-API/Testing-with-cURL.md b/docs/Using-the-API/Testing-with-cURL.md index a373ec2bb..04c7c87b2 100644 --- a/docs/Using-the-API/Testing-with-cURL.md +++ b/docs/Using-the-API/Testing-with-cURL.md @@ -1,18 +1 @@ -Testing the API with cURL -========================= - -Mastodon builds around the idea of being a server first, rather than a client itself. Similarly to how a XMPP chat server communicates with others and with its own clients, Mastodon takes care of federation to other networks, like other Mastodon or GNU Social instances. So Mastodon provides a REST API, and a 3rd-party app system for using it via OAuth2. - -You can get a client ID and client secret required for OAuth [via an API end-point](API.md#apps). - -From these two, you will need to acquire an access token. It is possible to do using your account's e-mail and password like this: - - curl -X POST -d "client_id=CLIENT_ID_HERE&client_secret=CLIENT_SECRET_HERE&grant_type=password&username=YOUR_EMAIL&password=YOUR_PASSWORD" -Ss https://mastodon.social/oauth/token - -The `/oauth/token` path will attempt to login with the given credentials, and then retrieve the access token for the current user. If the login failed the response will be a 302 redirect to `/auth/sign_in`. Otherwise the response will be a JSON object containing the key `access_token`. - -Use that token in any API requests by setting a header like this: - - curl --header "Authorization: Bearer ACCESS_TOKEN_HERE" -sS https://mastodon.social/api/v1/timelines/home - -Please note that the password-based approach is not recommended especially if you're dealing with other user's accounts and not just your own. Usually you would use the authorization grant approach where you redirect the user to a web page on the original site where they can login and authorize the application and are then redirected back to your application with an access code. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Testing-with-cURL.md) diff --git a/docs/Using-the-API/Tips-for-app-developers.md b/docs/Using-the-API/Tips-for-app-developers.md index d60b472e5..36a28da2e 100644 --- a/docs/Using-the-API/Tips-for-app-developers.md +++ b/docs/Using-the-API/Tips-for-app-developers.md @@ -1,16 +1 @@ -Tips for app developers -======================= - -## Authentication - -Make sure that you allow your users to specify the domain they want to connect to before login. Use that domain to acquire a client id/secret for OAuth2 and then proceed with normal OAuth2 also using that domain to build the URLs. - -In my opinion it is easier for people to understand what is being asked of them if you ask for a `username@domain` type input, since it looks like an e-mail address. Though the username part is not required for anything in the OAuth2 process. Once the user is logged in, you get information about the logged in user from `/api/v1/accounts/verify_credentials` - -## Usernames - -Make sure that you make it possible to see the `acct` of any user in your app (since it includes the domain part for remote users), people must be able to tell apart users from different domains with the same username. - -## Formatting - -The API delivers already formatted HTML to your app. This isn't ideal since not all apps are based on HTML, but this is not fixable as it's part of the way OStatus federation works. Most importantly, you get some information on linked entities alongside the HTML of the status body. For example, you get a list of mentioned users, and a list of media attachments, and a list of hashtags. It is possible to convert the HTML to whatever you need in your app by parsing the HTML tags and matching their `href`s to the linked entities. If a match cannot be found, the link must stay a clickable link. +[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Tips-for-app-developers.md) |
