Fediversity Panel

Get started

This guide tells how to log in, make a deployment, deploy it, open its applications and set the password of its administrator.

Log in

Open the panel and click the login link. If your hosting provider has single sign-on, use "Log in with ..." and log in with your hosting provider account. Otherwise, use the local account that your hosting provider gave you.

The navigation and the first pages are in English, Dutch, German and French. The panel shows the language of your browser. To use a different language, select it in the language list at the top of the page, then select "Change language". The other pages are in English.

The "Start" page shows the steps below:

Make a deployment

A deployment is one set of applications under one domain.

  1. Go to "Deployments", and click "New deployment".

  2. Give the deployment a name.

  3. Fill in the settings. Make sure to set:

    • the email address of the administrator. Your deployment sends the password-reset link of its administrator account to this address (see Set your administrator password).
    • the domain. Your applications use subdomains of it. Make sure that the domain is available, for example with an ICANN lookup. The deployment registers the domain for you.
    • the applications that you want, with "enable".

  4. Option click "Validate" to find errors in the form before you deploy. Click "Save" to keep your changes without a deploy.

The operator configuration page tells what each setting does.

To change the settings of one application only, click its settings link on the "Instances" page. This form shows a part of the same deployment:

Deploy

  1. Click "Deploy". The panel saves the configuration and starts the deploy.
  2. Wait. The state of the deployment changes from building to deploying, and then to active. The "Deployments" page shows the state and the time of the last build.
  3. If the deploy fails, the panel shows the end of the log of the build. Correct the cause, and click "Deploy" again.

When the zone of your domain is in a deSEC account of your own, open "Own deSEC token" and give a token of that account before you click "Deploy". The deploy then writes the records of your zone with that token, and the hosting provider does not make a token. The token must be able to write the records of the deployment. The panel does not show the token again. A later deploy keeps it while the domain does not change: leave the field empty. To use a different token, give it with the next deploy. A delete of the deployment does not delete the token at deSEC.

The first deploy of a new domain takes the longest, because it can register the domain and gets its TLS certificates.

The "History" table on the page of a deployment shows the last actions on the deployment, as deploys, cancels, changes of the automatic updates and deletes: when, by which account, and if the panel accepted or refused the action, with the reason of a refusal.

The "History of your actions" link on your account page shows the last 100 actions of your account on all your deployments, newest first, also the actions that the panel refused and the actions on deployments that you deleted.

After a deploy succeeds, the "Software bill of materials" link on the page of the deployment shows each node of the deployment. When the SBOM of a node is ready, you can download it: a CycloneDX JSON file that lists the software of the node. The deploy of a node makes its SBOM, and a node that a deploy does not change keeps its SBOM. A node without an SBOM shows unavailable with the reason.

Open your applications

Go to "Instances". Each deployment shows a card for each application, with a link to the site of the application. The changed tag tells that the saved configuration of the application is different from the deployed one: deploy again to apply it.

Each deployment also has Grafana, at grafana.<your domain>. It shows the CPU, memory, disk and network that your deployment uses, and the state of your applications. Log in with an account in the fediversity-admins group, such as operator.

Set your administrator password

Each deployment has its own single sign-on (SSO), with Authelia at auth.<your domain>. Its administrator account has the user name operator and starts without a password:

  1. Open https://users.<your domain>/reset-password/step1.
  2. Enter operator.
  3. Open the link in the email that the deployment sent to the address you set.
  4. Set a password.

Use the same page to reset this password later. The "Reset password?" link at auth.<your domain> does not work for this account, because the account can manage users in lldap.

After this, log in to your applications with their SSO or OpenID Connect (OIDC) login option. The same account works in all of them.