2017-01-22 09:50:40 +01:00
Administration guide
2017-02-13 20:41:48 +01:00
====================
2017-01-22 09:50:40 +01:00
So, you have a working Mastodon instance... now what?
2017-02-13 20:41:48 +01:00
## Turning into an admin
The following rake task:
2017-04-08 00:31:50 +02:00
RAILS_ENV=production bundle exec rails mastodon:make_admin USERNAME=alice
2017-02-13 20:41:48 +01:00
2017-05-06 13:53:15 +02:00
or, if using docker:
docker-compose run --rm web rails mastodon:make_admin USERNAME=alice
2017-02-13 20:41:48 +01:00
Would turn the local user "alice" into an admin.
2017-01-22 09:50:40 +01:00
## Administration web interface
2017-09-10 02:31:15 +02:00
A user that is designated as `admin = TRUE` in the database is able to access a suite of administration tools, accessible from the sidebar under "Administration" from the preferences/edit profile page.
2017-01-22 09:50:40 +01:00
## Site settings
2017-09-10 02:31:15 +02:00
Your site settings are stored in the `settings` database table, and editable through the admin interface under "Administration" -> "Site settings".
2017-01-22 09:50:40 +01:00
2017-09-10 02:31:15 +02:00
You are able to set settings such as, among others:
2017-01-22 09:50:40 +01:00
2017-02-13 20:41:48 +01:00
- Site title
2017-01-22 09:50:40 +01:00
- Contact username
- Contact email
- Site description
- Site extended description
2017-02-13 20:41:48 +01:00
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).
2017-04-09 01:09:46 +02:00
2017-09-10 02:31:15 +02:00
## Confirming users manually
2017-04-09 01:09:46 +02:00
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.
2017-04-17 02:07:34 +02:00
2017-09-10 02:31:15 +02:00
## Creating users while registration is closed
2017-04-20 20:08:05 +02:00
2017-09-10 02:31:15 +02:00
RAILS_ENV=production bundle exec rails mastodon:add_user
2017-04-20 20:08:05 +02:00
2017-09-10 02:31:15 +02:00
This will guide you through creating a new user interactively. The user will get a confirmation e-mail.
2017-04-20 20:08:05 +02:00
2017-04-23 18:51:37 +02:00
## Activity monitoring
Munin graphs can be generated to track your instance activity.
* https://github.com/cquest/mastodon-munin-plugins
2017-05-11 11:23:32 +02:00
* https://framagit.org/framasoft/munin-plugins/tree/master/mastodon
* https://github.com/0xa/mastodon-munin
2017-04-23 18:51:37 +02:00
2017-09-10 02:31:15 +02:00
## Other admins
- There is a [Discourse messaging board ](https://discourse.joinmastodon.org )
- There's a mailing list at https://lists.ffdn.org/wws/info/mastodon-admin.
Feel free to join for all your questions and to get some feedback from other admins!
## Instance directory
2017-04-17 17:49:49 +02:00
2017-09-10 02:31:15 +02:00
If you want your instance to appear on the instance picker on joinmastodon.org or the instance directory/wizard on instances.social, you can [submit it to instances.social here ](https://instances.social/admin )