Moving docs to tootsuite/documentation (#1550)

README.md

@@ -25,11 +25,11 @@ If you would like, you can [support the development of this project on Patreon][
 
 ## Resources
 
-- [List of Mastodon instances](docs/Using-Mastodon/List-of-Mastodon-instances.md)
+- [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
 - [Use this tool to find Twitter friends on Mastodon](https://mastodon-bridge.herokuapp.com)
-- [API overview](docs/Using-the-API/API.md)
-- [Frequently Asked Questions](docs/Using-Mastodon/FAQ.md)
-- [List of apps](docs/Using-Mastodon/Apps.md)
+- [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
+- [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
+- [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
 
 ## Features
 
@@ -117,25 +117,25 @@ Which will re-create the updated containers, leaving databases and data as is. D
 
 ## Deployment without Docker
 
-Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the [production guide](docs/Running-Mastodon/Production-guide.md) for examples, configuration and instructions.
+Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the [production guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Production-guide.md) for examples, configuration and instructions.
 
 ## Deployment on Scalingo
 
 [![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy?source=https://github.com/tootsuite/mastodon#master)
 
-[You can view a guide for deployment on Scalingo here.](docs/Running-Mastodon/Scalingo-guide.md)
+[You can view a guide for deployment on Scalingo here.](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Scalingo-guide.md)
 
 ## Deployment on Heroku (experimental)
 
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
-Mastodon can theoretically run indefinitely on a free [Heroku](https://heroku.com) app. [You can view a guide for deployment on Heroku here.](docs/Running-Mastodon/Heroku-guide.md)
+Mastodon can theoretically run indefinitely on a free [Heroku](https://heroku.com) app. [You can view a guide for deployment on Heroku here.](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Heroku-guide.md)
 
 ## Development with Vagrant
 
 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.
 
-[You can find the guide for setting up a Vagrant development environment here.](docs/Running-Mastodon/Vagrant-guide.md)
+[You can find the guide for setting up a Vagrant development environment here.](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Vagrant-guide.md)
 
 ## Contributing
 

docs/Contributing-to-Mastodon/Sponsors.md

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

docs/Contributing-to-Mastodon/Translating.md

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

docs/Extensions.md

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

docs/README.md

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

docs/Running-Mastodon/Administration-guide.md

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

docs/Running-Mastodon/Development-guide.md

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

docs/Running-Mastodon/Heroku-guide.md

-Heroku guide
-============
-
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](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)

docs/Running-Mastodon/Production-guide.md

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

docs/Running-Mastodon/Scalingo-guide.md

-Scalingo guide
-==============
-
-[![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](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)

docs/Running-Mastodon/Tuning.md

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

docs/Running-Mastodon/Vagrant-guide.md

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

docs/Specs-and-RFCs-used.md

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

docs/Using-Mastodon/2FA.md

-# 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 ![screenshot](screenshots/2fa/enable.png)
-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 ![disable button screenshot](screenshots/2fa/disable.png)
+[The documentation has moved to its own repository](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/2FA.md)

docs/Using-Mastodon/Apps.md

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

docs/Using-Mastodon/FAQ.md

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

docs/Using-Mastodon/List-of-Mastodon-instances.md

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