From 07ccab9766a6289326676a4814537564f25f35fa Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Mon, 23 Aug 2021 20:27:16 +0300
Subject: Add search/meilisearch documentation

---
 docs/configuration/search.md | 99 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 docs/configuration/search.md

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
new file mode 100644
index 000000000..14ec2bc63
--- /dev/null
+++ b/docs/configuration/search.md
@@ -0,0 +1,99 @@
+# Configuring search
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Built-in search
+
+To use built-in search that has no external dependencies, set the search module to `Pleroma.Activity`:
+
+> config :pleroma, Pleroma.Search, module: Pleroma.Activity
+
+While it has no external dependencies, it has problems with performance and relevancy.
+
+## Meilisearch
+
+To use [meilisearch](https://www.meilisearch.com/), set the search module to `Pleroma.Search.Meilisearch`:
+
+> config :pleroma, Pleroma.Search, module: Pleroma.Search.Meilisearch
+
+You then need to set the address of the meilisearch instance, and optionally the private key for authentication.
+
+> config :pleroma, Pleroma.Search.Meilisearch,
+>    url: "http://127.0.0.1:7700/",
+>    private_key: "private key"
+
+Information about setting up meilisearch can be found in the
+[official documentation](https://docs.meilisearch.com/learn/getting_started/installation.html).
+You probably want to start it with `MEILI_NO_ANALYTICS=true` and `MEILI_NO_CENTRY=true` environment variables,
+to disable analytics.
+
+### Private key authentication (optional)
+
+To set the private key, use the `MEILI_MASTER_KEY` environment variable when starting. After setting the _master key_,
+you have to get the _private key_, which is actually used for authentication.
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl search.meilisearch show-private-key <your master key here>
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.search.meilisearch show-private-key <your master key here>
+    ```
+
+This is the key you actually put into your configuration file.
+
+### Initial indexing
+
+After setting up the configuration, you'll want to index all of your already existsing posts. Only public posts are indexed.  You'll only
+have to do it one time, but it might take a while, depending on the amount of posts your instance has seen. This is also a fairly RAM
+consuming process for `meilisearch`, and it will take a lot of RAM when running if you have a lot of posts (seems to be around 5G for ~1.2
+million posts while idle and up to 7G while indexing initially, but your experience may be different).
+
+To start te initial indexing, run the `index` command:
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl search.meilisearch index
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.search.meilisearch index
+    ```
+
+This will show you the total amount of posts to index, and then show you the amount of posts indexed currently, until the numbers eventually
+become the same. The posts are indexed in big batches and meilisearch will take some time to actually index them, even after you have
+inserted all the posts into it. Depending on the amount of posts, this may be as long as several hours. To get information about the status
+of indexing and how many posts have actually been indexed, use the `stats` command:
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl search.meilisearch stats
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.search.meilisearch stats
+    ```
+
+### Clearing the index
+
+In case you need to clear the index (for example, to re-index from scratch, if that needs to happen for some reason), you can
+use the `clear` command:
+
+=== "OTP"
+    ```sh
+    ./bin/pleroma_ctl search.meilisearch clear
+    ```
+
+=== "From Source"
+    ```sh
+    mix pleroma.search.meilisearch clear
+    ```
+
+This will clear **all** the posts from the search index. Note, that deleted posts are also removed from index by the instance itself, so
+there is no need to actually clear the whole index, unless you want **all** of it gone. That said, the index does not hold any information
+that cannot be re-created from the database, it should also generally be a lot smaller than the size of your database. Still, the size
+depends on the amount of text in posts.
-- 
cgit v1.2.3


From c569ad05b3d812c87171e68eac79eec749321033 Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Tue, 12 Oct 2021 19:14:39 +0300
Subject: Add more documentation about rum to meilisearch docs

---
 docs/configuration/search.md | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index 14ec2bc63..e9743f1a4 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -12,6 +12,15 @@ While it has no external dependencies, it has problems with performance and rele
 
 ## Meilisearch
 
+Note that it's quite a bit more memory hungry than PostgreSQL (around 4-5G for ~1.2 million
+posts while idle and up to 7G while indexing initially). The disk usage for this additional index is also
+around 4 gigabytes. Like [RUM](./cheatsheet.md#rum-indexing-for-full-text-search) indexes, it offers considerably
+higher performance and ordering by timestamp in a reasonable amount of time.
+Additionally, the search results seem to be more accurate.
+
+Due to high memory usage, it may be best to set it up on a different machine, if running pleroma on a low-resource
+computer, and use private key authentication to secure the remote search instance.
+
 To use [meilisearch](https://www.meilisearch.com/), set the search module to `Pleroma.Search.Meilisearch`:
 
 > config :pleroma, Pleroma.Search, module: Pleroma.Search.Meilisearch
-- 
cgit v1.2.3


From 8898b5e927bae27a521e4eadd0faf970ad27c5bc Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Sun, 14 Nov 2021 20:15:12 +0300
Subject: Fix a typo in search docs

---
 docs/configuration/search.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index e9743f1a4..9adc7884f 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -60,7 +60,7 @@ have to do it one time, but it might take a while, depending on the amount of po
 consuming process for `meilisearch`, and it will take a lot of RAM when running if you have a lot of posts (seems to be around 5G for ~1.2
 million posts while idle and up to 7G while indexing initially, but your experience may be different).
 
-To start te initial indexing, run the `index` command:
+To start the initial indexing, run the `index` command:
 
 === "OTP"
     ```sh
-- 
cgit v1.2.3


From a6946048fbe049aa223d094d36eb767739ab5ff2 Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Wed, 17 Nov 2021 22:29:49 +0300
Subject: Rename Activity.Search to Search.DatabaseSearch

---
 docs/configuration/search.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index 9adc7884f..c7e77d9c2 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -6,7 +6,7 @@
 
 To use built-in search that has no external dependencies, set the search module to `Pleroma.Activity`:
 
-> config :pleroma, Pleroma.Search, module: Pleroma.Activity
+> config :pleroma, Pleroma.Search, module: Pleroma.Search.DatabaseSearch
 
 While it has no external dependencies, it has problems with performance and relevancy.
 
-- 
cgit v1.2.3


From 3412713c5b2fd24605b18933ef70de164ee14f2d Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Mon, 20 Dec 2021 18:16:33 +0300
Subject: Update search.md documentation with meilisearch indexing steps

---
 docs/configuration/search.md | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index c7e77d9c2..7dbbd3e17 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -60,6 +60,15 @@ have to do it one time, but it might take a while, depending on the amount of po
 consuming process for `meilisearch`, and it will take a lot of RAM when running if you have a lot of posts (seems to be around 5G for ~1.2
 million posts while idle and up to 7G while indexing initially, but your experience may be different).
 
+The sequence of actions is as follows:
+
+1. First, change the configuration to use `Pleroma.Search.Meilisearch` as the search backend
+2. Restart your instance, at this point it can be used while the search indexing is running, though search won't return anything
+3. Start the initial indexing process (as described below with `index`),
+   and wait until the task says it sent everything from the database to index
+4. Wait until everything is actually indexed (by checking with `stats` as described below),
+   at this point you don't have to do anything, just wait a while.
+
 To start the initial indexing, run the `index` command:
 
 === "OTP"
-- 
cgit v1.2.3


From 4f2637acc6c46ea39ae38e869903e7ffcc38b34d Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Mon, 20 Dec 2021 19:27:22 +0300
Subject: Add description for initial_indexing_chunk_size

---
 docs/configuration/search.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index 7dbbd3e17..a785a18ad 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -25,11 +25,15 @@ To use [meilisearch](https://www.meilisearch.com/), set the search module to `Pl
 
 > config :pleroma, Pleroma.Search, module: Pleroma.Search.Meilisearch
 
-You then need to set the address of the meilisearch instance, and optionally the private key for authentication.
+You then need to set the address of the meilisearch instance, and optionally the private key for authentication. You might
+also want to change the `initial_indexing_chunk_size` to be smaller if you're server is not very powerful, but not higher than `100_000`,
+because meilisearch will refuse to process it if it's too big. However, in general you want this to be as big as possible, because meilisearch
+indexes faster when it can process many posts in a single batch.
 
 > config :pleroma, Pleroma.Search.Meilisearch,
 >    url: "http://127.0.0.1:7700/",
->    private_key: "private key"
+>    private_key: "private key",
+>    initial_indexing_chunk_size: 100_000
 
 Information about setting up meilisearch can be found in the
 [official documentation](https://docs.meilisearch.com/learn/getting_started/installation.html).
-- 
cgit v1.2.3


From 1e23f527e3e22108b402552a0766e488048ed3f4 Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Tue, 22 Mar 2022 20:29:17 +0300
Subject: Change the meilisearch key auth to conform to 0.25.0

---
 docs/configuration/search.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index a785a18ad..82217e5ee 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -47,15 +47,15 @@ you have to get the _private key_, which is actually used for authentication.
 
 === "OTP"
     ```sh
-    ./bin/pleroma_ctl search.meilisearch show-private-key <your master key here>
+    ./bin/pleroma_ctl search.meilisearch show-keys <your master key here>
     ```
 
 === "From Source"
     ```sh
-    mix pleroma.search.meilisearch show-private-key <your master key here>
+    mix pleroma.search.meilisearch show-keys <your master key here>
     ```
 
-This is the key you actually put into your configuration file.
+You will see a "Default Admin API Key", this is the key you actually put into your configuration file.
 
 ### Initial indexing
 
-- 
cgit v1.2.3


From b150e6f15e0f06c8e23c0ac66aeaf80eb2f8c31a Mon Sep 17 00:00:00 2001
From: Ekaterina Vaartis <vaartis@kotobank.ch>
Date: Wed, 23 Mar 2022 11:36:01 +0300
Subject: Update meilisearch docs

---
 docs/configuration/search.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/configuration/search.md b/docs/configuration/search.md
index 82217e5ee..f131948a7 100644
--- a/docs/configuration/search.md
+++ b/docs/configuration/search.md
@@ -37,8 +37,10 @@ indexes faster when it can process many posts in a single batch.
 
 Information about setting up meilisearch can be found in the
 [official documentation](https://docs.meilisearch.com/learn/getting_started/installation.html).
-You probably want to start it with `MEILI_NO_ANALYTICS=true` and `MEILI_NO_CENTRY=true` environment variables,
-to disable analytics.
+You probably want to start it with `MEILI_NO_ANALYTICS=true` environment variable to disable analytics.
+At least version 0.25.0 is required, but you are strongly adviced to use at least 0.26.0, as it introduces
+the `--enable-auto-batching` option which drastically improves performance. Without this option, the search
+is hardly usable on a somewhat big instance.
 
 ### Private key authentication (optional)
 
-- 
cgit v1.2.3


From 637926dcbb6b607fb91eed9be2f8a7169c7729c3 Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Fri, 10 Nov 2023 13:58:25 +0200
Subject: Initial draft on frontends management

---
 docs/administration/frontends-management.md | 71 +++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 docs/administration/frontends-management.md

(limited to 'docs')

diff --git a/docs/administration/frontends-management.md b/docs/administration/frontends-management.md
new file mode 100644
index 000000000..a311a326e
--- /dev/null
+++ b/docs/administration/frontends-management.md
@@ -0,0 +1,71 @@
+# Managing installed frontends
+
+Pleroma lets you install multiple frontends including multiple versions of same frontend. Right now it's only possible to switch which frontend is the default, but in the future it would be possible for user to select which frontend they prefer to use.
+
+As of 2.6.0 there are two ways of managing frontends - through PleromaFE's Admin Dashboard (preferred, easier method) or through AdminFE (clunky but also works on versions older than 2.6.0).
+
+!!! note
+    Managing frontends through UI requires [in-database configuration](../configuration/howto_database_config.md) to be enabled (default on newer instances but might be off on older ones).
+
+## How it works
+
+When installing frontends, it creates a folder in [static directory](../configuration/static_dir.md) that follows this pattern: `/frontends/${front-end name}/${front-end version}/`, puts contents of the built frontend in there. Then when accessing the server backend checks what front-end name and version are set to be default and serves index.html and assets from appropriate path.
+
+!!! warning
+
+    If you've been putting your frontend build directly into static dir as an antiquated way of serving custom frontend, this system will not work and will still serve the custom index.html you put in there. You can still serve custom frontend builds if you put your build into `/frontends/$name/$version` instead and set the "default frontend" fields appropriately.
+    
+Currently, there is no backup system, i.e. when installing `master` version it _will_ overwrite installed `master` version, for now if you want to keep previous version you should back it up manually, i.e. running `cp -r ./frontends/pleroma-fe/master ./frontends/pleroma-fe/master_old` in your static dir.
+
+## Managing front-ends through Admin Dashboard
+
+Open up Admin Dashboard (gauge icon in top bar, same as where link to AdminFE was), switch to "Front-ends" tab.  
+IMAGE HERE  
+This page is designed to be self-explanatory and easy to use, while avoiding issues and pitfalls of AdminFE, but it's also early in development, everything is subject to change.
+
+!!! bug
+    As of PleromaFE 2.6.0 there is no feedback on whether frontend is installing, installed or failed to install, this will be fixed in PleromaFE 2.6.1.
+    
+!!! warning
+    This goes without saying, but if you set default frontend to anything except >2.6.0 version of PleromaFE you'll lose the access to Admin Dashboard and will have to use AdminFE to get it back. See below on how to use AdminFE.
+
+### Limitations 
+
+Currently the list of available for install frontends is essentially hard-coded in backend's configuration, each providing only one version, with exception for PleromaFE which overrides 'pleroma-fe' to also include `develop` version. There is no way to manually install build with a URL (coming soon) nor add more available frontends to the repository (it's broken).
+
+There is also no way to tell if there is an update available or not, for now you should watch for [announcements](https://pleroma.social/announcements/) of new PleromaFE stable releases to see if there is new stable version. For `develop` version it's up to you whether you want to follow the development process or just reinstall it periodically hoping for new stuff.
+
+## Using AdminFE to manage frontends
+
+Access AdminFE either directly by going to `/pleroma/admin` of your instance or by opening Admin Dashboard and clicking the link below  
+IMAGE HERE
+
+Go to Settings -> Frontend.
+
+### Installing front-ends
+
+At the very top of the page there's a list of available frontends and button to install custom front-end
+
+!!! tip
+    Remember to click "Submit" in bottom right corner to save your changes!
+
+!!! bug
+    **Available Frontends** section lets you _install_ frontends but **NOT** update/reinstall them. It's only useful for installing a frontend once.
+    
+Due to aforementioned bug, preferred way of installing frontends in AdminFE is by clicking the "Install another frontend"  
+IMAGE HERE  
+and filling in the fields. Unfortunately AdminFE does not provide the raw data necessary for you to fill those fields, so your best bet is to see what backend returns in browser's devtools or refer to the [source code](https://git.pleroma.social/pleroma/pleroma/-/blob/develop/config/config.exs?ref_type=heads#L742-791). For the most part, only **Name**, **Ref** (i.e. version) and **Build URL** fields are required, although some frontends might also require **Build Directory** to work. 
+
+For pleroma-fe you can use either `master` or `develop` refs, or potentially any ref in GitLab that has artifacts for `build` job, but that's outside scope of this document.
+
+### Selecting default frontend
+
+Scroll page waaaaay down, search for "Frontends" section, subtitled "Installed frontends management", change the name and reference of the "Primary" frontend.  
+IMAGE HERE
+
+
+!!! danger
+    If you change "Admin" frontend name/reference you risk losing access to AdminFE as well.
+    
+!!! warning
+    Don't put anything into the "Available" section as it will break the list of available frontends completely, including the "add another frontend" button. If you accidentally put something in there, click the trashbin icon next to "Available" to reset it and restore the frontends list.
-- 
cgit v1.2.3


From 3831d310091fe975893972185baa592789194952 Mon Sep 17 00:00:00 2001
From: "Haelwenn (lanodan) Monnier" <contact@hacktivis.me>
Date: Fri, 1 Sep 2023 19:32:59 +0200
Subject: docs: Put a max version on erlang and elixir

Closes: https://git.pleroma.social/pleroma/pleroma/-/issues/3194
---
 docs/installation/generic_dependencies.include | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/installation/generic_dependencies.include b/docs/installation/generic_dependencies.include
index dcaacfdfd..dbe6fe49d 100644
--- a/docs/installation/generic_dependencies.include
+++ b/docs/installation/generic_dependencies.include
@@ -1,8 +1,8 @@
 ## Required dependencies
 
-* PostgreSQL 9.6+
-* Elixir 1.10+
-* Erlang OTP 22.2+
+* PostgreSQL >=9.6
+* Elixir >=1.11.0 <1.15
+* Erlang OTP >=22.2.0 <26
 * git
 * file / libmagic
 * gcc (clang might also work)
-- 
cgit v1.2.3


From 19519d6c969196f2b1d9283168060a751068472d Mon Sep 17 00:00:00 2001
From: "Haelwenn (lanodan) Monnier" <contact@hacktivis.me>
Date: Fri, 1 Sep 2023 19:33:27 +0200
Subject: docs: clang is also supported

---
 docs/installation/generic_dependencies.include | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/installation/generic_dependencies.include b/docs/installation/generic_dependencies.include
index dbe6fe49d..3365a36a8 100644
--- a/docs/installation/generic_dependencies.include
+++ b/docs/installation/generic_dependencies.include
@@ -5,7 +5,7 @@
 * Erlang OTP >=22.2.0 <26
 * git
 * file / libmagic
-* gcc (clang might also work)
+* gcc or clang
 * GNU make
 * CMake
 
-- 
cgit v1.2.3


From be39146ecc6d55191f8ed3ec9cd3e113d8ee5e21 Mon Sep 17 00:00:00 2001
From: Mark Felder <feld@feld.me>
Date: Fri, 17 Nov 2023 11:44:33 -0500
Subject: Update docs to include dependencies on rust and vips where
 appropriate

---
 docs/installation/alpine_linux_en.md | 2 +-
 docs/installation/arch_linux_en.md   | 1 +
 docs/installation/debian_based_en.md | 2 +-
 docs/installation/debian_based_jp.md | 1 +
 docs/installation/freebsd_en.md      | 3 ++-
 5 files changed, 6 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/installation/alpine_linux_en.md b/docs/installation/alpine_linux_en.md
index 7154bca48..9794833a3 100644
--- a/docs/installation/alpine_linux_en.md
+++ b/docs/installation/alpine_linux_en.md
@@ -28,7 +28,7 @@ sudo apk upgrade
 * Install some tools, which are needed later:
 
 ```shell
-sudo apk add git build-base cmake file-dev
+sudo apk add git build-base cmake file-dev rust
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md
index f7d722ef9..dbfbf6bf8 100644
--- a/docs/installation/arch_linux_en.md
+++ b/docs/installation/arch_linux_en.md
@@ -14,6 +14,7 @@ This guide will assume that you have administrative rights, either as root or a
 * `base-devel`
 * `cmake`
 * `file`
+* `rust`
 
 #### Optional packages used in this guide
 
diff --git a/docs/installation/debian_based_en.md b/docs/installation/debian_based_en.md
index b61e4addd..44c93e1ef 100644
--- a/docs/installation/debian_based_en.md
+++ b/docs/installation/debian_based_en.md
@@ -20,7 +20,7 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
+sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev rust
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/debian_based_jp.md b/docs/installation/debian_based_jp.md
index 1424ad7f4..43902c987 100644
--- a/docs/installation/debian_based_jp.md
+++ b/docs/installation/debian_based_jp.md
@@ -21,6 +21,7 @@ Note: This article is potentially outdated because at this time we may not have
 - `build-essential`
 - `cmake`
 - `libmagic-dev`
+- `rust`
 
 #### このガイドで利用している追加パッケージ
 
diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index 50ed30d74..b88853dd1 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -9,7 +9,7 @@ This document was written for FreeBSD 12.1, but should be work on future release
 This assumes the target system has `pkg(8)`.
 
 ```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake rust vips
 ```
 
 Copy the rc.d scripts to the right directory:
@@ -41,6 +41,7 @@ Create a user for Pleroma:
 ```
 # pw add user pleroma -m
 # echo 'export LC_ALL="en_US.UTF-8"' >> /home/pleroma/.profile
+# echo 'export VIX_COMPILATION_MODE=PLATFORM_PROVIDED_LIBVIPS' >> /home/pleroma/.profile
 # su -l pleroma
 ```
 
-- 
cgit v1.2.3


From 2112e8b5e443a969725f85745b50886335806437 Mon Sep 17 00:00:00 2001
From: Henry Jameson <me@hjkos.com>
Date: Sun, 19 Nov 2023 10:30:49 +0200
Subject: update, add images

---
 docs/administration/frontends-management.md |  18 +++++++++---------
 docs/assets/admin_dash_location.png         | Bin 0 -> 8698 bytes
 docs/assets/frontends_tab.png               | Bin 0 -> 148269 bytes
 docs/assets/old_adminfe_link.png            | Bin 0 -> 15143 bytes
 docs/assets/primary_frontend_section.png    | Bin 0 -> 26498 bytes
 docs/assets/way_to_install_frontends.png    | Bin 0 -> 130193 bytes
 6 files changed, 9 insertions(+), 9 deletions(-)
 create mode 100644 docs/assets/admin_dash_location.png
 create mode 100644 docs/assets/frontends_tab.png
 create mode 100644 docs/assets/old_adminfe_link.png
 create mode 100644 docs/assets/primary_frontend_section.png
 create mode 100644 docs/assets/way_to_install_frontends.png

(limited to 'docs')

diff --git a/docs/administration/frontends-management.md b/docs/administration/frontends-management.md
index a311a326e..f982c4bca 100644
--- a/docs/administration/frontends-management.md
+++ b/docs/administration/frontends-management.md
@@ -19,13 +19,12 @@ Currently, there is no backup system, i.e. when installing `master` version it _
 
 ## Managing front-ends through Admin Dashboard
 
-Open up Admin Dashboard (gauge icon in top bar, same as where link to AdminFE was), switch to "Front-ends" tab.  
-IMAGE HERE  
+Open up Admin Dashboard (gauge icon in top bar, same as where link to AdminFE was),__
+![location of Admin Dashboard icon](../assets/admin_dash_location.png)
+switch to "Front-ends" tab.  
+![screenshot of Front-ends tab](../assets/frontends_tab.png)
 This page is designed to be self-explanatory and easy to use, while avoiding issues and pitfalls of AdminFE, but it's also early in development, everything is subject to change.
 
-!!! bug
-    As of PleromaFE 2.6.0 there is no feedback on whether frontend is installing, installed or failed to install, this will be fixed in PleromaFE 2.6.1.
-    
 !!! warning
     This goes without saying, but if you set default frontend to anything except >2.6.0 version of PleromaFE you'll lose the access to Admin Dashboard and will have to use AdminFE to get it back. See below on how to use AdminFE.
 
@@ -37,8 +36,9 @@ There is also no way to tell if there is an update available or not, for now you
 
 ## Using AdminFE to manage frontends
 
-Access AdminFE either directly by going to `/pleroma/admin` of your instance or by opening Admin Dashboard and clicking the link below  
-IMAGE HERE
+Access AdminFE either directly by going to `/pleroma/admin` of your instance or by opening Admin Dashboard and clicking the link at the bottom of the window  
+![link to open old AdminFE](../assets/old_adminfe_link.png)
+
 
 Go to Settings -> Frontend.
 
@@ -53,7 +53,7 @@ At the very top of the page there's a list of available frontends and button to
     **Available Frontends** section lets you _install_ frontends but **NOT** update/reinstall them. It's only useful for installing a frontend once.
     
 Due to aforementioned bug, preferred way of installing frontends in AdminFE is by clicking the "Install another frontend"  
-IMAGE HERE  
+![screenshot of admin-fe with instructions on how to install a frontend](../assets/way_to_install_frontends.png)
 and filling in the fields. Unfortunately AdminFE does not provide the raw data necessary for you to fill those fields, so your best bet is to see what backend returns in browser's devtools or refer to the [source code](https://git.pleroma.social/pleroma/pleroma/-/blob/develop/config/config.exs?ref_type=heads#L742-791). For the most part, only **Name**, **Ref** (i.e. version) and **Build URL** fields are required, although some frontends might also require **Build Directory** to work. 
 
 For pleroma-fe you can use either `master` or `develop` refs, or potentially any ref in GitLab that has artifacts for `build` job, but that's outside scope of this document.
@@ -61,7 +61,7 @@ For pleroma-fe you can use either `master` or `develop` refs, or potentially any
 ### Selecting default frontend
 
 Scroll page waaaaay down, search for "Frontends" section, subtitled "Installed frontends management", change the name and reference of the "Primary" frontend.  
-IMAGE HERE
+![screenshot of admin-fe with instructions on how to install a frontend](../assets/primary_frontend_section.png)
 
 
 !!! danger
diff --git a/docs/assets/admin_dash_location.png b/docs/assets/admin_dash_location.png
new file mode 100644
index 000000000..4e1d110e7
Binary files /dev/null and b/docs/assets/admin_dash_location.png differ
diff --git a/docs/assets/frontends_tab.png b/docs/assets/frontends_tab.png
new file mode 100644
index 000000000..f7c66adab
Binary files /dev/null and b/docs/assets/frontends_tab.png differ
diff --git a/docs/assets/old_adminfe_link.png b/docs/assets/old_adminfe_link.png
new file mode 100644
index 000000000..5ea6a486c
Binary files /dev/null and b/docs/assets/old_adminfe_link.png differ
diff --git a/docs/assets/primary_frontend_section.png b/docs/assets/primary_frontend_section.png
new file mode 100644
index 000000000..14c3de41b
Binary files /dev/null and b/docs/assets/primary_frontend_section.png differ
diff --git a/docs/assets/way_to_install_frontends.png b/docs/assets/way_to_install_frontends.png
new file mode 100644
index 000000000..a90ff2b5d
Binary files /dev/null and b/docs/assets/way_to_install_frontends.png differ
-- 
cgit v1.2.3


From 10525ac7f8ed4e3882a21d6cb3f1a7acfabc0674 Mon Sep 17 00:00:00 2001
From: Lain Soykaf <lain@lain.com>
Date: Tue, 28 Nov 2023 15:21:34 +0400
Subject: Docs: Remove rust references

---
 docs/installation/alpine_linux_en.md | 2 +-
 docs/installation/arch_linux_en.md   | 1 -
 docs/installation/debian_based_en.md | 2 +-
 docs/installation/debian_based_jp.md | 1 -
 docs/installation/freebsd_en.md      | 2 +-
 5 files changed, 3 insertions(+), 5 deletions(-)

(limited to 'docs')

diff --git a/docs/installation/alpine_linux_en.md b/docs/installation/alpine_linux_en.md
index 9794833a3..7154bca48 100644
--- a/docs/installation/alpine_linux_en.md
+++ b/docs/installation/alpine_linux_en.md
@@ -28,7 +28,7 @@ sudo apk upgrade
 * Install some tools, which are needed later:
 
 ```shell
-sudo apk add git build-base cmake file-dev rust
+sudo apk add git build-base cmake file-dev
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md
index dbfbf6bf8..f7d722ef9 100644
--- a/docs/installation/arch_linux_en.md
+++ b/docs/installation/arch_linux_en.md
@@ -14,7 +14,6 @@ This guide will assume that you have administrative rights, either as root or a
 * `base-devel`
 * `cmake`
 * `file`
-* `rust`
 
 #### Optional packages used in this guide
 
diff --git a/docs/installation/debian_based_en.md b/docs/installation/debian_based_en.md
index 44c93e1ef..b61e4addd 100644
--- a/docs/installation/debian_based_en.md
+++ b/docs/installation/debian_based_en.md
@@ -20,7 +20,7 @@ sudo apt full-upgrade
 * Install some of the above mentioned programs:
 
 ```shell
-sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev rust
+sudo apt install git build-essential postgresql postgresql-contrib cmake libmagic-dev
 ```
 
 ### Install Elixir and Erlang
diff --git a/docs/installation/debian_based_jp.md b/docs/installation/debian_based_jp.md
index 43902c987..1424ad7f4 100644
--- a/docs/installation/debian_based_jp.md
+++ b/docs/installation/debian_based_jp.md
@@ -21,7 +21,6 @@ Note: This article is potentially outdated because at this time we may not have
 - `build-essential`
 - `cmake`
 - `libmagic-dev`
-- `rust`
 
 #### このガイドで利用している追加パッケージ
 
diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index b88853dd1..02513daf2 100644
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -9,7 +9,7 @@ This document was written for FreeBSD 12.1, but should be work on future release
 This assumes the target system has `pkg(8)`.
 
 ```
-# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake rust vips
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake vips
 ```
 
 Copy the rc.d scripts to the right directory:
-- 
cgit v1.2.3


From bf57fd82bb3accd369b9bdb605e24c96134b18a9 Mon Sep 17 00:00:00 2001
From: Mark Felder <feld@feld.me>
Date: Wed, 20 Dec 2023 14:11:52 -0500
Subject: Clarify location of test.secret.exs file

---
 docs/development/setting_up_pleroma_dev.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs')

diff --git a/docs/development/setting_up_pleroma_dev.md b/docs/development/setting_up_pleroma_dev.md
index 8da761d62..ddf04cab1 100644
--- a/docs/development/setting_up_pleroma_dev.md
+++ b/docs/development/setting_up_pleroma_dev.md
@@ -38,7 +38,7 @@ config :logger, :console,
 
 ## Testing
 
-1. Create a `test.secret.exs` file with the content as shown below
+1. Create a `config/test.secret.exs` file with the content as shown below
 2. Create the database user and test database.
     1. You can use the `config/setup_db.psql` as a template. Copy the file if you want and change the database name, user and password to the values for the test-database (e.g. 'pleroma_local_test' for database and user). Then run this file like you did during installation.
     2. The tests will try to create the Database, so we'll have to allow our test-database user to create databases, `sudo -Hu postgres psql -c "ALTER USER pleroma_local_test WITH CREATEDB;"`
-- 
cgit v1.2.3