Skip to main content

User Management

This documentation provides instructions on user management for the GameVault server. User management involves configuring the initial admin user, enabling/disabling user registration, managing user activation, and assigning roles. These features are crucial for controlling user access, maintaining security, and administering the server effectively.

Admin User

Initial Setup

warning

GameVault does not register the first admin account for you. You will need to do that yourself.

To configure the initial admin user for the GameVault server, you can utilize Docker environment variables. By setting the SERVER_ADMIN_USERNAME environment variable to the desired username for the admin user and afterwards manually registering that user in the GameVault App, you can create the initial admin user account.

For example:

SERVER_ADMIN_USERNAME=xX_NoobSl4yer_Xx

Once the admin user is configured and registered, you can proceed with user registration, activation, and role assignment.

Automatic Admin Permissions

Upon registration of the initial admin user, the GameVault server will automatically grant administrative permissions to the user. This ensures that the admin user has the necessary privileges to administrate the server.

Recovering Access to Admin User after Role Misconfiguration

If the admin user was misconfigured to not have admin permissions or if the user already exists, the server will automatically grant admin permissions to that user upon startup. This ensures that the admin user has the correct permissions even if there are configuration errors or existing users.

Recovering Access to Admin User after Password Loss

In the event that the server owner gets locked out of the admin user account due to password loss or other reasons, the GameVault Server provides a way to recover access.

To regain access, set the SERVER_ADMIN_PASSWORD environment variable to the desired password for the admin user.

For example:

SERVER_ADMIN_PASSWORD=hunter2

Upon the next startup of the GameVault server, the admin user's password will be updated to the specified password, allowing the user to regain access.

User Registration

GameVault offers a user registration feature that allows new users to create accounts and gain access to the application. However, in certain scenarios where tighter control over user access is required, you have the option to disable user registration.

By setting the SERVER_REGISTRATION_DISABLED environment variable to true, you can easily disable user registration in GameVault. Disabling registration prevents new users from creating accounts and accessing the application.

This feature provides administrators with flexibility and control over user onboarding, ensuring that only approved users can utilize the application.

User Activation

In GameVault, the activation process is a crucial step to authorize and activate new user accounts. By default, newly registered users are required to be activated by an administrator before they can fully utilize the application.

Unactivated users have limited rights, even less than that of a guest. They are unable to access certain locked APIs within GameVault. Activation ensures that only authorized individuals can interact with the application and its sensitive functionalities.

Admins, with their highest level of control, are exempt from activation checks. They can activate new users through the admin panel within the GameVault application.

However, if you wish to bypass the mandatory activation step and allow new users to immediately gain full access to GameVault, you can disable the activation process. Simply set the SERVER_ACCOUNT_ACTIVATION_DISABLED environment variable to true. This activates users automatically upon registration, removes the activation requirement and grants immediate access to new users.

User Roles

Roles play a crucial role in ensuring the security and proper functioning of the GameVault server. They determine the permissions and access levels granted to users within the application.

GameVault implements the following roles:

RoleDescriptionLevel
GuestThis role allows users to view all content within the application.1
Users (Default)This role includes permissions such as downloading games, creating progresses, and editing the user's own profile.2
EditorsEditors have the ability to edit and remap games within the application.3
AdminsAdmins possess full control over user management and can edit user profiles.4

By assigning appropriate roles to users, you can ensure that they have the necessary access and privileges based on their responsibilities.