Installation within a Docker container

Deployment

1. Download Xopero ONE Management Service (XMS) Docker image to your device. Next, open cmd console and pull XMS Docker image using the following command:

docker load -i docker_name.tar

1. Once the Docker image is imported, use the following command to create a container:

docker run -d \
  --name <container_name> \
  -p <xms_port>:80 \
  -v <database_location_outside_container>:/app/Xopero \
  xopero/xopero-one-service

docker run -d \
  --name xone \
  -p 28555:80 \
  -v C:\database_docker\xone:/app/Xopero \
  xopero/xopero-one-service

1. Next, use the following command to view the list of containers (or view the list in Docker Desktop):

1. If you see no errors, that means the XMS implementation was done correctly. You can open the Xopero ONE Management Service web panel using the following address:

1. Before you start using XMS you must create an administrator account and assign a license to your unit.

Prerequisites Environment setup Deployment

Prerequisites

QNAP with:

• x86 or x64 CPU (ARM is not supported)

• minimum 2GB of RAM

• Container Station app from the App Center

Environment setup

1. Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station (CS).

1. Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.

2. Click Start Now to proceed.

Deployment

1. In the Container Station application, open the Containers menu option, and click the Create button.

1. In Image Configuration, choose Advanced mode. For Image type select Docker image, and in the Image field, paste the following:

1. Ensure Try pulling the image from the registry before creating the container. checkbox is checked, then hit Next.

1. In the Configure Container tab, configure the Xopero ONE 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 Xopero ONE service on the container on port 80 (the recommended host port number is 28555)

1. Double-check your configuration settings and hit Finish.

1. Container Station will download the latest Xopero ONE image and create the container based on it.

1. Once the container creation process is completed, your new container will be available in the Container Station application (under Containers menu option).

1. Connect to Xopero ONE using your web URL address in the following format (you can find it under Container Details > General > Web URL):

http://QNAPaddress:port

1. To finish the XMS setup, create a new administrative account, provide the license code, and select data to protect.

Prerequisites Environment setup Deployment

Prerequisites

QNAP with:

• x86 or x64 CPU (ARM is not supported)

• minimum 2GB of RAM

• Container Station app from the App Center

Environment setup

1. Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station (CS).

1. Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.

2. Click Start Now to proceed.

Deployment

1. Open the Container Station application and click ➕ Create in the left-hand side menu.

2. Copy and paste xopero/xopero-one-service in the search field and hit Enter to search for XMS Docker image (it should be the first search result in Docker Hub tab).

3. Click the Install button next to the Docker image to start the container creation process.

1. Select the latest image version and click Next to continue.

1. In the Create Container window, configure the Xopero ONE 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

1. Scroll down a little and click the ⚙️ Advanced Settings>>

2. 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 Xopero ONE service (the recommended, default port number is 28555).

1. Click the Create button— this will display the setup summary. Double-check your configuration and click OK to create the container.

1. Once the container creation process is completed, your new container will be available in the Container Station application (under Container menu option).

1. Connect to Xopero ONE Management Service by launching it via Container Station, or using your web URL address in the following format:

http://QNAPaddress:port

1. To finish the XMS setup, create a new administrative account, provide the license code, and select data to protect.

Prerequisites Deployment

Prerequisites

Synology must meet the following requirements:

• x86 or x64 CPU (ARM is not supported)

• minimum 2 GB of RAM

• Docker app from the Package Center

Deployment

1. Open the Docker Hub, navigate to the Container menu, and click Create button.

2. Expand the Image section and select Add image. Then, search for xopero/xopero-one-service. Once located, select the image, click Download, and choose the version tagged as latest. Confirm the selection to proceed.

1. 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.

2. Check the Enable auto-restart checkbox to ensure the container automatically restarts when the device reboots, and proceed to the next step.

1. 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.

1. 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)

1. Go to Advanced Settings. Select bridge from the Network Name drop-down menu in the Network tab to enable the container to share the same network namespace as the container's host, then select Use the same network as Docker Host checkbox at the bottom.

1. Confirm the configuration and click Next. In Summary, double-check the settings and hit Done to finish the container creation process.

1. 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)