Docker DSM

In this page, you will be guided through creating a container in which you can run DSM.

To create Docker DSM:

Click Add to start a Docker DSM creation wizard.

1. CPU:
• Container name:Enter your Docker DSM name. This will be your Docker DSM system name. It cannot be the same as any existing docker containers.
• Execute container using high privilege: Tick this checkbox if you wish to create an encrypted shared folder, establish a remote connection, or mount a virtual drive or remote folder.
• Enable resource limitation:
• CPU Priority: Select a CPU priority level.
• Create shortcut on desktop:
• Status page: Clicking on this shortcut will allow you to view the Docker DSM's staus and perform simple actions (e.g. start, stop, restart).
• Webpage: Clicking on this shortcut will connect you to your Docker DSM for you to log in.
2. Network settings:
• Network interface: Select the network interface you want to connect to. All Docker DSM packets will pass through this network.
• Get network configuration automatically (DHCP): Allow Docker DSM to access basic settings through DHCP.
• Use manual configuration: Manually configure network settings for Docker DSM by entering an IP address, subnet mask, and gateway.
• Enable VLAN: You can add Docker DSM to a specified VLAN.
3. Storage settings:
• Create a shared folder to store data and configurations: you can select a volume to create a shared folder for the storage of your Docker DSM system configurations and user data.
• Restore config and data from an existing shared folder: The system will make a list of shared folders that contain Docker DSM configurations but are not being used by Docker DSM. You can use this folder to restore config and data for Docker DSM.
• Enable shared folder quota: YOu can use this setting to limit the storage space used by Docker DSM.

Note:

• Shared folder used by Docker DSM must be stored on a btrfs volume. If you move the shared folder to a different volume, Docker DSM cannot run.
• When a shared folder storing Docker DSM is deleted, Docker DSM will also be deleted.
• To ensure Docker DSM can run smoothly, please make sure the volume it is using is not low on space.
4. DSM installation file:
• You can download Docker DSM installation files from the Synology Server.
5. Summary:
• You can check your settings here.
• Run this container after the wizard is finished: Enable this setting to automatically run Docker DSM after wizard completion.

Edit Docker DSM

Select a stopped Docker DSM and click Edit to do the following:

1. Basic options: includes docker privileges, CPU and shortcut creation.
2. Network settings: includes network interface and network configuration (Manual or DHCP).

Details

You can view your Docker DSM status and processes in this tab.

1. Overview: You can view Docker DSM privileges, CPU, desktop shortcut status, and network interface settings. You can also start, stop, restart and force stop Docker DSM.
2. Process: In this tab you can view Docker DSM processes and CPU and memory status.
3. Terminal: You can use the terminal of your Docker DSM. (Your browser should suppport Web sockets)

Actions

You can perform the following actions on Docker DSM:

1. Start: Start a stopped Docker DSM.
2. Stop: Stop a running Docker DSM.
3. Restart: Restart a running Docker DSM
4. Force stop: Force strop a running Docker DSM. Force stopping may lead to data corruption.
5. Delete: Delete a Docker DSM. The shared folder containing Docker DSM system configurations will not be deleted. This folder will no longer be a read-only folder and can be used to restore Docker DSM.
6. Restore: Restore a failed Docker DSM.

Connecting to Docker DSM

Click Connect to launch the Docker DSM login page in a new tab.

Upgrading Docker DSM

After upgrading your DSM version, you must upgrade Docker DSM to continue using it. Under normal circumstances, the system will update Docker DSM for you automatically. If you cannot connect to the Synology server to download the installation file, you may need to update manually. Select your Docker DSM and click Update > Manual update and select an installation file to update your Docker DSM.

License

There is a free and unlimited license bundled with Docker package.

To add new license

1. In the Docker DSM page, click License.
2. Click Add.
3. Check the License agreement and choose Agree before clicking Next.
4. Check the Synology account that the licenses will tie to and click Next.
5. Enter the License key.
6. If you want to enter serveral license keys, click the "+" button beside the license key you previously entered. Click Next.
7. The system will now check whether the license key is valid. Click Next to go to an overview page.
8. Click Enter to return to the license page. Your new license will appear as Valid.

The license rules are as follows:

• When you have enough valid licenses, you will be able to create and launch Docker DSM.
• There is grace period of 7 days after a license is expired, whereby within the 7 days, the running Docker DSM instances will not be shut down, but you cannot create a new Docker DSM or launch a stopped Docker DSM. After the grace period is expired, if there are not enough valid licenses, all running Docker DSM instances will be shut down.