6 ./bin/pleroma_ctl frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]
12 mix pleroma.frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]
15 Frontend can be installed either from local zip file, or automatically downloaded from the web.
17 You can give all the options directly on the command line, but missing information will be filled out by looking at the data configured under `frontends.available` in the config files.
19 Currently, known `<frontend>` values are:
21 - [admin-fe](https://akkoma.dev/AkkomaGang/admin-fe)
22 - [mastodon-fe](https://akkoma.dev/AkkomaGang/masto-fe)
23 - [pleroma-fe](https://akkoma.dev/AkkomaGang/pleroma-fe)
24 - [soapbox-fe](https://gitlab.com/soapbox-pub/soapbox-fe)
26 You can still install frontends that are not configured, see below.
28 ## Example installations for a known frontend
30 For a frontend configured under the `available` key, it's enough to install it by name.
35 ./bin/pleroma_ctl frontend install pleroma-fe
41 mix pleroma.frontend install pleroma-fe
44 This will download the latest build for the pre-configured `ref` and install it. It can then be configured as the one of the served frontends in the config file (see `primary` or `admin`).
46 You can override any of the details. To install a Pleroma-FE build from a different URL, you could do this:
51 ./bin/pleroma_ctl frontend install pleroma-fe --ref 2hu_edition --build-url https://example.org/raymoo.zip
57 mix pleroma.frontend install pleroma-fe --ref 2hu_edition --build-url https://example.org/raymoo.zip
60 Similarly, you can also install from a local zip file.
65 ./bin/pleroma_ctl frontend install pleroma-fe --ref mybuild --file ~/Downloads/doomfe.zip
71 mix pleroma.frontend install pleroma-fe --ref mybuild --file ~/Downloads/doomfe.zip
74 The resulting frontend will always be installed into a folder of this template: `${instance_static}/frontends/${name}/${ref}`.
76 Careful: This folder will be completely replaced on installation.
78 ## Example installation for an unknown frontend
80 The installation process is the same, but you will have to give all the needed options on the command line. For example:
85 ./bin/pleroma_ctl frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
91 mix pleroma.frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
94 If you don't have a zip file but just want to install a frontend from a local path, you can simply copy the files over a folder of this template: `${instance_static}/frontends/${name}/${ref}`.