# Synology

There are two ways to install the Domotz Collector on a Synology NAS. The recommended method is through the **Package Center**, which provides a straightforward installation. If the Domotz package is not yet available for your NAS model, you can install the Collector using **Docker** through the Container Manager instead.

## 1. Installing the Collector Using the Package Center

To install the Domotz Collector on your Synology:

1. Open the **Package Center** on your Synology NAS
2. Search for **Domotz**
3. Once you find the Domotz application, click **Install** Installing Domotz Network Monitoring and Management from Synology Package Center. 1. Open Synology Package Center. 2. In the search bar, type "Domotz" and press Enter. 3. Select "Domotz Network Monitoring and Management" from the results. 4. Click the "Install" button to begin the installation. Additional Information: - The application provides network monitoring and management features, including real-time alerts and topology mapping. - Current download count is 297,035. - Developer and publisher: Domotz Inc. - Category: Utilities, Security.
4. Once the installation is completed, click **Open**  Opening the Domotz Network Monitoring and Management Application 1. Navigate to the Package Center in your Synology interface. 2. In the left sidebar, select "All Packages." 3. Find and select "Domotz Network Monitoring and Management" from the list. 4. Confirm that the status is "Running" in green text. 5. Click the "Open" button to launch the application. Additional Information:  - The application is developed by Domotz Inc. - It provides network management tools with features like real-time alerts and remote access. - The installed version is 3.7.1-700570, categorized under Utilities and Security. You will be redirected to an activation page. If you are not automatically redirected, you can access the activation page by navigating to **http://[NAS_IP]:3000** in your browser.

**Note**: Another way to activate the Collector would be to download the**Domotz mobile app** on your phone and follow the steps to**Add a New Collector**: the app will find the Domotz Collector running from your Synology NAS automatically. ‍

If you already have a Domotz account, you can log in straight away. Otherwise, you can create a Domotz account using the **Sign up** link at the bottom of the login fields:

Setup screen for Domotz Pro on Synology.

1. Enter your email in the "Email" field.
2. Enter your password in the "Password" field.
3. Optionally, select "Remember me on this browser" to stay logged in.
4. Click "Complete the setup" to finish the configuration.
5. Use "Forgot Password?" if you need to reset your password.
6. Click "Sign up" if you need to create a new account.

Once logged in, proceed as follows:

**Name your Collector**, and click on **Next**:

Naming Your Collector

1. Enter a name for your Collector in the "Collector Name" field for easy identification. The field shows "My New Collector" as an example.
2. Click the "Next" button to proceed.
3. To replace an existing Domotz Collector on the network, click the "Start the migration" link.

The collector will complete the activation, and you will be redirected to the **Collector Discovery** section, while the initial discovery runs. Once completed, you are good to start managing the site through Domotz:

Collector Discovery Interface Overview

1. Navigate to the "Collector" section on the top menu.
2. Select "Discovery" under the "Collector" tab in the left sidebar.
3. The main panel displays a green notification: "Initial Discovery Complete," indicating that the system will continue to scan the network environment.
4. Below the notification, view the discovery stats: 51 "Discovered Devices," 1 "Subnets Scanned," 0 "VLANs Detected," and "100% SNMP Authenticated."
5. Review the bar charts illustrating "Discovered Device Types" and "Discovered Device Makes" to understand the different types and manufacturers of devices detected within your network.

To learn how to configure your Domotz Collector's initial settings, please refer to our **[Getting Started Guide](https://help.domotz.com/onboarding-guides/how-to-get-started-with-domotz/#htoc-device-discovery)**.

## 2. Installing the Collector Using the Container Manager (Docker)

Some Synology NAS models may not yet have the Domotz Collector application available, as new packages require approval from Synology and this process can take some time. In these cases, you can install the Domotz Collector using Docker instead. To do this, install the Container Manager package on your Synology NAS, then use it to download and run the Domotz Collector Docker container.

1. Open the **Package Center**, search for and **install**the **Container Manager** Installing Container Manager in the Package Center. 1. In the Package Center, use the search bar at the top to type "Container Manager." 2. Review the search results under "All Packages." 3. Locate the "Container Manager" package, listed under "Utilities." 4. Click the "Install" button next to "Container Manager" to begin installation.
2. Once installed, **open**it and navigate to the **Registry**section inside the **Container Manager**. Search for **"domotz/domotz-collector"**: Downloading a Container Image in Container Manager 1. Open the Container Manager interface. 2. In the left sidebar, click on "Registry" to view available container images. 3. In the search bar at the top, enter the name of the image you want to download, such as "domotz/domotz-collector." 4. Once the image appears in the list, select it to highlight the row. 5. Click the "Download" button at the top to begin downloading the selected container image.
3. **Download**the **latest**image (it will take a few minutes until the download completes).
4. Navigate to the **Container**section and click on **Create**
5. Select the Image **domotz/domotz-collector:latest**, check the box for **Enable auto-restart** and click on **Next** Creating a Container in the General Settings Menu 1. Select the desired image from the dropdown menu labeled "Image." Currently selected is "domotz/domotz-collector:latest." 2. Enter a name for the container in the "Container Name" field. The example shows "domotz-domotz-collector-1." 3. To enable resource limitations, check the box labeled "Enable resource limitation." Adjust the CPU priority and memory limit as needed. In the example, resource limitation is not enabled. 4. Optionally, enable the "Enable auto-restart" checkbox to allow the container to restart automatically. This option is selected in the example. 5. If you want to set up a web portal, check "Set up web portal via Web Station" and configure the container port. The example shows this option unchecked. 6. Click "Next" to proceed with the container creation process.
6. **OPTIONAL**: To keep your Collector configuration persistent across container rebuilds or major image updates, you will need to map a configuration file from your NAS to the container.   - First, enable SSH on your Synology NAS (**Control Panel > Terminal & SNMP > Enable SSH**), then connect via SSH and run the following command: "`**mkdir -p /volume1/docker/domotz/config && touch /volume1/docker/domotz/config/domotz.json**`". - Return to the container creation wizard, click **Add File**, and select the **domotz.json** file created in the previous step: Create Container - Advanced Settings 1. Under "Port Settings," enter DSM ports in the Local Port field to map them with container ports. Click "+ Add" to list the container's exposed ports. 2. In "Volume Settings," map container volumes to shared folders on DiskStation. Click "+ Add Folder" to select a folder or "+ Add File" to add specific files. 3. In "Environment," add environment variables to apply to the container. Enter a variable in the "PATH" field, and click "+ Add" to include it. 4. Click "Next" to proceed to the next step. Creating a Container and Selecting a Config File 1. In the "Add" window, navigate the folder tree on the left to find the desired file. Here, follow the path: `dsm721 > docker > domotz > config`. 2. In the main panel, locate and select the file named "domotz.json". It is a JSON file with a size of 0 Bytes. 3. Once selected, choose "Select" at the bottom to confirm the file choice. 4. Click "Next" to proceed to the next step of the container creation process. Use "Cancel" to exit without saving changes, or "Back" to return to the previous step. - In the **Mount Path** field, enter `/opt/domotz/etc/domotz.json`: Creating a Container with Advanced Settings in Docker 1. In the Port Settings section, enter the desired port in the Local Port field to map it to the container's port. For example, set Local Port to 3000 and select TCP as the protocol. 2. In the Volume Settings section, map the container volumes to shared folders on DiskStation. Add a mapping by specifying the path "/opt/domotz/etc/domotz.js" for access and choose Read/Write permissions from the dropdown menu. 3. In the Environment section, add any necessary environment variables to apply to the container. 4. Click "Next" to proceed.
7. Scroll down and click on **Container Capabilities** and enable **NET_ADMIN** (_this capability is required for the Collector to perform network scanning and discovery_) Configuring Container Capabilities 1. In the "Advanced Settings" of the container creation window, select the option "Configure capabilities." 2. Click the "Configure capabilities" button to open the capabilities configuration window. 3. In the "Capabilities" window, locate the "NET_ADMIN" capability from the list and check the box to enable it. 4. Click "OK" to save the changes and proceed with the container setup.
8. Change the **Network** from bridge to **host** (_**host**networking is required so the Collector can discover and monitor devices on your local network_) Configuring Network Settings in Container Setup 1. In the "Create Container - Advanced Settings" window, locate the "Network" section. 2. Choose the network to which the container will connect by selecting an option from the "Network:" dropdown menu. For this step, select "host". 3. After configuring the necessary network settings, click the "Next" button to proceed with the container setup.
9. Review your configuration summary to confirm the settings are correct, then click **Done** and wait for the container to initialize Create a Docker Container: Summary Page 1. Review the "Container Name" which is set to "domotz-domotz-collector-1." 2. Check the "Volume" section: The file "/docker/domotz/config/domotz.json" is mounted to "/opt/domotz/etc/domotz.json" and is not set to read-only. 3. Confirm that the container uses the same network as the Docker host. 4. Verify "Environment Variables": The "PATH" is set to "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin." 5. CPU Priority is set to "Auto" and there is "No Limit" on memory. 6. Command is set to "bash run_agent.sh." 7. Capabilities section shows "NET_ADMIN" is added, and none are dropped. 8. The option to "Run this container after the wizard is finished" is checked. 9. Click "Done" to complete.
10. Access your Synology NAS on port 3000 (****http://[NAS_IP]:3000****) and proceed with the collector activation Login Page for Domotz Pro 1. Enter your email address in the "Email" field. 2. Enter your password in the "Password" field. 3. Optional: Check the box labeled "Remember me on this browser" if you want the browser to remember your login details for future visits. 4. Click the "Log in" button to access your account. 5. If you have forgotten your password, click the "Forgot Password?" link to reset it. 6. If you don't have an account, click the "Sign up" link to create a new account.

To learn how to configure your Domotz Collector's initial settings, please refer to our **[Getting Started Guide](https://help.domotz.com/onboarding-guides/how-to-get-started-with-domotz/#htoc-device-discovery)**.