about summary refs log tree commit diff
path: root/docs/Running-Mastodon/Administration-guide.md
diff options
context:
space:
mode:
authorEffy Elden <git@effy.is>2017-01-22 19:50:40 +1100
committerEffy Elden <git@effy.is>2017-01-22 19:50:40 +1100
commit92a98f73aa8e6e7aff6cf31f8c8f237e4bd22475 (patch)
treea6d64a393bdaf5ade5854ce8e7290ec3dbf09b81 /docs/Running-Mastodon/Administration-guide.md
parent536cde4e99a3de0286bdea5bcb5c81a82e7cd0ed (diff)
Add separate sections for Heroku and Vagrant deployments. Add guide for instance administration. Move 'Contribution guide' to 'Development guide'.
Diffstat (limited to 'docs/Running-Mastodon/Administration-guide.md')
-rw-r--r--docs/Running-Mastodon/Administration-guide.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/Running-Mastodon/Administration-guide.md b/docs/Running-Mastodon/Administration-guide.md
new file mode 100644
index 000000000..1b9dc8630
--- /dev/null
+++ b/docs/Running-Mastodon/Administration-guide.md
@@ -0,0 +1,28 @@
+Administration guide
+=================
+
+So, you have a working Mastodon instance... now what?
+
+## 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:
+
+- 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).
\ No newline at end of file