git.squeep.com Git - akkoma/blob - docs/administration/CLI_tasks/frontend.md

   1 # Managing frontends
   2
   3 `mix pleroma.frontend install <frontend> [--ref <ref>] [--file <file>] [--build-url <build-url>] [--path <path>] [--build-dir <build-dir>]`
   4
   5 Frontend can be installed either from local zip file, or automatically downloaded from the web.
   6
   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.
   8
   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)
  15
  16 You can still install frontends that are not configured, see below.
  17
  18 ## Example installations for a known frontend
  19
  20 For a frontend configured under the `available` key, it's enough to install it by name.
  21
  22 ```sh tab="OTP"
  23 ./bin/pleroma_ctl frontend install pleroma
  24 ```
  25
  26 ```sh tab="From Source"
  27 mix pleroma.frontend install pleroma
  28 ```
  29
  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`).
  31
  32 You can override any of the details. To install a pleroma build from a different url, you could do this:
  33
  34 ```sh tab="OPT"
  35 ./bin/pleroma_ctl frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
  36 ```
  37
  38 ```sh tab="From Source"
  39 mix pleroma.frontend install pleroma --ref 2hu_edition --build-url https://example.org/raymoo.zip
  40 ```
  41
  42 Similarly, you can also install from a local zip file.
  43
  44 ```sh tab="OTP"
  45 ./bin/pleroma_ctl frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
  46 ```
  47
  48 ```sh tab="From Source"
  49 mix pleroma.frontend install pleroma --ref mybuild --file ~/Downloads/doomfe.zip
  50 ```
  51
  52 The resulting frontend will always be installed into a folder of this template: `${instance_static}/frontends/${name}/${ref}`
  53
  54 Careful: This folder will be completely replaced on installation
  55
  56 ## Example installation for an unknown frontend
  57
  58 The installation process is the same, but you will have to give all the needed options on the commond line. For example:
  59
  60 ```sh tab="OTP"
  61 ./bin/pleroma_ctl frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
  62 ```
  63
  64 ```sh tab="From Source"
  65 mix pleroma.frontend install gensokyo --ref master --build-url https://gensokyo.2hu/builds/marisa.zip
  66 ```
  67
  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}`
  69