Installing pl-fe as Pleroma/Akkoma frontend

Installation in instance static directory

The most straightforward way to install pl-fe as a frontend for Pleroma or Akkoma is to simply download it and place its files in the /instance/static directory of your Pleroma/Akkoma installation (usually /opt/pleroma/instance/static or /opt/akkoma/instance/static, accordingly).

curl -O https://pl.mkljczk.pl/pl-fe.zip
unzip pl-fe.zip -d /opt/pleroma/instance/static/
rm pl-fe.zip

Installation via Pleroma/Akkoma frontend management

It is also possible to use the Pleroma frontend management tool. You can find more information about it in the Pleroma documentation. On Pleroma, you can use either the PleromaFE built-in admin dashboard or the older AdminFE to install pl-fe and set it as the server frontend. You don't have to provide any URL. It's right there in Pleroma.

On Akkoma, however, there is no pl-fe in the default available frontends list (yet?). You can still install it, but you need to explicitly provide the URL to pl-fe. To install it from CLI, use:

OTP

./bin/pleroma_ctl frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir .

From Source

mix pleroma.frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir .

It is now possible to set pl-fe as the primary frontend in the configuration file or via AdminFE:

config :pleroma, :frontends,
  primary: %{
    "name" => "pl-fe",
    "ref" => "develop"
  },
  ...

On Akkoma, it is also possible for individual users to select their preferred frontend to pl-fe by visiting /akkoma/frontend page on their Akkoma instance.