Docs: Add frontend info to cheat sheet.
authorlain <lain@soykaf.club>
Tue, 28 Jul 2020 15:46:37 +0000 (17:46 +0200)
committerlain <lain@soykaf.club>
Tue, 28 Jul 2020 15:46:37 +0000 (17:46 +0200)
config/config.exs
docs/configuration/cheatsheet.md

index acf3b5c969ae50960562ba9d31194d93256dd750..09dd9e786d4cdbe4b8b196848be5e3f18ea1615c 100644 (file)
@@ -645,6 +645,15 @@ config :pleroma, Pleroma.Plugs.RemoteIp, enabled: true
 
 config :pleroma, :static_fe, enabled: false
 
 
 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
 config :pleroma, :web_cache_ttl,
   activity_pub: nil,
   activity_pub_question: 30_000
index 5e50f1ba92bd6f2b20571fd852c84982b8425cc4..5dc895c0a1ec395233bbbc0140bb56981a1ca0fd 100644 (file)
@@ -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
 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.