Frontend Management

Frontends in Akkoma are swappable, you can pick which you'd like.

For a basic setup, you can set a frontends for the key primary and admin and the options of name and ref. This will then make Akkoma serve the frontend from a folder constructed by concatenating the instance static path, frontends and the name and ref.

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, you will not have any frontend at all.

Example:

config :pleroma, :frontends,
  primary: %{
    "name" => "pleroma",
    "ref" => "stable"
  },
  admin: %{
    "name" => "admin",
    "ref" => "develop"
  }

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 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.

If you choose not to install a frontend for whatever reason, it is recommended that you enable :static_fe to allow remote users to click "view remote source". Don't bother with this if you've got no unauthenticated access though.

You can also replace the default "no frontend" page by placing an index.html file under your instance/static/ directory.

Swagger (openAPI) documentation viewer

If you're a developer and you'd like a human-readable rendering of the API documentation, you can enable Swagger UI.

In your config:

config :pleroma, :frontends,
  swagger: %{
    "name" => "swagger-ui",
    "ref" => "stable",
    "enabled" => true
  }

Then run the pleroma.frontend cli task with the name of swagger-ui to install the distribution files.

You will now be able to view documentation at /akkoma/swaggerui

2.3 KiB Raw Blame History

Frontend Management

Swagger (openAPI) documentation viewer

2.3 KiB

Raw Blame History