Change the Relay home directory or configuration file path

Change an individual configuration file path

To update a specific file path, use the settings set command with the applicable path key:

relay-manager settings set binaryConfigPath "/some/path/relay.conf"

Change the Relay home directory

To move all Relay files to a new directory, use the relayHome key:

relay-manager settings set relayHome "/some/path/to/folder"

A prompt confirms the change before proceeding. Selecting Yes moves all folders and updates all settings paths to the new directory.

✍️ Set the home directory before installing the Relay when possible. If the Relay is already installed and running, follow the applicable steps below based on the deployment type.

Update existing Relay home directory

Docker deployments

Changing the home directory on an existing Docker deployment causes a volume path mismatch between the new home directory and the existing container configuration. Relay Manager detects this automatically.

Run relay-manager status to confirm whether a volume mismatch is present. If a mismatch is detected, the output includes steps to resolve it.

To resolve the mismatch, run: relay-manager update

Relay Manager identifies the volume mismatch and prompts to fix it. Select Yes to proceed.

If the container is not currently running, the standard update command will not apply. Use the -a flag to update non-running containers: relay-manager update -a

Binary deployments

Changing the home directory on an existing binary deployment requires a reinstall to update the service path. Complete the following steps:

Change the home directory using relay-manager settings set relayHome "/some/path/to/folder"
Run relay-manager uninstall
Run relay-manager install

If the home directory is changed before uninstalling, the reinstall will apply the correct path automatically.

How can we help you?

Search

In this article

Change an individual configuration file path