Apache Hop
Download
User manual 2.20.0

Development Documentation

Edit this page

Hop setup

hop setup configures the launcher environment variables that Hop reads before Java starts.

This is different from hop conf, which edits hop-config.json (projects, system variables, GUI options).

Without these variables Hop uses the installation config/ and audit/ folders. After an upgrade those folders are gone. Setup writes the variables to your user environment, a shell startup file, and/or a hop-env script so configuration lives outside the install.

Recommended folders

Variable Linux / macOS Windows

${HOP_CONFIG_FOLDER}

~/.local/share/hop (or ${XDG_DATA_HOME}/hop)

%USERPROFILE%\.hop\config

${HOP_AUDIT_FOLDER}

~/.local/state/hop (or ${XDG_STATE_HOME}/hop)

%USERPROFILE%\.hop\audit

You can also set ${HOP_JAVA_HOME}, ${HOP_OPTIONS} and ${HOP_SHARED_JDBC_FOLDERS}.

Hop Gui

Open the configurator from:

  • Tools → Configure Hop environment…​

  • The Welcome dialog topic Environment setup

  • The first-start question, when ${HOP_CONFIG_FOLDER} is not set

On first start Hop asks whether to keep configuration outside the installation folder:

First-start question to configure a user-level HOP_CONFIG_FOLDER

Yes opens the configurator with the recommended folders filled in. No skips the prompt (you can still open it from the Tools menu).

Variables tab

Set ${HOP_CONFIG_FOLDER}, ${HOP_AUDIT_FOLDER}, ${HOP_JAVA_HOME}, ${HOP_OPTIONS} and ${HOP_SHARED_JDBC_FOLDERS}.

Configure Hop environment dialog

  • Use recommended values — platform folders (~/.local/share/hop and ~/.local/state/hop on Linux/macOS, %USERPROFILE%\.hop\config and audit on Windows).

  • Use existing values — the current environment, or ./config and ./audit when those variables are unset.

  • Create the config and audit folders and Copy the current install config folder when the new config folder is empty.

Location tab

Choose where to write the variables:

Configure Hop environment dialog

  • Windows user environment variables

  • Shell startup file (~/.bashrc or ~/.zshrc)

  • A hop-env script sourced by Hop launchers (~/.config/hop/hop-env.sh or %USERPROFILE%\.hop\hop-env.cmd)

Projects tab

A new ${HOP_CONFIG_FOLDER} starts without projects. On the Projects tab you can:

Configure Hop environment dialog

  • Create a default project in a user documents folder:

    • Linux: ~/Documents/hop/default

    • macOS: ~/hop/default

    • Windows: %USERPROFILE%\Documents\Hop\default

  • Register the samples project from this Hop installation (<install>/config/projects/samples) so the examples stay available after the config folder moves.

Both options are selected by default. Apply writes them into the new hop-config.json. An empty default project home is created from the install default-project template. That project includes a local pipeline run configuration and a local workflow run configuration. If the template does not contain them, setup adds them, together with the local execution info location and data profile they use.

Preview and apply

Preview shows the planned files without writing them:

Preview of planned hop-env and shell rc writes

Apply writes the selected targets. Restart Hop so the new folders take effect:

Environment configured confirmation

After restart, Hop Gui opens the new default project:

Hop Gui after setup with the new default project

Hop Web does not write the server operating system environment. Use Preview and apply the generated script on the machine that starts Hop.

Command line

From the Hop install directory:

bash
./hop setup
./hop setup show
./hop setup apply --defaults
./hop setup apply --defaults --dry-run
./hop setup apply --config-folder /data/hop/config --audit-folder /data/hop/audit --script

On Windows use hop.bat setup apply --defaults.

apply options

Option Description

--config-folder

Value for ${HOP_CONFIG_FOLDER}

--audit-folder

Value for ${HOP_AUDIT_FOLDER}

--java-home

Value for ${HOP_JAVA_HOME}

--options

Value for ${HOP_OPTIONS}

--jdbc-folders

Value for ${HOP_SHARED_JDBC_FOLDERS}

--defaults

Fill unspecified config/audit folders with the recommended paths and register a default project plus samples

--user-env

Write Windows user environment variables

--shell-rc

Update ~/.bashrc or ~/.zshrc (detected from ${SHELL})

--rc-file

Override the rc file path

--script

Write a hop-env script

--script-file

Override the script path (default: ~/.config/hop/hop-env.sh or %USERPROFILE%\.hop\hop-env.cmd)

--create-default-project / --no-create-default-project

Create a default project (implied by --defaults)

--default-project-home

Home folder of the default project

--register-samples / --no-register-samples

Register <install>/config/projects/samples in the new hop-config (implied by --defaults)

--copy-existing

Copy <install>/config when the new config folder has no hop-config.json

--create-folders / --no-create-folders

Create the config and audit folders (default: create)

--dry-run

Print the planned files without writing

If you do not pick a write target, Hop uses:

  • Windows: user environment + hop-env script

  • Linux / macOS: shell rc file + hop-env script

Hop launchers source the well-known hop-env script when it exists, so desktop shortcuts pick up the folders after a restart. An environment variable that is already set is left unchanged.

To skip the first-start prompt set ${HOP_NO_SETUP_DIALOG}=Y.