# Installation within a Docker container {% tabs %} {% tab title="Docker" %} ## Deployment 1. To install the **Xopero ONE** agent within a **Docker** container, use the images available on **Docker Hub**: ```docker docker pull xopero/gitprotect-agent:latest ``` 2. Create a host directory for the **Xopero ONE Management Service** container databases (which are located at `/app/Xopero` inside the container) to store databases outside the container: ```docker mkdir -p /opt/gitprotect-agent/data ``` 3. Run the container with the correct volume mounting and environment variables using the following command: ```docker docker run -v /host/path:/container/path -e ENV_VAR=value image_name ``` ```docker docker run -d \ --name \ -e ManagementServiceUrl="" \ -e XoperoOverriddenHostName="" \ -v /opt/gitprotect-agent/data:/app/Xopero \ --restart unless-stopped \ xopero/gitprotect-agent:latest ``` {% code title="Example" overflow="wrap" %} ```docker docker run -d \ --name xopero-agent \ -e ManagementServiceUrl="https://192.168.1.10:28555" \ -e XoperoOverriddenHostName="Docker_agent" \ -v /opt/gitprotect-agent/data:/app/Xopero \ --restart unless-stopped \ xopero/gitprotect-agent:latest ``` {% endcode %} 4. Check if the container works correctly by using the following command: ```docker docker ps ``` 5. Once all the above steps are completed, the agent will report to the **Management Service** panel for activation. {% endtab %} {% tab title="QNAP NAS (CS > 3.0)" %}

Prerequisites Environment setup Deployment

## Prerequisites **QNAP** with: * x86 or x64 CPU (**ARM is not supported**) * minimum 2GB RAM * **Container Station** app from **AppCenter** *** ## Environment setup 1. Download the **Container Station** app from the **App Center**. 2. Login to your **QNAP** web panel and open the **AppCenter** application. In **QNAP Store**, select **All Apps** and search for the **Container Station**.
3. 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. *** ## Deployment 1. Open the **Container Station** application, select the **Containers** tab, and click the **Create** button.
2. In **Image Configuration** choose the **Advanced mode** option. In the image type, select **Docker image**, and in the **Image** field, paste the following command: ```docker xopero/gitprotect-agent:latest ``` 3. Ensure the **Try pulling image from the registry before creating the container** option is checked, and hit **Next**.
4. 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
5. In the **Configure Container** tab, navigate to ⚙️**Advanced Settings**. 6. Go to the **Environments** section and click **Add New Variable** to add new environment variables with the following values: {% code title="ASPNETCORE\_URLS" overflow="wrap" %} ```docker http://+:80 ``` {% endcode %} {% code title="DOTNET\_RUNNING\_IN\_CONTAINER" overflow="wrap" %} ```docker true ``` {% endcode %} {% code title="ManagementServiceUrl" overflow="wrap" %} ```docker Xopero ONE Management Service address ``` {% endcode %} {% hint style="warning" %} Replace `Xopero ONE Management Service address` with your **Xopero ONE Management Service** address**\***. {% endhint %} **‼️\*ManagementServiceUrl** – your **Xopero ONE Management Service** (**XMS**) address in one of the following formats (depending on the **XMS** deployment model): 1. `http://ipaddress:port`, i.e., `http://192.168.0.1:28555` 2. `https://XMSID.ads.xopero.com`, i.e., `https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com` {% code title="XoperoOverriddenHostName" %} ```docker your custom QNAP container name ``` {% endcode %}

Example of correctly filled environments variables.

7. Click **Apply** to save your changes. 8. Navigate to **Storage** tab—here you can mount your **QNAP** volumes to the **Xopero ONE** agent docker container. {% hint style="success" %} You can mount multiple directories to the container using **Add Volume** button and repeating the operation. {% endhint %} {% hint style="info" %} To back up data from your **QNAP** device, choose **Bind Mount Host Path** under **Add Volume** drop-down menu — it lets you specify which data the **Xopero ONE** container can access. Select a directory from the host and enter the path visible inside the container in the **Container** field. {% endhint %}
9. Next, double-check and confirm your settings, then click **Finish** to create the container.
10. **Container Station** will download the latest **Xopero ONE** image and create the container based on that image.
11. Once the container creation process is completed, your new container will be visible under **Container** tab in **Container Station**.
12. You can now connect to your **Xopero ONE Management Service** admin panel to activate the agent. {% endtab %} {% tab title="QNAP NAS (CS < 3.0)" %}

Prerequisites Environment setup Deployment

## Prerequisites **QNAP** with: * x86 or x64 CPU (**ARM is not supported**) * minimum 2GB RAM * **Container Station** app from **AppCenter** *** ## Environment setup 1. Download the **Container Station** app from the **AppCenter**. 2. Login to your **QNAP** web panel and open the **AppCenter** application. In **QNAP Store**, select **All Apps** and search for the **Container Station**.
3. 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. 4. Once done, download the **Xopero ONE** agent **Docker** image, which is available [on our official server](https://xopero.com/download/xopero_one/latest/client-image.tar). *** ## Deployment 1. Open the **Container Station** application and navigate the **Import** tab. 2. Click the ➕**Import** button to upload the previously downloaded **Docker** image file.
Importing the docker file
3. In **Create Import Task** window, select the source type and file path of the **Xopero ONE** agent **Docker** image and hit **Next** to continue. {% hint style="info" %} Selecting a file from a local source enables you to choose files stored on your device. Alternatively, you can use the **NAS** option to access files directly from **QNAP**. {% endhint %}
Creating import task
4. 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
Creating container
5. Click the ⚙️**Advanced Settings >>** button and navigate to the **Environment** section.
6. To add a new environment variable, click the **Add** button, name it **ManagementServiceUrl**, and set its value to your **Xopero ONE Management Service** address**\***. **‼️\*ManagementServiceUrl** – your **Xopero ONE Management Service** (**XMS**) address in one of the following formats (depending on the **XMS** deployment model): > a. `http://ipaddress:port`, i.e., `http://192.168.0.1:28555` > > b. `https://XMSID.ads.xopero.com`, i.e., `https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com`
create container
7. Go to the **Shared Folders** section — here you can mount your **QNAP** volumes to the **Xopero ONE** agent **Docker** container. {% hint style="success" %} You can mount multiple directories to the container using **Add** button in **Volume from host** section and repeating the operation. {% endhint %}
Setting shared folders
8. To back up data from your **QNAP** device, choose **Add** under **Volume from host** section— it lets you specify which data the **Xopero ONE** 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. {% hint style="info" %} For instance, if you need to back up a directory named **Backup** inside a public shared folder, set the **Volume from the host** field to `/Public/Backup`. The **Mount Point** can be different, i.e., `/Backup`. {% endhint %} 9. Once you're done with the above steps, click **Create** to continue. 10. In the **Summary** window double-check your settings, then click **OK** to finish the configuration.
Summary window
10. You can now connect to your **Xopero ONE Management Service** admin panel to activate the agent. {% endtab %} {% tab title="Synology NAS" %} ## Deployment {% hint style="warning" %} To deploy the **Xopero ONE** agent on a **Synology** device using **Docker**, use the **Container Manager** application. If it's not installed, download it from the **Package Center**. {% endhint %} 1. Navigate to the **Container** tab and click the **Create** button. Expand the **Image** section and click **Add image**, then search for `xopero/gitprotect-agent` image.
2. Select the image, click **Download**, and choose the version tagged as **latest**. Click **Select** to confirm. 3. Once the image is downloaded, select it from the **Image** field drop-down menu. 4. Next, define a custom name for the container. Additionally, configure container resource limits if needed. 5. Check the **Enable auto-restart** option to ensure the container automatically restarts when the device reboots, then click **Next** to proceed.
6. 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. {% hint style="info" %} To protect data stored in the **Public** directory, select this folder and specify **the same path** to ensure consistency between the host and the container's file systems. {% endhint %} {% hint style="success" %} You can mount multiple directories to the container by clicking ➕ **Add Folder** and repeating the operation. {% endhint %} 7. Additionally, to ensure data persistence during container updates or maintenance operations, mount agent 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.
8. Next, in the **Environment** section, define the required variables: > **ManagementServiceUrl** — your **Xopero ONE Management Service** (**XMS**) address in one of the following formats (depending on the **XMS** deployment model): > > a. `http://ipaddress:port`, i.e., `http://192.168.0.1:28555` > > b. `https://XMSID.ads.xopero.com`, i.e., `https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com` > > **XoperoOverriddenHostName** — specify agent's name to facilitate identification
9. 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.
{% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://helpcenter.xopero.com/xopero-one-en/deployment-and-configuration/xopero-one-agent/installation-within-a-docker-container.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.