3 `mix pleroma.frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]`
5 Frontend can be installed either from local zip file, or automatically downloaded from the web.
7 You can give all the options directly on the command like, but missing information will be filled out by looking at the data configured under `frontends.available` in the config files.
9 Currently known `<frontend>` values are:
10 - [admin-fe](https://git.pleroma.social/pleroma/admin-fe)
11 - [kenoma](http://git.pleroma.social/lambadalambda/kenoma)
12 - [pleroma-fe](http://git.pleroma.social/pleroma/pleroma-fe)
13 - [fedi-fe](https://git.pleroma.social/pleroma/fedi-fe)
14 - [soapbox-fe](https://gitlab.com/soapbox-pub/soapbox-fe)
16 You can still install frontends that are not configured, see below.
18 ## Example installations for a known frontend
20 For a frontend configured under the `available` key, it's enough to install it by name.
23 ./bin/pleroma_ctl frontend install pleroma
26 ```sh tab="From Source"
27 mix pleroma.frontend install pleroma
30 This will download the latest build for the 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`).
32 You can override any of the details. To install a pleroma build from a different url, you could do this:
35 ./bin/pleroma_ctl frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
38 ```sh tab="From Source"
39 mix pleroma.frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
42 Similarly, you can also install from a local zip file.
45 ./bin/pleroma_ctl frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
48 ```sh tab="From Source"
49 mix pleroma.frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
52 The resulting frontend will always be installed into a folder of this template: `${instance_static}/frontends/${name}/${ref}`
54 Careful: This folder will be completely replaced on installation
56 ## Example installation for an unknown frontend
58 The installation process is the same, but you will have to give all the needed options on the commond line. For example:
61 ./bin/pleroma_ctl frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
64 ```sh tab="From Source"
65 mix pleroma.frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
68 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}`