Manage the Default Administrator Account
When you install Hub for the first time, you set the login and password for the default administrator account. This account is assigned the System Admin role in the Global project.
If you forget the credentials for the default administrator account, or have inherited an installation that was configured by another administrator, you can reset the login and password for the account to their default values. You can also set the system properties for the default administrator when you restore the account.
Reset the Default Administrator Account for an MSI Installation
If you run Hub as Windows service, use the following procedure.
To reset the default administrator account credentials:
- Stop the Hub service.
- Navigate to the
%programdata%\JetBrains\Hub\conf\directory.- If the directory already contains the
hub.jvmoptionsfile, open the file. - If you have not changed the system properties or JVM options for your server, the directory contains a sample configuration file. The sample configuration file uses the
.distextension and contains a list of default JVM options. Copy thehub.jvmoptions.distfile and save it ashub.jvmoptions.
- If the directory already contains the
- Add the
-Djetbrains.hub.admin.restore=truesystem property to the configuration file. The configuration file format is described in the file itself.If you want to set any of the system properties for the default administrator account, add them to the file. Add each system property to a new line. For a list of system properties, see System Properties for the Default Administrator Account.
- Start the Hub service.
- The default administrator credentials are reset to their default values or the values that are specified in the configuration file.
- Log into Hub with the default administrator account.
- If needed, change the password for the account.
- Delete the
-Djetbrains.hub.admin.restore=truesystem property from the configuration file. Otherwise, the system administrator password is reset every time you restart the Hub service.If you specified additional system properties for the administrator account, remove them as well.
Restore Root Password for ZIP Installations
If you installed Hub with a ZIP installation, use the following procedure.
To reset the default administrator account credentials:
- Stop Hub with the command:
<Hub Installation Directory>/bin/hub.sh stop - Start Hub with the command:
<Hub Installation Directory>/bin/hub.sh start --J-Djetbrains.hub.admin.restore=trueMake sure to enter two dashes before the
Joption. This method sets the system property for the current run only and does not update the configuration file. Thus, the administrator account credentials are not reset for subsequent restarts of the Hub service.If you want to set any of the system properties for the default administrator account, add them to the command. For a list of system properties, see System Properties for the Default Administrator Account.
- The Hub service starts using the specified setting.
- The default administrator credentials are reset to their default values or the values that are specified in the command.
- Log into Hub with the default administrator account.
- If needed, change the password for the account.
Restore Root Password for a Docker Installation
If you run Hub in a docker container, use the following procedure.
To reset the default administrator account credentials:
- Stop Hub with the command:
docker exec <Hub docker container ID> stop - Run the
configure-next-startcommand:docker run --rm -it -v <path to conf directory>:/opt/hub/conf \ jetbrains/hub:<version> \ configure-nest-start \ --J-Djetbrains.hub.admin.restore=trueMake sure to enter two dashes before the
Joption. This method sets the system property for the current run only and does not update the configuration file. The administrator account credentials are not reset for subsequent restarts of the Hub service.If you want to set any of the system properties for the default administrator account, add them to the command. For a list of system properties, see System Properties for the Default Administrator Account.
- Run docker container:
docker container start <Hub docker container ID>- The Hub service starts using the specified setting.
- The default administrator credentials are reset to their default values or the values that are specified in the command.
- Log into Hub with the default administrator account.
- If required, change the password for the account.
System Properties for the Default Administrator Account
You can set the following system properties when you start Hub with the jetbrains.hub.admin.restore=true parameter. When you use these properties to set, for example, the login and password of the default administrator account, you can update the credentials without having to log in and update them in the user interface.
| Property | Description | Type |
|---|---|---|
jetbrains.hub.admin.uuid | Sets the UUID of the default administrator account. | string |
jetbrains.hub.admin.name | Sets the full name of the default administrator account. | string |
jetbrains.hub.admin.login | Sets the login of the default administrator account. | string |
jetbrains.hub.admin.email | Sets the email address of the default administrator account. | string |
jetbrains.hub.admin.password | Sets the password of the default administrator account. | string |
For example, the following command starts the Hub service, resets the default administrator account, and sets the login and password to the specified values:
hub.sh start --J-Djetbrains.hub.admin.restore=true
--J-Djetbrains.hub.admin.login=<userlogin> --J-Djetbrains.hub.admin.password=<password>To apply this command correctly, replace the <userlogin> and <password> placeholders in this example with the actual login and password that you want to use for the default administrator account.