BBS: Add documentation.

diff --git a/.gitignore b/.gitignore
index 04c61ede784db368780dcaced5f043ad7d1b0cc4..e8052d817a1045468fa635688a1a85256f42799b 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,7 @@
 /test/tmp/
 /doc
 /instance
+/priv/ssh_keys
 
 # Prevent committing custom emojis
 /priv/static/emoji/custom/*

diff --git a/docs/config.md b/docs/config.md
index 3624e295b717574944b5ea27f1c1a3d87567e0ae..4fb4f530b69282887ddb4c03fb90bf5efa76167a 100644 (file)
--- a/docs/config.md
+++ b/docs/config.md
@@ -356,3 +356,21 @@ Pleroma account will be created with the same name as the LDAP user name.
 
 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
+
+## BBS / SSH access
+
+To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
+
+```exs
+app_dir = File.cwd!
+priv_dir = Path.join([app_dir, "priv/ssh_keys"])
+
+config :esshd,
+  enabled: true,
+  priv_dir: priv_dir,
+  handler: "Pleroma.BBS.Handler",
+  port: 10_022,
+  password_authenticator: "Pleroma.BBS.Authenticator"
+```
+
+Feel free to adjust the priv_dir and port number. Then you will have to create the key for the keys (in the example `priv/ssh_keys`) and create the host keys with `ssh-keygen -N "" -b 2048 -t rsa -f ssh_host_rsa_key`. After restarting, you should be able to connect to your Pleroma instance with `ssh username@server -p $PORT`