Manage a deployment
This guide tells how to run the operations of an application, manage the users of a deployment, and change or remove a deployment.
Run an operation
Some functions of an application are only available on its command line. For these, the settings page of the application has a section "Operations". An operation runs one time in the node of the application, and does not change the configuration of the deployment.
Open an operation, fill in its form and click "Run". The page shows the output when the operation stops. If the output can show a secret, such as a new password, you can read it one time only.
The section "Operation log" shows the last runs, with their exit codes and their output.
Back up and restore an application
Each application has these operations:
- "Back up now" starts all backups of the application: the database, the local cache and the files. The media in the object storage has its own daily backup. The backups also run each day without this operation.
- "List backups" shows the state of each backup, its snapshots with the newest first, and the result of the last restore. It shows no snapshots of a part while a restore of that part runs.
- "Restore a backup" restores one part from one snapshot. Enter the part and the ID of the snapshot, as "List backups" shows them. The application stops during the restore and starts again after it. Changes after the snapshot are lost.
"Back up now" and "Restore a backup" stop when the work has started, and the work continues after the page closes. Use "List backups" to see when the work stops. You cannot start a second restore while one runs. A restore of the files writes the files of the snapshot, and keeps a file that the snapshot does not have.
Manage the users of your deployment
The users of your deployment are in its lldap directory, at
https://users.<your domain>/. Log in there as operator. You
can add users there, e.g. for when your applications do not allow public
sign-up.
The groups that are important:
| Group | What a member can do |
|---|---|
authelia-users |
Log in through SSO to the applications of the deployment. Add each new user to this group. |
fediversity-admins |
Use the administration tools of the deployment. Give this group only to people who administer it. |
lldap_admin |
Manage users and groups in lldap. |
application-admins |
Have the administrator role in each application of your deployment. |
application-moderators |
Have the moderator role in each application that has this role. Pixelfed does not have it. |
mastodon-owners |
Have the Owner role in Mastodon. |
mastodon-admins |
Have the Admin role in Mastodon. |
mastodon-moderators |
Have the Moderator role in Mastodon. |
pixelfed-admins |
Have the administrator role in Pixelfed. |
peertube-admins |
Have the Administrator role in PeerTube. |
peertube-moderators |
Have the Moderator role in PeerTube. |
A role group is there only when an application in your deployment uses it. Use
application-admins and application-moderators to give a role in all the
applications, and the group of an application to give a role in that application
only. When a user is in more than one of these groups, the highest role applies
in each application. fediversity-admins gives no role in an application. An
application gives the role of a group some minutes after you
add a user to the group, and removes it some minutes after you remove the user.
The user must log in to the application one time first. PeerTube logs the user
out when the role changes. A role that you give in the administration pages of
an application changes back to the role of the groups.
A new user sets a password with "Reset password?" at auth.<your domain>. A
member of lldap_admin sets a password the same way as operator.
Change or remove a deployment
- To change a deployment, click "Edit" on the "Deployments" page, change the settings, and click "Deploy".
- To start from a copy of a deployment, click "Duplicate". Change the domain of the copy before you deploy it.
- To remove a deployment and all of its applications and data, click "Delete", and confirm. You cannot undo this. The registration of its domain stays with your hosting provider.