Skip to main content

🗃️ PocketBase

Enable PocketBase Web UI​

Ludus uses PocketBase as part of the backend to manage data. By default, the PocketBase web UI is disabled to prevent users from modifying the database directly which can cause unintended consequences.

However, there are use cases that require an administrator to access the database and manipulate it directly or view logs.

To do this, the administrator can enable the PocketBase UI by running the following commands on your Ludus host.

systemctl set-environment LUDUS_ENABLE_SUPERADMIN=ill-be-careful
systemctl restart ludus

You can then browse to the PocketBase admin page at https://<Ludus IP>:8080/admin

Log in with the username root@ludus.internal and the password the full ROOT API key from /opt/ludus/install/root-api-key.

The PocketBase login screen

Disable PocketBase Web UI​

You can disable the pocketbase web interface by running the following commands

systemctl unset-environment LUDUS_ENABLE_SUPERADMIN
systemctl restart ludus

Logs in PocketBase​

If there is a critical error in Ludus (i.e. a panic) it may only log in PocketBase and present a standard error to the user.

[ERROR] Check the PocketBase logs for crash details

When this occurs, log into pocket base and click the Logs icon on the left.

The PocketBase Logs icon

Then find the error in the log stream, click it, and investigate.