Hub 2024.1 Help

Manage the Default Administrator Account

When you install Hub for the first time, you set the username 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 username 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.

You can also use this procedure when two-factor authentication is enabled and the default administrator no longer has access to the authentication app that is paired with the account. Resetting the default administrator account to its default state also disables two-factor authentication.

To restore the default administrator account in Hub, follow the specific instructions for your installation type:

To reset the default administrator account credentials:

  1. Stop Hub with the command:

    docker exec <Hub docker container ID> stop
  2. Run the configure-next-start command:

    docker run --rm -it -v <path to conf directory>:/opt/hub/conf \ jetbrains/hub:<version> \ configure-next-start \ --J-Djetbrains.hub.admin.restore=true

    Make sure to enter two dashes before the J option. 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 Admin Account section.

  3. Run the 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.

  4. Log into Hub with the default administrator account.

  5. If required, change the password for the account.

To reset the default administrator account credentials:

  1. Stop Hub with the command:

    <Hub Installation Directory>/bin/hub.sh stop
  2. Start Hub with the command:

    <Hub Installation Directory>/bin/hub.sh start --J-Djetbrains.hub.admin.restore=true

    Make sure to enter two dashes before the J option. 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 Admin Account section.

    • 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.

  3. Log into Hub with the default administrator account.

  4. If needed, change the password for the account.

System Parameters for the Default Admin Account

Parameter

Description

jetbrains.hub.admin.restore

Resets the default administrator account and its permissions to the default scheme. If built-in authorization is disabled, starting Hub service with this parameter enables it.

  • Data type: Boolean

jetbrains.hub.admin.uuid

Sets the UUID of the default administrator account. This parameter is only applied when used in combination with the jetbrains.hub.admin.restore.

  • Data type: string

jetbrains.hub.admin.name

Sets the full name of the default administrator account. This parameter is only applied when used in combination with the jetbrains.hub.admin.restore.

  • Data type: string

jetbrains.hub.admin.login

Sets the username of the default administrator account. This parameter is only applied when used in combination with the jetbrains.hub.admin.restore.

  • Data type: string

jetbrains.hub.admin.email

Sets the email address of the default administrator account. This parameter is only applied when used in combination with the jetbrains.hub.admin.restore.

  • Data type: string

jetbrains.hub.admin.password

Sets the password of the default administrator account. This parameter is only applied when used in combination with the jetbrains.hub.admin.restore.

  • Data type: string

Last modified: 17 June 2024