Creating an admin user

QruiseOS is a multi-user platform with a built-in access management system. Not every user has the same privileges, and as in any system, you need users with elevated access. Before anything else, therefore, you need to create a tenant admin user. Please read this section carefully before proceeding.

Creating a user in Keycloak

QruiseOS uses Keycloak to manage user accounts. To add a user in Keycloak, navigate to the Keycloak dashboard and enter the admin credentials that you selected during QruiseOS installation:

Keycloak dashboard URL

If you are working on the same physical machine where QruiseOS is installed (or you have an ssh connection to it), the default Keycloak URL is http://localhost:8080/.

After logging in, you will see the realm selector button in the top left corner. Click on it to reveal a drop down menu, then click on "qruise":

After being redirected to the qruise realm, click on "Users" in the menu on the left:

Now you should see the user management page for the qruise realm with one user already added, i.e. qruiseadmin. This is a system user and must not be modified.

The qruiseadmin user

Modifying the qruiseadmin user can render your QruiseOS installation inoperable.

You can now click on the "Add user" button to create a new user:

In the page that opens, please fill the user details. It's enough to provide just the username - the user will be asked to provide the rest during their first login attempt. Optionally, you can toggle the "Email verified" slider to skip email verification. After you are done, click the "Create" button:

Keycloak should now display a success message and redirect you to a page where you can manage the newly-created user. From here, you can create a password for them by clicking on the credentials tab:

To create a new password for the user, click on the "Set password" button as indicated by the arrow:

You can now enter the password in the dialog window. You can also toggle the "Temporary" slider to decide if the password is temporary and must be changed by the user on first login attempt.

Temporary passwords

Using temporary passwords for newly-created users is a good security practice. Particularly if you are creating this user account for someone other than yourself, then you have to share this password with them over some platform like email or team chat; and the Temporary toggle ensures that they change it on first login.

After typing the password, click the "Save" button to confirm:

Transferring admin rights to QruiseOS

To finalise the creation of an admin user, login to QruiseOS dashboard with it.

First login

Tenant administrator rights are granted to the first user to log in to the QruiseOS dashboard after installation. It is therefore paramount that the admin account created in the previous step is the first to log in.

Start by opening the QruiseOS dashboard in your web browser. It should automatically redirect you to the login page.

Dashboard URL

If you are working on the same physical machine where QruiseOS is installed (or you have an ssh connection to it), the default dashboard URL is http://localhost:3000/.

In the login page, enter the username and password for the admin user you created in Keycloak, and then click on the "Sign In" button:

After logging in, you might be asked to enter a new password, depending on the choice you made during user creation. If this is the case, enter a permanent password and proceed. After doing so, you will be redirected to the QruiseOS dashboard, and the user account will be granted admin permissions.