Default Admin User
Manage the default admin user credentials and access settings.
Last updated
Was this helpful?
Manage the default admin user credentials and access settings.
During installation, Connectware creates a default administrator user to ensure immediate system access. This user is named admin and has the connectware-admin role assigned to provide comprehensive permissions.
We strongly recommend changing the initial admin username and password after the first login. The configuration parameters described below only set the password during initial installation and cannot be used to change it afterwards. See Changing Usernames and Changing User Passwords.
The following configuration parameters are available for configuring the admin user.
Parameters differ between Kubernetes and Docker deployments. An important difference is that Kubernetes Helm installations generate a random password when initialPassword is not set, whereas Docker installations use the static default password admin.
global.authentication.adminUser.initialPassword
Sets the initial password for the admin user. Must be a plain-text string.
Random Password
global.authentication.adminUser.existingSecret
Name of an existing Kubernetes Secret containing the initial password. The Secret must have a key named initialPassword with a Base64-encoded password value. See Using an Existing Kubernetes Secret for the Initial Admin Password.
Not set
global.authentication.adminUser.enabled
Enables/disables the admin user. Accepts a boolean value (true or false). See Disabling the Default Admin User.
true
CYBUS_INITIAL_ADMIN_USER_PASSWORD
Sets the initial password for the admin user. Must be a Base64-encoded string.
admin
CYBUS_ADMIN_USER_ENABLED
Enables/disables the admin user. Accepts a boolean value (true or false). See Disabling the Default Admin User.
true
Before disabling the default admin user, ensure you have created at least one other user with full administrative permissions. Otherwise, you may lose administrative access to your Connectware installation.
You can disable the default admin user after creating custom users that have admin permissions.
If the global.authentication.adminUser.enabled Helm value (Kubernetes) or the CYBUS_ADMIN_USER_ENABLED environment variable (Docker) is not set, or if it has a value other than false, the default admin user is enabled and can log in with suitable credentials.
Open the values.yaml file.
Set the global.authentication.adminUser.enabled Helm value to false.
global:
authentication:
adminUser:
enabled: falseUpgrade your Helm chart to apply the Helm configuration changes. For details, see Applying Helm Configuration Changes.
helm upgrade -n ${NAMESPACE} ${INSTALLATION_NAME} oci://repo.cybus.io/charts/connectware -f values.yamlTry logging in with the admin user credentials to verify that the account has been disabled. You should receive a "wrong password" error.
Navigate to your Connectware installation directory. If you have used the default values during installation, this is the installation folder: /opt/connectware. The directory contains an .env file that is loaded when starting Connectware.
Open the .env file.
Set the CYBUS_ADMIN_USER_ENABLED environment variable to false.
environment:
- CYBUS_ADMIN_USER_ENABLED=falseStart or restart Connectware. For more information, see Restarting Connectware.
Try logging in with the admin user credentials to verify that the account has been disabled. You should receive a "wrong password" error.
As an alternative to providing the initial admin password using the global.authentication.adminUser.initialPassword Helm value, you can specify the name of an existing Kubernetes Secret in the global.authentication.adminUser.existingSecret Helm value.
The Secret must contain a key named initialPassword. Unlike the global.authentication.adminUser.initialPassword Helm value which accepts plain-text passwords, the Secret value must be Base64-encoded. We recommend using an immutable Secret, as the password is only read during initial installation. Changing the Secret later will not update the admin user's password.
Create the Kubernetes Secret using your preferred method. The following example creates a Secret with the password Super_S3cret_Password, using echo -n ${MY_PASSWORD} | base64 to encode the password before storing it in the Secret:
Open the values.yaml file.
Set the global.authentication.adminUser.existingSecret Helm value to the name of the Kubernetes Secret you created.
Install Connectware using the Helm chart. For more information, see Install Connectware on Kubernetes.
Try logging in with the admin user credentials to verify that your initial admin user password was applied.
Last updated
Was this helpful?
Was this helpful?
kubectl create secret -n ${NAMESPACE} generic my-initial-admin-password --from-literal="initialPassword=$(echo -n "Super_S3cret_Password" | base64)"global:
authentication:
adminUser:
existingSecret: my-initial-admin-passwordhelm install -n ${NAMESPACE} ${INSTALLATION_NAME} oci://repo.cybus.io/charts/connectware -f values.yaml