From: lain <lain@soykaf.club>
Date: Tue, 28 Jul 2020 15:46:37 +0000 (+0200)
Subject: Docs: Add frontend info to cheat sheet.
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=08732e8a0335ae44c866c2dd63927c65158b27c9;p=akkoma

Docs: Add frontend info to cheat sheet.
---

diff --git a/config/config.exs b/config/config.exs
index acf3b5c96..09dd9e786 100644
--- a/config/config.exs
+++ b/config/config.exs
@@ -645,6 +645,15 @@ config :pleroma, Pleroma.Plugs.RemoteIp, enabled: true
 
 config :pleroma, :static_fe, enabled: false
 
+# Example of frontend configuration
+# This example will make us serve the primary frontend from the
+# `/frontends/pleroma/develop` folder in your instance static directory.
+#
+# With no frontend configuration, the bundled files from the `static` directory will
+# be used.
+#
+# config :pleroma, :frontends, primary: %{"name" => "pleroma", "ref" => "develop"}
+
 config :pleroma, :web_cache_ttl,
   activity_pub: nil,
   activity_pub_question: 30_000
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 5e50f1ba9..5dc895c0a 100644
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -1046,3 +1046,23 @@ Note: setting `restrict_unauthenticated/timelines/local` to `true` has no practi
 Control favicons for instances.
 
 * `enabled`: Allow/disallow displaying and getting instances favicons
+
+## Frontend management
+
+Frontends in Pleroma are swappable - you can specify which one to use here.
+
+For now, you can set a frontend with the key `primary` and the options of `name` and `ref` set. This will then make Pleroma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
+
+If you don't set anything here, the bundled frontend will be used.
+
+Example:
+
+```
+config :pleroma, :frontends,
+  primary: %{
+    "name" => "pleroma",
+    "ref" => "stable"
+  }
+```
+
+This would serve frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself.