Workers Docker Compose Installation

Install JFrog Worker using Docker Compose for serverless execution alongside JFrog Artifactory.

This page describes how to install JFrog Worker on a self-managed environment using Docker Compose.

Prerequisites

Docker Engine (version 25.0 and above) and Docker Compose must be installed and properly configured on your host machine(s).

Install Steps

Follow these steps to install Worker using a Docker Compose package.

Download the latest Docker Compose package for JFrog Worker.
Extract the contents of the compressed archive (.tar.gz file) and then go to the extracted folder.
```
tar -xvf jfrog-worker-<version>-compose.tar.gz
```
Run the interactive script with the required ownership to complete the JFrog Worker installation.
```
sudo ./config.sh
```
The script prompts for the installation directory:
```
Installation Directory (Default: /root/.jfrog/worker):
```
You can press Enter to select the default directory or enter your preferred custom path for setting up the directory.

The following table lists the keys that must have the input values:

Keys	Description
JFrog URL	The URL of the self-hosted JPD. Used to register the Worker Client in the JPD topology.
Join Key	The Join Key is the secret key used to establish trust between services in the JFrog Platform.
Master Key	This is the unique master key that the Worker service requires. It is optional.

Enter the URL for your JFrog Platform.

The JFrog URL allows Worker to connect to a JFrog Platform Instance. 
(You can copy the JFrog URL from Administration > Security > General > 
Connection details)
JFrog URL [http(s)://artifactory.server.host:8082]:

Enter the join key for your JFrog Platform.

The Join Key is the secret key used to establish trust between services in the JFrog Platform.
(You can copy the Join Key from Administration > Security > General > Connection details)
Join Key:

Enter the master key for Artifactory.

Provide the Artifactory's master key. It can be found in the data directory of the artifactory under /etc/security/master.key
Master Key:

Enter the IP address of the machine running the script, or press Enter to accept the default value.

For IPv6 address, enclose value within square brackets as follows : [<ipv6_address>]
Specify the IP address of this machine (Default: 0.0.0.0):

Press Enter and wait for the setup to finish. The script creates the necessary directories and completes the Docker setup.

Use docker-compose commands to start the application. Once the application has started, it can be accessed at [http://<client-ip>:8082]
Examples:
cd /home/user/jfrog-Worker-1.20.0-compose
start:               docker compose -p worker up -d
stop:                docker compose -p worker down

To start the JFrog Worker service, run the following command from the extracted folder.
```
docker compose -p worker up -d
```
To check the status of the running JFrog Worker service, run the following command.
```
docker compose -p worker ps
```
To check the JFrog Worker logs, run the following command.
```
docker compose -p worker logs
```

Updated 12 days ago