Install with Docker

Check your NAS

The NAS must provide Docker/containers, and Portainer CE must be connected to its local environment. Check the model and, especially on an older NAS, read its kernel with uname -r (the compatibility guide explains how). CUP’s tested minimum is Linux 3.10.108.

Recent NAS — kernel with getrandom: the image uses the kernel’s native function.
Older NAS — kernel without getrandom: from the tested 3.10.108 minimum, the image detects this and automatically enables the APR fallback for this case.
Below 3.10.108: do not install CUP until a compatible update or model check is available. Docker must also start, and the CPU architecture must be supported.

Download the archive and prepare storage

Download the TAR.GZ archive below. In File Station, create a dedicated folder for CUP data, for example /volume1/docker/cup/cup_data. Do not use another CUP installation’s folder. Note the NAS’s local IP address and choose a free port, for example 18080.

Build the image in Portainer

1. Open local → Images → Build a new image.
2. Name the image cup-installer:nas-test and choose URL.
3. URL: https://cup-studio.com/downloads/CUP-Installer-Docker.tar.gz
4. Dockerfile path: docker/Dockerfile. Select Build the image and wait for the Successful confirmation. Then check that cup-installer:nas-test appears in Images.

The build downloads required components and can take several minutes. It runs on the NAS; the archive is hosted on CUP Studio.

Create the CUP stack

In Portainer, open Stacks → Add stack, name it for example cup-nas, and choose Web editor. Paste the Compose file below, then replace the IP address, port and data path with your values. The port must be free and the folder must exist.

services:
  cup-nas:
    image: cup-installer:nas-test
    container_name: cup-nas
    restart: unless-stopped
    ports:
      - "NAS_IP_ADDRESS:18080:80"
    volumes:
      - /volume1/docker/cup/cup_data:/srv/cup
    environment:
      TZ: Europe/Paris
      CUP_DATA_LABEL: /volume1/docker/cup/cup_data
      CUP_PUBLIC_URL: ""

Select Deploy the stack. In Containers, check that cup-nas is running and port 18080:80 is published. If the port is already in use, remove the stack, choose another free port and deploy again.

Open the installer and finish setup

From a device on the same network, open http://NAS_IP_ADDRESS:18080 (using the port you chose). Create the owner login, enter the email and code associated with your CUP licence, then wait for the download and verification to finish. When the screen says CUP is ready, select Enter CUP and sign in with the login you created.

The local HTTP address is for first access on your network. Before allowing Internet access, configure a domain name, HTTPS and your NAS reverse proxy. Do not expose the container port directly to the Internet.

Configure your CUP workspace

1. In Management → Preferences, check your Production profile: display name, surname, email and phone.
2. If you like, personalize CUP’s identity: display name, logo and colours. You can change these settings later.
3. Before sending invitations, configure the SMTP server under Preferences → Installation & health and send a test email. If you do not have your provider’s settings, ask your hosting provider or email administrator.
4. Enable two-step verification if it is available for your account, then save your preferences.

Take your first steps

1. In the Production space, open Clients and create your first client with their name and contact details.
2. Open the client record and create a project. Give it a name, choose its pipeline stages and add a short brief if useful.
3. Import a few images into a series or gallery to check storage and previews. Start with a small batch of files.
4. Once the test email works, invite a secondary email address or a trusted client to the project, then check the experience in a private browser window.

CUP files and projects remain in the data folder mounted into the container. Include that folder in your regular NAS backups.

Enable FTP/FTPS on a Synology (optional)

In DSM, open Control Panel → File Services → FTP. Enable FTP and FTP SSL/TLS (FTPS). The control port is usually TCP 21. Under FTP passive port range, keep the displayed range (default 55536–55899) or set a fixed range, then use that same range in the NAS and router firewall rules for Internet access. For SFTP, scroll to the SFTP section on the same page and enable the service: it uses TCP 22 and is a different protocol from FTP/FTPS.

For a local network test, no router port forwarding is needed. Avoid unencrypted FTP over the Internet. The NAS folder served by FTP must also be accessible to CUP inside the container and selected as its arrival folder; enabling FTP alone does not connect it to CUP automatically.