Add favicon, frontend docs
authorFloatingGhost <hannah@coffee-and-dreams.uk>
Sun, 20 Nov 2022 21:44:32 +0000 (21:44 +0000)
committerFloatingGhost <hannah@coffee-and-dreams.uk>
Sun, 20 Nov 2022 21:44:32 +0000 (21:44 +0000)
docs/docs/configuration/howto_theming_your_instance.md
docs/docs/configuration/static_dir.md
docs/docs/installation/migrating_to_akkoma.md

index af417aee4405d39b2775d9cea55e61f2c2201df0..c226d054b21461e0475c0ea3d4e40a6c5c5d29f1 100644 (file)
@@ -70,5 +70,4 @@ config :pleroma, :frontend_configurations,
   }
 ```
 
-If you added it in the back-end configuration file, you'll need to restart your instance for the changes to take effect. If you don't see the changes, it's probably because the browser has cached the previous theme. In that case you'll want to clear browser caches. Alternatively you can use a private/incognito window just to see the changes.
-
+If you added it in the back-end configuration file, you'll need to restart your instance for the changes to take effect. If you don't see the changes, it's probably because the browser has cached the previous theme. In that case you'll want to clear browser caches. Alternatively you can use a private/incognito window just to see the changes.
\ No newline at end of file
index 37e07eb0d225e107cb9b4736ec8774a5c595d77b..0653dc2a3bf49bbce63b7e9063adec882fe38b54 100644 (file)
@@ -89,6 +89,13 @@ config :pleroma, :frontend_configurations,
 
 Terms of Service will be shown to all users on the registration page. It's the best place where to write down the rules for your instance. You can modify the rules by adding and changing `$static_dir/static/terms-of-service.html`.
 
+## Favicon
+
+The favicon will display on the frontend, and in the browser tab. 
+
+Place a PNG file at `$static_dir/favicon.png` to change the favicon. Not that this
+is _one level above_ where the logo is placed, it should be on the same level as
+the `frontends` directory.
        
 ## Styling rendered pages
 
index b64cdd056e2883688ca3ef2d3911f2ef732c9018..2df7bfad02cc76b56fc1ccfa84bc271364bc2e19 100644 (file)
@@ -95,3 +95,26 @@ Your situation will likely be unique - you'll need the changes in the
 [forked pleroma-fe repository](https://akkoma.dev/AkkomaGang/pleroma-fe),
 and either merge or cherry-pick from there depending on how you've got
 things.
+
+## Common issues
+
+### The frontend doesn't show after installing it
+
+This may occur if you are using database configuration.
+
+Sometimes the config in your database will cause akkoma to still report
+that there's no frontend, even when you've run the install.
+
+To fix this, run:
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl config delete pleroma frontends
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.config delete pleroma frontends
+    ```
+
+which will remove the config from the database. Things should work now.
\ No newline at end of file