Embed announce activity data instead of linking to it
[akkoma] / README.md
index 5c6753b0a666108e98ead4d27fa9e0fe5cda51b2..5b1c9bdddffe99c7d19e05e6bac135c95c0c2623 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,11 +14,16 @@ Mobile clients that are known to work well:
 * Subway Tooter
 * Amaroq (iOS)
 * Tootdon (Android + iOS)
+* Tootle (iOS)
 
 No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
 
 ## Installation
 
+### Docker
+
+While we don't provide docker files, other people have written very good ones. Take a look at https://github.com/Angristan/dockerfiles/tree/master/pleroma or https://github.com/sn0w/pleroma-docker.
+
 ### Dependencies
 
 * Postgresql version 9.6 or newer
@@ -44,6 +49,9 @@ No release has been made yet, but several servers have been online for months al
 
 By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically.
 
+### Frontends
+Pleroma comes with two frontends. The first one, Pleroma FE, can be reached by normally visiting the site. The other one, based on the Mastodon project, can be found by visiting the /web path of your site.
+
 ### As systemd service (with provided .service file)
 Running `service pleroma start`
 Logs can be watched by using `journalctl -fu pleroma.service`
@@ -65,3 +73,15 @@ This is useful for running pleroma inside Tor or i2p.
 ### Password reset
 
 Run `mix generate_password_reset username` to generate a password reset link that you can then send to the user.
+
+### Moderators
+
+You can make users moderators. They will then be able to delete any post.
+
+Run `mix set_moderator username [true|false]` to make user a moderator or not.
+
+## Troubleshooting
+
+### No incoming federation
+
+Check that you correctly forward the "host" header to backend. It is needed to validate signatures.