Workers Linux Archive Installation

Install JFrog Worker on Linux using the archive method as a service or background process.

This page describes how to install JFrog Worker using a Linux archive.

Review and verify prerequisites before beginning installation.

To install Worker with a Linux Archive:

  1. Download the latest Worker Linux archive from the official JFrog releases page.

  2. Create the /opt/jfrog directory (if it doesn't already exist), then move the downloaded file there. The Worker service and the user created during installation inherit required run and execute permissions from this directory.

    mkdir -p /opt/jfrog
    mv jfrog-worker-<version>-linux.tar.gz /opt/jfrog/
  3. Go to the /opt/jfrog directory. Extract the contents of the archive, and rename the extracted folder to worker.

    cd /opt/jfrog
    tar -xf jfrog-worker-<version>-linux.tar.gz
    mv jfrog-worker-<version>-linux worker
  4. Run the installer.

    worker/app/bin/install.sh [-u <user_name>] [-g <group_name>] [-h]

    where:

    -h (optional) displays usage information

    -u (optional) specifies the user that runs the product. The installer creates this user if it does not exist. By default, a user named worker is created.

    -g (optional) specifies the group that runs the product. The installer creates this group if it does not exist. By default, a group named worker is created.

  5. The installer runs as an interactive script. At the following prompt, enter the URL of the self-managed JPD that will host the Worker.

    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)://<self_managed_JPD>:8082]:
  6. At the following prompt, enter the Join Key of the self-managed JPD.

    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:
  7. At the following prompt, enter the Master Key of the self-managed JPD. The master key is required — Worker uses it to decrypt the join key stored in system.yaml.

    Provide the Artifactory's master key.
    It can be found in the data directory of the jpd under /etc/security/master.key
    Master Key:
  8. Press Enter and wait for the setup to finish. The script creates the necessary directories and completes the setup.

    Installation complete. Installation log can be found at [/opt/jfrog/worker/var/log/install.log]
    NOTE : Make sure /opt/jfrog/worker is owned by worker.
    chown -R worker:worker /opt/jfrog/worker
  9. If necessary, change the ownership of the entire /opt/jfrog/worker directory to the worker user and group to prevent permission issues.

    chown -R <user name>:<group name> /opt/jfrog/worker
  10. Access the configuration file at worker/var/etc/system.yaml and modify it to customize connection details, ports, the node ID, and other settings.

  11. (Optional) To install Worker as a persistent service:

    1. Run the installer worker/app/bin/installService.sh.
    2. Start the service with the command systemctl start worker.service.
  12. Use systemd or init.d commands to manage the service.

    Using systemd:

    systemctl <start|stop|status|restart> worker.service

    Using init.d:

    service worker <start|stop|status|restart>

    You can also use the Worker control script directly:

    worker/app/bin/worker.sh <start|stop|status|restart>

    Use the following command to monitor Worker service log entries:

    tail -f worker/var/log/console.log

Related Topics


Did this page help you?