Hub 2024.1 Help

Docker Installation

Here's a high-level overview of the steps required for installing Hub using a Docker container:

  1. Prepare Your Environment

  2. Create Directories for Storing Hub Data

  3. Pull the Hub Image

  4. Run the Docker Container

  5. Fine-tune the Hub Configuration

Each step is described in more detail below.

Prepare Your Environment

Ensure that you have Docker installed on the server or virtual machine where you want to install Hub. You can download and install Docker from the official website or use a package manager specific to your server's operating system.

You'll also want to make sure that the target environment for the installation meets or exceeds the minimum requirements for installing Hub. For details, see Supported Environments.

When installing software on a server, it's generally recommended to use a user account with administrative or superuser privileges. In Unix-like operating systems, this user is often referred to as "root." In Windows, it's typically an account with administrative rights. Be sure that the account you use to access the server has permission to create folders and files in this environment.

Create Directories for Storing Hub Data

The Hub image is a stateful container. This allows the databases, log files, configuration files, and application data to be stored and maintained even if the container is restarted or moved to a different host.

Before starting the container, you need to provision directories on the host machine to store these files. These directories are then mapped to the Hub container as volumes during startup.

The Hub application uses the following directories:

Directory

Description

data

The directory where Hub stores its database. For a new installation, this directory must be empty.

conf

The directory where Hub stores configuration files that contain environment settings, JVM options, Hub integration settings, and so on.

logs

The directory where Hub stores its log files.

backups

The directory where Hub stores backups. For more details about backups, see Backup.

These directories must be accessible to the user account that runs Hub service inside the container. Hub uses the non-root account 13001:13001 (group:id, respectively).

Specific instructions for provisioning storage resources vary by operating system. To make sure you see information that is relevant to your installation, select the tab that corresponds with the operating system used in your host environment.

If the host machine runs on Linux, you can execute the following commands to create the required Hub directories on the host machine and apply the required access permissions:

mkdir -p -m 750 <path to data directory> \ <path to logs directory> \ <path to conf directory> \ <path to backups directory> chown -R 13001:13001 <path to data directory> \ <path to logs directory> \ <path to conf directory> \ <path to backups directory>
  • mkdir — this is the command to create directories in Linux.

  • -p — tells the operating system to create parent directories as needed. If any directories in the specified paths do not exist, they are created along with the specified directories.

  • -m 750 — sets the permissions (file mode) of the directories to 750. In Unix-like systems, file mode permissions are represented as three octal digits, where each digit represents permissions for owner, group, and others (in that order). With 750, the owner has read, write, and execute permissions (7), the group has read and execute permissions (5), and others have no permissions (0).

  • <path to <name> directory> — these are placeholders for the actual paths to the directories you want to create. Replace these with the actual paths where you plan to store Hub application data and other files.

  • chown — changes ownership of the created directories.

  • -R — tells the operating system to perform this action recursively, changing ownership for the specified directories and all their contents.

  • 13001:13001 — specifies the user and group to which ownership is being changed. In this case, it changes the ownership to user ID 13001 and group ID 13001.

  • <path to <name> directory> — these are placeholders for the actual paths to the directories whose ownership is updated. As with the mkdir command, you need to replace these with the actual paths where you plan to store Hub application data and other files.

If the host machine runs on Windows, you can run the following commands to create the required Hub directories on the host machine PowerShell:

New-Item -Path "<path to data directory>" -ItemType Directory New-Item -Path "<path to logs directory>" -ItemType Directory New-Item -Path "<path to conf directory>" -ItemType Directory New-Item -Path "<path to backups directory>" -ItemType Directory
  • New-Item — creates the directories with the specified paths.

  • <path to <name> directory> — these are placeholders for the actual paths to the directories you want to create. Replace this with the actual location where you plan to store Hub application data and other files.

Pull the Hub Image

  1. Locate the latest version of the software on Docker Hub.

    Each version and build is listed by tag.

  2. Once you have located the image that corresponds with the most recent Hub version, you can click to copy the pull command directly from the Docker Hub repository.

  3. Open a CLI tool in the target environment.

  4. Use the command to pull the image from the repository and install it on your local machine or host environment.

    The command uses the following format:

    docker pull jetbrains/hub:<version>

    If you didn't copy the command directly from Docker Hub, replace the <version> variable with the full version number of a Hub build.

Run the Docker Container

Once you have set up the directories where Hub stores application data as described above, you can define mappings to the directories inside the Docker container as arguments in the command you use to run the container.

Use the following command to start the container for the Hub service:

docker run -it --name <hub-server-instance> \ -v <path to data directory>:/opt/hub/data \ -v <path to conf directory>:/opt/hub/conf \ -v <path to logs directory>:/opt/hub/logs \ -v <path to backups directory>:/opt/hub/backups \ -p <port on host>:8080 \ jetbrains/hub:<version>
docker run -it --name <hub-server-instance> ^ -v <path to data directory>:/opt/hub/data ^ -v <path to conf directory>:/opt/hub/conf ^ -v <path to logs directory>:/opt/hub/logs ^ -v <path to backups directory>:/opt/hub/backups ^ -p <port on host>:8080 ^ jetbrains/hub:<version>

This command automatically creates the volumes required for storing application data and maps them to the directories provisioned in the host environment. It also specifies the port the Hub service uses to send and receive data on the server.

Use the following information to customize this command as needed:

  • -it a command-line flag that attaches both the input and output of the container to your terminal. This lets you see the output produced by the container as if it were running directly in your terminal.

    When the container starts, you will see the log messages generated during the initialization process as well.

    Pressing Ctrl+ C while the terminal is attached to a container's output sends an interrupt signal to the container's running process. This is similar to how you would stop a regular process in your terminal. This command causes the container to shut down, so be cautious when using Ctrl+ C in this context.

    If you want to detach the terminal from the container output without interrupting the processes running in it, press Ctrl+ P followed by Ctrl+ Q.

    For more details, please refer to the official Docker documentation.

  • --name hub-server-instance this is an arbitrary name for the container.

    By default, Docker generates random and sometimes cryptic names for containers. Use the --name option to give your container a more meaningful and human-readable name that makes it easier to identify and manage.

  • -v <path to <name> directory>:/opt/hub/<name> these options specify the location of the storage provisioned on the host machine and map them to the corresponding /opt/hub/<name> directories inside the container.

  • -p <port on host>:8080 parameter that defines the port mapping. This tells the host machine to listen for traffic on the <port on host> port and propagate all traffic to port 8080 inside the container.

    The listen port must be accessible to end users or to the reverse proxy server, if one is in use. This may require explicitly opening access to this port through the firewall.

The Hub service starts on {0.0.0.0:8080} inside the Docker container, and port 8080 is mapped to the specified <port on host>. This way the service can be accessed from any machine that has network access to the <port on host> of your host machine. For instance, if the fully qualified domain name (FQDN) of the host machine is host.mydomain.com and the <port on host> is 7777, the service will be available at http://host.mydomain.com:7777.

Fine-tune the Hub Configuration

At this point, the application is installed with the default configuration. To ensure that Hub is set up properly to work in your server environment, you need to confirm and fine-tune its configuration.

On the first run, the Hub service starts with a web-based Configuration Wizard. The wizard is accessible from the web address where the service is hosted.

The Configuration Wizard is secured with a one-time access token, which you need to copy from the log output from Docker. For example:

JetBrains Hub 2023.1 Configuration Wizard will listen inside container on {0.0.0.0:8080}/ after start and can be accessed by URL [http://<put-your-docker-HOST-name-here>:<put-host-port-mapped-to-container-port-8080-here>//?wizard_token=FOT8QIzHuktzvxtiT1Ax]

Using the example from the previous section, the Configuration Wizard would be available from http://host.mydomain.com:7777//?wizard_token=FOT8QIzHuktzvxtiT1Ax

To finalize the installation, open the URL for the Configuration Wizard in your web browser and continue with the instructions below.

To configure the new Docker installation:

  1. In the Configuration Wizard, click Set up.

    Docker installation: Configuration wizard
  2. On the Confirm Settings page, confirm or change the basic system settings.

    Docker installation: Settings basic

    Here, you can also enable the built-in TLS to secure the network connection for the server. For detailed instructions, see Enable HTTPS during Installation.

    Setting

    Description

    HTTP | HTTPS

    Lets you enable or disable the built-in TLS and configure the secure network connection to your server. If you enable HTTPS, the TLS-specific settings are displayed.

    Configuration wizard: HTTPS tab

    For details, see TLS Settings.

    Base URL

    The URL where end users access Hub.

    Application Listen Port

    The port your Hub server listens to after installation.

    Language

    The default language that is shown in the user interface.

  3. Expand the Advanced Settings section to review the locations where Hub stores product data.

    Docker installation: Advanced settings

    Setting

    Description

    Data Directory Location

    The directory where Hub stores content data.

    Backup Location

    The directory where Hub stores backups of the database.

    Logs Location

    The directory where Hub stores log files.

    Temp Location

    The directory where Hub stores product-specific temporary files.

    Given that you just created these directories during the installation, you shouldn't need to update them at this point.

    If you were to change the location for any of these files, you need to change bindings between the folders on a hosted machine and Hub-specific directories inside the container. For details, see Change Database Location.

  4. To share usage statistics with JetBrains, keep the Send usage statistics anonymously option enabled. This feature helps JetBrains track usage statistics to make Hub better. We never share collected data with any third party.

  5. When done, click Next.

  6. On the Select Hub Service page, enter and confirm the password for the system administrator account. The default username is admin.

    Install http admin

    To assign a different username to the administrator account, edit the Create Admin Login setting.

    The Enable login as guest setting determines whether users are able to browse content in connected services without logging in to their accounts. To restrict anonymous access, deselect this option.

  7. When done, click Next.

  8. On the Confirm License page, verify the license name and key.

    Install http license
  9. When done, click Finish.

    • The configuration is applied to your Hub server.

    Do not close the page in the browser until the setup is complete. When the Hub server is ready:

    • If you switched off the option to log in as a guest, you are redirected to the login page.

    • If you left the Enable login as guest option enabled, you are redirected to the Dashboard.

That's it. Your Hub service is installed and ready for use.

Last modified: 07 June 2024