Add documentation for frontend removal

This commit is contained in:
FloatingGhost 2022-07-07 19:23:02 +01:00
parent b2860aeb97
commit 22f614b4ef
3 changed files with 12 additions and 6 deletions

View File

@ -9,14 +9,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
### Added
- Added move account API
- Added ability to set instance accent-color via theme-color
- A fallback page for when a user does not have a frontend installed
### Removed
- SSH frontend, to be potentially re-enabled via a bridge rather than wired into the main system
- Gopher frontend, as above
- All pre-compiled javascript
### Fixed
- ES8 support for bulk indexing activities
### Upgrade Notes
- The bundled frontend has been removed, you will need to run the `pleroma.frontend install` mix task to install your frontend of choice. Configuration by default is set to `pleroma-fe`.
## 2.5.2
### Added

View File

@ -718,10 +718,7 @@ config :pleroma, :static_fe, enabled: true
# available: %{...}
config :pleroma, :frontends,
mastodon: %{
"name" => "mastodon-fe",
"ref" => "develop"
},
primary: %{"name" => "pleroma-fe", "ref" => "develop"},
available: %{
"pleroma-fe" => %{
"name" => "pleroma-fe",
@ -730,7 +727,7 @@ config :pleroma, :frontends,
"ref" => "develop",
"build_dir" => "dist"
},
# mastodon-Fe cannot be set as a primary - this is only here so we can update this seperately
# Mastodon-Fe cannot be set as a primary - this is only here so we can update this seperately
"mastodon-fe" => %{
"name" => "mastodon-fe",
"git" => "https://akkoma.dev/AkkomaGang/masto-fe",

View File

@ -1096,7 +1096,7 @@ You can set a frontends for the key `primary` and `admin` and the options of `na
The key `primary` refers to the frontend that will be served by default for general requests. The key `admin` refers to the frontend that will be served at the `/pleroma/admin` path.
If you don't set anything here, the bundled frontends will be used.
If you don't set anything here, you will not have _any_ frontend at all.
Example:
@ -1114,6 +1114,10 @@ config :pleroma, :frontends,
This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.
Refer to [the frontend CLI task](../administration/CLI_tasks/frontend) for how to install the frontend's files
If you wish masto-fe to also be enabled, you will also need to run the install task for `mastodon-fe`. Not doing this will lead to the frontend not working.
### Theme settings
Settings to change theme as exposed to the outside world, for software