Skip to content

# Installation on a Synology NAS

There are different ways to install NetAlertX on a Synology, including SSH-ing into the machine and using the command line. For this guide, we will use the Project option in Container manager.

## Create the folder structure

The folders you are creating below will contain the configuration and the database. Back them up regularly.

1. Create a parent folder named `netalertx`
2. Create a `db` sub-folder

1. Create a `config` sub-folder

1. Note down the folders Locations:

1. Open Container manager -> Project and click Create.

2. Fill in the details:

3. Project name: `netalertx`

4. Path: `/app_storage/netalertx` (will differ from yours)
5. Paste in the following template:

    version: "3"
    services:
      netalertx:
        container_name: netalertx
        # use the below line if you want to test the latest dev image
        # image: "ghcr.io/jokob-sk/netalertx-dev:latest"
        image: "ghcr.io/jokob-sk/netalertx:latest"
        network_mode: "host"
        restart: unless-stopped
        volumes:
          - local/path/config:/app/config
          - local/path/db:/app/db
          # (optional) useful for debugging if you have issues setting up the container
          - local/path/logs:/app/log
        environment:
          - TZ=Europe/Berlin
          - PORT=20211

1. Replace the paths to your volume and comment out unnecessary line(s):

2. This is only an example, your paths will differ.

     volumes:
          - /volume1/app_storage/netalertx/config:/app/config
          - /volume1/app_storage/netalertx/db:/app/db
          # (optional) useful for debugging if you have issues setting up the container
          # - local/path/logs:/app/log <- commented out with # ⚠

1. (optional) Change the port number from `20211` to an unused port if this port is already used.
2. Build the project:

1. Navigate to `<Synology URL>:20211` (or your custom port).
2. Read the Subnets and Plugins docs to complete your setup.