Single Sign-on (SSO) is a feature of Cloudron where users can use the same credentials (username & password) for logging in to apps.
SSO integration is optional and can be selected at the time of app installation. Turning off SSO can be beneficial when the app is meant to be used primarily by external users (for example, a community chat or a public forum).
Note that some apps do not support Cloudron SSO. Such apps manage their user credentials on their own and users have to be managed inside the app itself.
When SSO is available for an app, the user management options will look like below:
Leave user management to the app is selected, the app's Cloudron SSO integration will be disabled
and all user management has to be carried from within the app. This is useful when the app primarily caters
to external users (like say a community chat).
When SSO integration is unavailable for an app, the user management options look like below:
New users can be added to the Cloudron with their email address from the
New User to add a new user:
They will receive an invite to sign up. Once signed up, they can access the apps they have been given access to.
To remove a user, simply remove them from the list. Note that the removed user cannot access any app anymore.
The following characters are allowed in usernames:
- Alphanumeric characters
- '.' (dot)
- '-' (hyphen)
Usernames must be chosen with care to accomodate the wide variety of apps that run on Cloudron.
For example, very generic words like
404 might be reserved by apps.
Groups provide a convenient way to group users. You can assign one or more groups to apps to restrict who can access for an app.
You can create a group by using the
Groups menu item.
New Group to add a new group:
To set the access restriction use the app's configure dialog.
Valid group names
The following characters are allowed in group names:
- Alphanumeric characters
- '.' (dot)
- '-' (hyphen)
Roles provide a way to restrict the permissions of a user. You can assign a role from the
A Cloudron user can login to the Cloudron dashboard and use the apps that they have access to. They can edit their profile (name, password, avatar) on the dashboard.
To allow a user to configure and manage specific apps, see the App Operator feature.
A User Manager can add, edit and remove users & groups. Newly added users always get the
User Manager cannot modify the role of an existing user.
A Cloudron administrator can manage apps and users. Note that an admin can login to any app even
if they have not been explicitly granted access in the
Access Control section.
If you only want to make a user configure and manage specific apps, use the App Operator feature.
A Cloudron owner has the capabilities of administrator with the addition of the ability to manage the Cloudron subscription, manage backup settings and configure branding.
A good way to think about the owner role is a person who is in charge of server administration and billing.
When clicking the
Manage Subscription button in the
Settings view, they are automatically logged
in to the cloudron.io account.
A common situation is to be able to pre-setup applications on behalf of a new user. In some cases, the user has to login to an app first before they can be added to a channel/group/team or given specific permissions.
For such situations, the Cloudron admin can use the
Impersonate button to generate a password that lets a Cloudron
login as another user. The password is time limited and can be used to login to the Cloudron dashboard and the apps.
Clicking the button will show a temporary password:
Does not reset existing password
The temporary password does not overwrite the user's existing password.
Password reset (link)
Users & Admins can reset their own passwords from the login screen.
https://my.example.com/login.html?passwordReset is a direct link.
Admins can also email a password reset link for other users by clicking on the
Reset password button.
This will open up a dialog showing the password reset link. If email delivery is not working for some reason, the link can be sent to the user by some other means.
Password reset (ssh)
A temporary one-time use password for the owner account can be generated by SSHing into the server:
# sudo cloudron-support --owner-login Login as superadminname / mW5x5do99TM2 . Remove /home/yellowtent/platformdata/cloudron_ghost.json when done.
The above password also bypasses any 2FA and can thus be used in situations where the owner has lost the 2FA device.
Admins can require all users to set up two factor authentication by enabling the Mandatory 2FA setting.
To enable, use the setting in the
When enabled, all new users will be forced to setup a 2FA during sign up. Existing users will be forced to setup 2FA when they login or reload the dashboard page.
If a user loses their 2FA device, the Cloudron administrator can disable 2FA in the user's edit dialog.
Once disabled, user can login with just their password. After login, they can re-setup 2FA.
If the owner of Cloudron has lost their 2FA device, see the password reset section to generate a one-time use password that will bypass 2FA.
To disable a user, uncheck the
User is active option. Doing so, will invalidate all
existing Cloudron dashboard session of the user and will log them out. The user may
still be able to use any apps that they were logged into prior to the de-activation.
To log them out from the apps, you can check if the app provides a way to log them out
(support for this depends on the app).
Disabling does not delete user data
Disable a user only blocks the login access for the user. Any data generated by the user inside apps is not deleted.
Admins can disallow users from changing their email and full name by locking user profiles. To
lock the profile, simple uncheck the setting in the
One can create a file named
/home/yellowtent/platformdata/cloudron_ghost.json which contains an username
and a fake password like:
With such a file in place, you can login to the Webadmin UI using the above credentials (the user has to already exist). This helps you debug and also look into how the UI might look from that user's point of view.
The LDAP connector allows users from your existing LDAP or active directory to authenticate with Cloudron. Each user account from the external directory will be automatically created on Cloudron and kept up-to-date.
Optionally groups can also be synced. Externally defined groups will be automatically created and users will be associated. Currently groups removed from the external source will not be deleted on the Cloudron during a sync.
For the moment, user synchronisation has to be manually triggered from within the dashboard using the Synchronize button. A future release will synchronize users periodically.
The External LDAP sever configuration is set in the
The following screenshot shows the available configure options using a jumpcloud external LDAP directory:
ou=users, o=3214565, dc=jumpcloud, dc=com
To use the Okta integration, do the following:
In Okta, enable the LDAP interface. You can do this from the
By default, Okta uses email as the default uid. Cloudron requires usernames for LDAP integration to work. If you already have a field in Okta that can provide usernames, provide that as the
username field. If not, you can create a new field in the profile editor and set that.
Cloudron configuration (replace 'org' below):
ou=users, dc=<org>, dc=okta, dc=com
uid=<admin>, dc=<org>, dc=okta, dc=com
Username field: see above