This article contains information about how to proceed after installing the GitProtect Management Service component.
To access the on-premise GitProtect Management Service, connect to the device which Management Service console is installed on, using the following address:
ipAddress:port
ipAddress— the IP address of the device with Management Service installed on
port— port defined during installation process — by default, GitProtect uses 28555
If your Management Service opened successfully, you can proceed with the below steps (creating your root account, adding the license code, logging in, running your first setup).
When you launch the Management Service for the first time, you will be prompted to create an administrator account. To register a valid admin account you have to provide your login (it has to be a valid email address) and create a password compliant with the GitProtect password policy. Once you complete the form click Register to proceed to the next step.
Having the administrator account registered, you will then be asked to provide a license key (which you should've received via email upon registering for GitProtect) — this is the last step before the GitProtect system becomes operational and ready to use. Once done, click Proceed to go to the system setup.
In the initial setup you should add your first device which you want to use to set up the storage. Then, you have to install the backup worker and activate it in GitProtect system.
Next, add the storage where you want to store your data. As GitProtect is a multi-storage system, you can add different storages from different sources and use both local storage (i.e., SMB, NFS) and cloud solutions (i.e., Wasabi, Amazon, etc.).
With all system components initialized, you can start protecting your data and create backup plans.
Learn how to connect to GitProtect Management Service admin panel via encrypted HTTPS protocol.
Remember that once you modify the Management Service settings you must switch the agent's communication protocol to HTTPS for the GitProtect service to work correctly.
Open appsettings.json file located in GitProtect Management Service installation directory.
Find commented_out_Kestrel line.
"commented_out_Kestrel": {
"Endpoints": {
"Http": {
"Url": "http://*:5000"
}
}Modify the following code lines — erase commented_out_ prefix and add the HTTPS configuration as follows:
Path: path to the .pfx file*
Password: certificate password
*IMPORTANT! Remember to use double slash— if you're keeping the certificate in C:\cert.pfx directory, the path should be entered as C:\\cert.pfx instead.
Go to your GitProtect worker installation directory and open config.json file.
Default location of the config.json file is:
For Windows: C:\Program Files\Xopero ONE Backup&Recovery Agent
This article describes the process of GitProtect Management Service installation on Windows, Linux, and as a Docker container for on-premise deployment model.
Download and run GitProtect installer.
Click Next to start the installation setup.
For Linux: /opt/XoperoONEBackupAgent/
Change the ServiceUrl value from HTTP to HTTPS.
You can edit config.json with a simple text editor (i.e., Notepad, Notepad++).
config.json file opened in Notepad++.Once the value is changed, the worker will come back online.
"Kestrel": {
"Endpoints": {
"Http": {
"Url": "http://*:5000"
},
"Https": {
"Url": "https://*:5001",
"Certificate":{
"Path": "<.pfx file path>",
"Password": "<certificate password>"
}}}}}Modifying the IP address or the protocol (http, https) of the Management Service will change the active worker's status to offline. It will reconnect once you switch the worker's protocol to HTTPS.
Accept the End-User License Agreement and hit Next to continue.
Select the installation folder and click Next.
Define the HTTP port for GitProtect Management Service. Depending on your needs you can either use a custom HTTP port, or stay with the default Management Service HTTP port (28555).
Click Install to start the installation process.
Once the installation is completed successfully, click Finish to close the installation wizard.
Download and run GitProtect installer (xoperoserver.sh).
Add execute permission to the downloaded file using the following command:
chmod +x xoperoserver.shRun xoperoserver.sh. Accept the End-User License Agreement to continue.
Once the installation is completed, you can close the software installation window.
Before you begin the installation process, check the following articles: System requirements, Supported platforms.
To register for a free trial and download the installer visit the GitProtect website. If you're already a registered user, download the installer here.
This article describes the process of GitProtect Management Service installation within Docker container for on-premise deployment model.
Download the GitProtect Management Service to your device. Open cmd console and pull Management Service Docker image using the following command:
Once the Docker image is imported, use the following command to create a container:
Please note that, by default, the GitProtect Management Service installed on Linux uses port 28555.
Next, use the following command to view the list of containers (or view the list in Docker Desktop):
If you see no errors, that means the Management Service implementation was done correctly. You can open the GitProtect Management Service web panel using the following address:
Before you start using Management Service you must create an administrator account and assign a license to your unit.
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB of RAM
Container Station app from the App Center
Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station.
Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.
Click Start Now to proceed.
In the Container Station application, open the Containers menu option, and click the Create button.
In Image Configuration, choose Advanced mode. For Image type select Docker image, and in the Image field, paste the following:
Ensure Try pulling the image from the registry before creating the container. checkbox is checked, then hit Next.
In the Configure Container tab, configure the GitProtect Docker container and hit Next to continue.
Name — set a custom name for the container
Auto start — defines if the container should startup automatically (i.e., in case of QNAP restart)
Publish network ports — enter a port number in the Host field— this will be the port used to connect to GitProtect service on the container on port 80 (the recommended host port number is 28555)
Double-check your configuration settings and hit Finish.
Container Station will download the latest GitProtect image and create the container based on it.
Once the container creation process is completed, your new container will be available in the Container Station application (under Containers menu option).
Connect to GitProtect using your web URL address in the following format (you can find it under Container Details > General > Web URL):
http://<QNAPaddress>:<port>
To finish the XMS setup, create a new administrative account, provide the license code, and select data to protect.
QNAP with:
Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station.
Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.
Click Start Now to proceed.
Open the Container Station application and click ➕ Create in the left-hand side menu.
Copy and paste xopero/gitprotect-service in the search field and hit Enter to search for the Management Service Docker image (it should be the first search result in Docker Hub tab).
Click the Install button next to the Docker image to start the container creation process.
In the Create Container window, configure the GitProtect Docker container.
Name — set a custom name for the container
Auto start — defines if the container should startup automatically (i.e., in case of QNAP restart)
CPU Limit — allows you to set the CPU percentage usage available for the container
Memory Limit — RAM memory allocated to the container
Scroll down a little and click the ⚙️ Advanced Settings>>
In the ⚙️ Advanced Settings>> go to Network and click the Add button on the right. Enter a port number in the Host field under the Port Forwarding section— this will be the port used to connect to GitProtect service (the recommended, default port number is 28555).
Click the Create button— this will display the setup summary. Double-check your configuration and click OK to create the container.
Once the container creation process is completed, your new container will be available in the Container Station application (under Container menu option).
Connect to GitProtect Management Service by launching it via Container Station, or using your web URL address in the following format:
http://<QNAPaddress>:<port>
To finish the Management Service setup, create a new administrative account, provide the license code, and select data to protect.
Synology must meet the following requirements:
Open the Docker Hub, navigate to the Container menu, and click Create button.
Expand the Image section and select Add image. Then, search for xopero/gitprotect-service. Once located, select the image, click Download, and choose the version tagged as latest. Confirm the selection to proceed.
Once you download the image, select it from the Image drop-down menu in General Settings. Next, define a name for the container and enter it in the Container Name field. Configure container resource limits if necessary.
Check the Enable auto-restart checkbox to ensure the container automatically restarts when the device reboots, and proceed to the next step.
In Volume Settings, click ➕ Add Folder button. To ensure data persistence during container updates or maintenance operations, mount the management databases to an external directory. The databases are stored in /app/Xopero and should be mapped to a designated location outside the container to prevent data loss or inconsistencies.
In the Environment section, define the required variables:
ASPNETCORE_URLS — Management Service ports for http and https protocol (i.e., http://+:PORT_NUMBER;https://+:PORT_NUMBER)
Select host from the Network drop-down menu to enable the container to share the same network namespace as the container's host.
Confirm the configuration and click Next. In Summary, double-check the settings and hit Done to finish the container creation process.
Once you've created the container, you can connect to your XMS using one of the following addresses:
https://yourSynologyAddress:28555 (i.e., https://192.168.0.100:28555)
http://yourSynologyAddress:28556 (i.e., http://192.168.0.100:28556)
Replace <docker_name>.tar with the name of your Management Service Docker image file.
In the above command, replace drive_location_database with the location to mount the database on (from the container to the local directory) — this is important for upgrading the container later. In place of container_name, enter the name of your container and in place of service_port, enter the service port which will be used by GitProtect (by default, Management Service port is set to 28555).
docker load -i <docker_name>.tardocker run -d \
--name <container_name> \
-p <xms_port>:80 \
-v <database_location_outside_container>:/app/Xopero \
xopero/xopero-one-servicedocker run -d \
--name xone \
-p 28555:80 \
-v C:\database_docker\xone:/app/Xopero \
xopero/xopero-one-servicedocker ps -ahttp://<DockerHostAddress>:28555Select the latest image version and click Next to continue.
xopero/gitprotect-service:latestThe management console is available on port 28555 for the encrypted protocol (https), and on port 28556 for the unencrypted (http) protocol.
