Login to GitProtect Management Service using a web browser, then go to Settings > Advanced > Workers and click Download agent button.
The Download agent window will open — click the appropriate worker version to download it.
The download will start automatically; additionally, an Installation tab with a step-by-step installation instruction will pop-up in the Management Service.
Under the Install section you will see the address combined a port — save it for later as you will have to use it during worker installation.
Once the installation wizard is downloaded, you can move to the installation process.
Open and run the downloaded setup wizard. Click Next to begin the installation process.
Read and accept the End-User License Agreement, then move to the next step.
Choose the installation directory for the GitProtect client.
Paste the previously copied address to the Address field and hit Next to continue.
Click Install to start the installation.
Once the wizard finishes installation, click the Finish button to close it.
You can now activate your device in GitProtect Management Service.
Login to GitProtect Management Service using a web browser, then go to Settings > Advanced > Workers and click Download agent button.
The Download agent window will open — click the appropriate worker version to download it.
The download will start automatically; additionally, an Installation tab with a step-by-step installation instruction will pop-up in the Management Service.
Under the Install section you will see the address combined a port— save it for later as you will have to use it during worker installation.
Open and run the downloaded setup wizard. Click Next to begin the installation process.
Read and accept the End-User License Agreement, then move to the next step.
Choose the installation directory for the GitProtect client.
Paste the previously copied address to the Address field and hit Next to continue.
Click Install to start the installation.
Once the wizard finishes installation, click the Finish button to close it.
You can now activate your device in GitProtect Management Service.
Prior to worker installation, check if your system is meets all the requirements.
System requirementsSupported platformsDownload the worker installer (bash script) to your Linux system and grant execute permission to the file owner (user or group) using the following chmod command:
chmod +x xoperoclient.shNext, run the script using the following command:
Accept the END-USER LICENSE AGREEMENT to proceed.
Next, enter the IP address in the Address field (including the protocol and port) and click OK to finish the installation. Your address can be found in GitProtect Management Service — the system will display it once you start downloading the worker installer.
Now that GitProtect worker is installed, you can activate it in the GitProtect Management Service web panel and start protecting your data.
Download GitProtect worker installation wizard and run it.
Click Continue to proceed.
Select Continue in the Read Me section.
Read the END-USER LICENSE AGREEMENT and hit Continue to accept it.
Hit Agree to accept the terms of the software license agreement.
Change the installation directory if needed and click Install to begin the installation.
During the installation process, the creator will ask you for the address of your Management Service — define it in this step. Your address can be found in GitProtect Management Service; the system will display it once you start downloading the worker installer.
Click OK to confirm your configuration.
The GitProtect worker has been successfully installed — you can close the installation wizard.
./xoperoclient.sh or bash xoperoclient.shsudo command
To install the GitProtect worker within a Docker container, use the images available on Docker Hub:
docker pull xopero/xone-agent:latestCreate a host directory for the GitProtect Management Service container databases (which are located at /app/Xopero inside the container) to store databases outside the container:
mkdir -p /opt/xone-agent/dataRun the container with the correct volume mounting and environment variables using the following command:
Check if the container works correctly by using the following command:
Once all the above steps are completed, the worker will report to the GitProtect Management Service panel for activation.
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB RAM
Container Station app from AppCenter
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB RAM
Container Station app from AppCenter
Navigate to the Container tab and click the Create button. Expand the Image section and click Add image, then search for xopero/xone-agent image.
Select the image, click Download, and choose the version tagged as latest. Click Select to confirm.
Download the Container Station app from the AppCenter.
Login to your QNAP web panel and open the AppCenter application. In QNAP Store, select All Apps and search for the Container Station.
Download and open the application. Select the path that will be used as a directory for your Docker container data, and click Start Now to proceed.
Open the Container Station application, select the Containers tab, and click the Create button.
In Image Configuration choose the Advanced mode option. In the image type, select Docker image, and in the Image field, paste the following command:
Ensure the Try pulling image from the registry before creating the container option is checked, and hit Next.
Within the Configure Container tab, the form contains several fields, with the most crucial being:
Name — here you can set a custom name for the container
Restart policy — defines if the container will star automatically in case of, for example, QNAP restart
In the Configure Container tab, navigate to ⚙️Advanced Settings.
Go to the Environments section and click Add New Variable to add new environment variables with the following values:
‼️*ManagementServiceUrl – your GitProtect Management Service (address in one of the following formats (depending on the deployment model):
a.
http://ipaddress:port, i.e.,http://192.168.0.1:28555b.
https://XMSID.ads.xopero.com, i.e.,https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com
Click Apply to save your changes.
Navigate to Storage tab — here you can mount your QNAP volumes to the GitProtect worker Docker container.
Next, double-check and confirm your settings, then click Finish to create the container.
Container Station will download the latest GitProtect image and create the container based on that image.
Once the container creation process is completed, your new container will be visible under Container tab in Container Station.
You can now connect to your GitProtect Management Service admin panel to activate the worker.
Download the Container Station app from the AppCenter.
Login to your QNAP web panel and open the AppCenter application. In QNAP Store, select All Apps and search for the Container Station.
Download and open the application. Select the path that will be used as a directory for your Docker container data, and click Start Now to proceed.
Once done, download the GitProtect worker Docker image, which is available on our official server.
Open the Container Station application and navigate the Import tab.
Click the ➕Import button to upload the previously downloaded Docker image file.
In Create Import Task window, select the source type and file path of the GitProtect workerDocker image and hit Next to continue.
Within the Create Container tab, the form contains several fields, with the most crucial being:
Name — here you can set a custom name for the container
Auto start — defines if the container will star automatically in case of, for example, QNAP restart
CPU Limit — allows you to specify the percentage of CPU usage allocated for the container
Memory Limit — RAM limit for the container
Click the ⚙️Advanced Settings >> button and navigate to the Environment section.
To add a new environment variable, click the Add button, name it ManagementServiceUrl, and set its value to your GitProtect Management Service address*.
‼️*ManagementServiceUrl – your GitProtect Management Service address in one of the following formats (depending on the deployment model):
a.
http://ipaddress:port, i.e.,http://192.168.0.1:28555b.
https://XMSID.ads.xopero.com, i.e.,https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com
Go to the Shared Folders section — here you can mount your QNAP volumes to the GitProtect worker Docker container.
To back up data from your QNAP device, choose Add under Volume from host section — it lets you specify which data the GitProtect container can access. Select a directory from the host in Volume from host field and enter the path visible inside the container in the Mount Point field.
Once you're done with the above steps, click Create to continue.
In the Summary window double-check your settings, then click OK to finish the configuration.
You can now connect to your GitProtect Management Service admin panel to activate the agent.
Next, define a custom name for the container. Additionally, configure container resource limits if needed.
Check the Enable auto-restart option to ensure the container automatically restarts when the device reboots, then click Next to proceed.
In the Volume Settings section, click the ➕Add Folder button, and select directories that require protection. The container needs to have external directories mounted to access them while performing backups.
Additionally, to ensure data persistence during container updates or maintenance operations, mount worker databases to an external directory. These databases are located in /app/Xopero and should be mapped to a designated location outside the container to avoid data loss or inconsistency.
Next, in the Environment section, define the required variables:
ManagementServiceUrl — your GitProtect Management Service address in one of the following formats (depending on the deployment model):
a.
http://ipaddress:port, i.e.,http://192.168.0.1:28555b.
https://XMSID.ads.xopero.com, i.e.,https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.comXoperoOverriddenHostName — specify worker's name to facilitate identification
Click Next to confirm the configuration. In Summary window, double-check your settings and if they're all correct, hit Done to finalize the process.
docker ps
docker run -v /host/path:/container/path -e ENV_VAR=value image_namedocker run -d \
--name <container_name> \
-e ManagementServiceUrl="<your_gitprotect_service_URL>" \
-e XoperoOverriddenHostName="<device_name>" \
-v /opt/xone-agent/data:/app/Xopero \
--restart unless-stopped \
xopero/xone-agent:latestdocker run -d \
--name gitprotect-worker\
-e ManagementServiceUrl="https://192.168.1.10:28555" \
-e XoperoOverriddenHostName="Docker_agent" \
-v /opt/xone-agent/data:/app/Xopero \
--restart unless-stopped \
xopero/xone-agent:latestxopero/xone-agent:latesthttp://+:80trueGitProtect Management Service addressyour custom QNAP container name
Login to your GitProtect Management Service console.
Click the Activate agent icon in the top menu.
A sidebar will appear, showing a list of available agents — you can view basic details like device type, name, IP address, and operating system.
Select the device you want to activate (you can select multiple devices if you assign them the same license type) and press the Activate button to proceed.
Next, select the license type you want to assign to the chosen device(s) and click Assign license to confirm your selection.
Once the license is correctly assigned, your device(s) will be visible in the Devices tab.
The config.json file, by default, is located in the following locations:
For Windows: C:\Program Files\Xopero ONE Backup&Recovery Agent
For Linux: /opt/XoperoONEBackupAgent/
💡You can edit config.json with a simple text editor (i.e., Notepad++).
The GitProtect Management Service address to which your worker connects is crucial during both installation and configuration. If the IP address or protocol (http/https) of the Management Service changes, the agent's status will switch to offline. To re-establish the connection, update the ServiceUrl value in the configuration file with the updated address.
By default, the LogLevel value is set to Information. You can change it to:
Trace
Debug
Information
By default, application logs are stored in the following directory: C:\ProgramData\Xopero ONE\Xopero ONE Backup&Recovery Agent\Logs. To change the location, modify the AppDataFolder parameter.
The device name defaults to the system's name. To customize it, modify the OverriddenHostName parameter.
If database backup task ends with error DV0249 - "Unable to read backup data", first address any connection stability issues on your end. If the problem persists, you can increase the retry attempts in the GitProtect application—to do this, simply edit the MaxRetriesCount parameter, changing its default value from 2 to a higher value, i.e., 20.
WarningError
Critical
None
