Docker Manager

Docker Manager is a Docker management tool with a graphical user interface, providing an excellent user experience. Docker Manager integrates an image registry and offers various functions through a graphical interface, including image search, download, and container installation and configuration. The millions of images available on Docker Hub provide numerous possibilities for your TNAS to meet your business needs.

Note

Please install the Docker Engine before using the Docker Manager application.

Overview

In the overview interface, you can quickly monitor the real-time status of projects and containers to ensure stable service operation. Additionally, the page visually presents the resource usage of running projects and containers, providing an immediate overview.

Projects

Through the project feature, you can easily define a multi-container application using a Docker-compose.yml configuration file. They can initiate and manage all services specified in the YML file configuration with a single command, addressing the orchestration needs between containers.

Create Project

To create a project using the project feature:

1. Navigate to the Docker Manager application interface and select "Projects" from the left navigation bar
2. Click the "Add" icon in the upper right corner or the "Add Now" button on the page to open the pop-up window for creating a project
3. Sequentially enter the project name, project path, and select the Docker-compose.yml configuration file

Configuration file options include:

• Local TNAS: Choose a configuration file stored locally on TNAS
• Your computer: Upload the configuration file from your computer
• Create a YAML file: Open an editor to create a new Docker-compose.yml file

4. Validate the YAML configuration
5. After validation, click the Apply button

Note

Validating YAML will check the content and format of the docker-compose.yml file in the editor. If the content is empty or the format is incorrect, the "Apply" button will be disabled. Please modify your docker-compose.yml file according to the provided prompts.

Manage Project

On the project page, you can perform the following operations:

• Add item: Add a new item
• Start/Stop: Start or stop the selected item
• Restart: Restart the selected item
• Edit: Modify the selected item
• Delete: Remove the selected item
• Force stop: Forcefully terminate the selected item
• Clear: Stop and delete all containers, networks, images, and data volumes associated with the service
• Build: Reconstruct the project using the configured Docker-compose.yml file

Containers

Containers are running instances of Docker images, representing dynamic manifestations of the images. They can be started, paused, stopped, and deleted. Creating a container requires an image. If you do not have any images, you can visit the registry page to download images uploaded by open-source developers.

Create Container

To create a container in the Docker Manager application:

1. Navigate to the Docker Manager application interface and click "Images" in the left navigation bar
2. Click the "Start" icon in the upper right corner to open the container creation popup window
3. Set the following general information:
   • Container name
   • Choose whether to enable resource limits, automatic restarts, and high-privilege execution for the container
4. Configure mounted directories
5. Select the network type for networking configuration
6. Configure network ports
7. Set environment variables
8. Establish connections with other containers
9. Configure execution commands
10. Confirm the settings and click "OK" to complete the configuration

Note

1. If you have confirmed that your settings are correct but still cannot successfully create a container using an image from Docker Hub, try using a different image. Docker Hub contains custom images uploaded by various developers, and sometimes the quality of the images cannot be guaranteed
2. When configuring container ports, select a port number that is different from ports used by other services to avoid service errors caused by port conflicts

Manage Containers

On the container page, you can perform the following operations:

• Add: Select an image to create a container
• Start/Stop: Start or stop the container
• Restart: Restart a running container
• Edit: Modify the container's configuration
• Delete: Delete the selected container
• Force Stop: Forcefully stop a running container
• Duplicate Container: Duplicate the configuration of an existing container to create a new container
• Export: Export the selected container as a .tar file
• Import: Import a file that can be configured to create a container
• Processes: View the running status of commands executed within the container
• Logs: View logs generated by the container's operations
• Terminal: Access the container's terminal interface

To view the reason for project creation failure

If a project creation fails, you can check the reason by clicking on the "Creation Failed" status and reviewing the error logs.

Images

A Docker image is a special file system that not only includes the files necessary for running programs, libraries, resources, configurations, and other files required by the container runtime, but also contains configuration parameters prepared for runtime. It serves as the foundation for creating and running Docker containers.

Local Images

This section lists images that have been downloaded locally to the TNAS. You can manage all downloaded images through the image function and use them to create containers. Additionally, you can import images by uploading files.

Managing Local Images

On the local images page, you can perform the following operations:

• Start: Launch the selected image and configure the corresponding container
• Import: Upload images stored locally on your computer or on the NAS
• Export: Save the selected image to a NAS folder
• Delete: Remove the selected image

Registry

The registry synchronizes millions of image repositories from Docker Hub, providing access to a vast library of images. In the registry, you can download image files.

How to Download Images from the Registry

1. Locate the desired image in the list or use the search function to find it by keywords
2. Select the image you wish to download and click the "Download" button in the upper right corner
3. Choose the version of the image you want and click "OK"
4. After downloading, manage the image through "Local Images" for further activation and management

Note

When you are unable to load the registry, please check if your network connection is properly established.

Networks

Networks are crucial for containers to communicate with each other, hosts, or external services. Upon installation, there will be a default host network and bridge network. It is advisable to use a user-defined bridge network to control container communication and enable automatic DNS resolution of container names to IP addresses.

In Networks, you can configure and manage network settings. Docker Manager supports the following network interface drivers:

• bridge: Provides an isolated network namespace
• host: Uses the Docker host's network namespace

Manage Networks

• Add: Customize settings for the network
• Delete: Remove the selected network
• Settings: Manage containers connected to the selected network

Settings

Managing System Prompts for Image Download Process in Applications

Logs

This section lists all execution records within the Docker Manager application, allowing you to manage the export and logging of these records.

Managing Logs

On the Logs page, you can view logs for all tasks or select a specific task to view its logs. You can also perform the following operations on the logs:

1. Search: Search for events
2. Refresh: Refresh the logs
3. Export: Export the logs
4. Delete: Delete logs, either all logs or logs for a specific task
5. Settings: Set the log retention policy. Logs that do not meet the policy will be automatically deleted