Skip to main content

Permissions

Permissions are named capabilities such as apps.deploy. Every page and action in the panel checks one. People get them through roles (see Users and roles). The built-in admin role always holds every permission and cannot be edited; the super user (the first account) passes every check.

note

This page is generated from the permission list in the panel's code, so it matches the version it was written for. The same list, with the same explanations, is under Permissions in the panel.

Apps​

PermissionWhat it allows
apps.view
View apps
See the list of apps, their releases, logs, settings and domains. Environment variable values are never shown.
apps.create
Create apps
Create new apps with the setup wizard, including connecting a repository or uploading a project.
apps.update
Change app settings
Change an app's name, source, port, health check and resource limits; generate its deploy key; upload a new project archive.
apps.deploy
Deploy and roll back
Start deployments and roll an app back to an earlier release. Deploying runs the app's code on this server.
apps.control
Start, stop and restart apps
Stop an app's running container, start it again and restart it. Its domains stay configured; visitors see an error while it is stopped.
apps.nginx
Edit nginx directives
Add custom nginx directives to an app's site: upload limits, timeouts, headers, redirects and extra locations. Only a list of safe directives is accepted and nginx tests the result before it is applied, but the app's traffic goes through it.
apps.logs
Read app logs
Read and download the output of an app's running container. Apps often print secrets, such as tokens or personal data, into their logs, and a download is recorded in the audit log.
apps.volumes
Browse volume files
See how much space an app's persistent volumes use, look at their files and download them. Volumes often hold databases, uploads and other private data, and a download is recorded in the audit log.
apps.terminal
Open a terminal in an app
Run commands in a shell inside an app's running container, with the app's environment variables (often secrets such as database passwords) and its volumes. Asks for the password unless it was confirmed recently, and opening one is recorded in the audit log. This is close to full control of the app.
apps.deactivate
Deactivate and activate apps
Take an app offline without deleting it, and bring it back.
apps.delete
Delete apps
Permanently delete an app with its releases, images, domains, certificate and variables.
env.manage
Manage environment variables
Add, replace, import and remove an app's environment variables. These often hold secrets such as database passwords.
apps.links
Link apps to databases and other apps
Let an app reach a database, or another app, over a private network made for that link. A linked app can use the database it is given, and its connection details are added to its environment variables.

Domains​

PermissionWhat it allows
domains.view
View domains
See every domain with its DNS and HTTPS state.
domains.manage
Manage domains and certificates
Add domains to apps, set redirects, re-check DNS, remove domains and request certificates.
domains.settings
Change HTTPS and server address
Accept the Let's Encrypt terms, set the server's public address and the panel's own domain.

Databases​

PermissionWhat it allows
databases.view
View databases
See the database servers, the databases on them and which apps use them. Passwords and connection strings are not shown.
databases.manage
Manage databases
Create, start, stop and delete database servers, and create, drop and change the password of databases on them. Deleting a server deletes the data of every database on it.
databases.credentials
See database passwords
Show a database's password and connection string. Asks for the password unless it was confirmed recently, and every time it is shown is recorded in the audit log.
databases.remote
Open databases to the internet
Make a database server reachable from chosen IP addresses on the internet for a limited time (or without end), and close it again. Anyone who holds a database password and comes from an allowed address can then connect. Asks for the password unless it was confirmed recently, and every change is recorded in the audit log as a high-risk action.
databases.tools
Open databases in phpMyAdmin or pgAdmin
Open a database in phpMyAdmin (MySQL, MariaDB) or pgAdmin (PostgreSQL), logged in as that database's own user: read, change and delete its data, run SQL and import or export dumps. Asks for the password unless it was confirmed recently, and every opening is recorded in the audit log. Treat it like the database's password.

Server​

PermissionWhat it allows
backups.view
View backups
See the list of the panel's backups, when they were made and how big they are.
backups.manage
Manage backups
Take a backup now, download one and delete one. A backup holds everything in the panel's database, including the encrypted secrets of apps and databases, so downloading asks for the password and is recorded in the audit log.
github.manage
Connect GitHub
Create the panel's GitHub App, install it on an account and disconnect it. The app can read the code of the repositories you give it access to on GitHub, and anyone who may create apps can then deploy those repositories.
notifications.manage
Manage deployment messages
Choose where the result of deployments is sent (Slack, Discord or any webhook), send a test message and switch it off. The address is stored encrypted and never shown again; the messages hold the app, commit and error, never logs or secrets.
server.view
View the server
See host resources, service states, Docker and nginx status.
server.manage
Manage Docker and nginx
Reload nginx, test its configuration, remove unused images and read container logs.

Access​

PermissionWhat it allows
tokens.manage
Manage own API tokens
Create and revoke your own API tokens for scripts and CI. A token can only do what you may do yourself (read apps, start deployments), optionally limited to some apps, and stops working if you lose that permission. Creating and revoking ask for your password and are recorded in the audit log.
roles.view
View roles
See the roles and which permissions they grant.
roles.manage
Manage roles
Create, edit and delete roles. A role can only grant permissions you hold yourself.
permissions.view
View permissions
See the list of permissions and what each one allows.
audit.view
View the audit log
Read the record of who did what on this panel.

Users​

PermissionWhat it allows
users.view
View users
See the list of user accounts and their roles.
users.create
Create users
Create accounts. A user can only be given a role that grants no more than the creator has.
users.update
Update users
Change a user's name, email, password and role. Not the super user, and not users with more access than you have.
users.delete
Delete users
Delete accounts. Not the super user, yourself, or users with more access than you have.