Choose another installation method

INSTALLATION HELP · 03 / 04

Install CUP on a PC

CUP runs with Docker Engine on Linux and Docker Desktop on Windows.

The Windows guide shows each step with screenshots. The Linux section remains generic because commands vary by distribution.

INSTALLATION HELP

Using GPT or Claude?

Ask it to help you install CUP, one step at a time.

Show prompt
I want to install CUP on a PC. Ask whether I use Windows or Linux, the exact OS version, and whether Docker is running. On Windows, follow the CUP Docker Desktop and WSL 2 guide step by step; explain commands before I run them. On Linux, the guide is generic: ask for my distribution and verify instructions before suggesting a command.

Official CUP guide : https://cup-studio.com/en/instal/pc/

Guide me in plain English, one step at a time, and wait for my reply before continuing. Use the CUP guide and official documentation; do not guess menus, commands or compatibility. If information is missing, say so and help me verify it.

Security: never ask me for a password, activation code, licence serial number, key or token. I will enter licence details only in the official CUP installer. Do not suggest commands that erase, reset or replace data. Explain the effect of any command that changes the system and wait for my approval before asking me to run it. Do not expose sensitive services to the Internet. Ask me to hide personal information in screenshots and error messages.

Start by asking the first question needed for this guide.

Never share your NAS password or licence code/serial number with an AI.

LINUX

Linux installation

Generic guide. Commands may vary by distribution.

01

Install Docker Engine and Compose

Install Docker Engine and the Compose plugin for your Linux distribution, then confirm Docker starts correctly.

02

Download CUP

Download the Docker archive and extract CUP-Installer-Docker.zip.

03

Start CUP

Open a terminal in the extracted folder and run ./start-cup.sh. Choose a data folder and keep the suggested local address.

./start-cup.sh
04

Finish setup

Open the local address shown in your browser. Create the owner login and enter your licence details in the CUP installer.

WINDOWS · DOCKER DESKTOP · WSL 2

Windows installation

Detailed guide with screenshots from your installation. Download the V7.33 Docker installer before you begin.

Download Docker Desktop for Windows ↗↓Download the CUP Docker installer · V7.33ZIP · Windows

Jump to the Windows SFTP walkthrough ↓
Jump to the FileZilla Server FTP/FTPS option ↓

01

Install Docker Desktop

Download Docker Desktop for Windows AMD64. Keep the recommended per-user installation, select WSL 2, leave Windows Containers disabled, then start Docker Desktop and wait for Engine running.

Install Docker Desktop · click to enlarge
02

Enable WSL 2 if requested

Open Terminal as administrator from the Windows Start menu. If Docker reports that Virtual Machine Platform is missing, run the first command and restart if prompted. If WSL is still missing, run the second command.

Enable WSL 2 if requested · click to enlarge
Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform
# Restart Windows if requested, then reopen Docker Desktop.
wsl --install
03

Download and extract CUP V7.33

Download CUP-Installer-Docker-V7.33.zip and extract it into Downloads. Open the docker folder inside the extracted folder; it contains the Dockerfile, Compose file and launcher. Keep its path for the next steps.

Download and extract CUP V7.33 · click to enlarge
Set-Location "$env:USERPROFILE\Downloads\CUP-Installer-Docker-V7.33\docker"
04

Choose where Docker stores data

In Docker Desktop, open Settings → Resources → Advanced → Disk image location. Choose a folder on the desired drive, apply the change, confirm Yes, move it, and wait for Engine running. This setting stores Docker images, containers and volumes together.

Choose where Docker stores data · click to enlarge
05

Check that Docker can build the CUP image

First make sure Docker Desktop says Engine running. In File Explorer, open the docker folder (the one containing Dockerfile), click the address bar at the top, type powershell and press Enter. A PowerShell window opens for this folder. Select Copy below, click inside that window, paste the command and press Enter. Text will scroll while Docker downloads and builds the image; wait for a FINISHED or success message and for the PowerShell prompt to return. This check does not start CUP. If a red error appears, stop here and keep the first error message.

docker build --tag cup-installer:pc --file Dockerfile .

Prepare SFTP on this PC

06

Install the Windows OpenSSH Server

Open Windows Settings → System → Optional features → View features. Search for OpenSSH Server, select Server OpenSSH (not Client OpenSSH), and install it. Wait until the operation says Added.

07

Start the SSH service automatically

Open Services by searching for services or running services.msc. Open the properties of OpenSSH SSH Server, set Startup type to Automatic, select Apply, then Start. Check that the service status is Running.

08

Check the Windows firewall rule

Open Windows Defender Firewall with Advanced Security → Inbound Rules. Check that OpenSSH SSH Server (sshd) is enabled, allows the connection, uses TCP local port 22 and applies to the Private profile. If it is missing, create a TCP port 22 inbound rule for Private networks only. This allows access on your trusted local network; remote Internet access needs a separate secure network setup.

Alternative to OpenSSH: FTP/FTPS with FileZilla Server

09

Install FileZilla Server (optional FTP/FTPS route)

If you choose FileZilla Server, skip the three OpenSSH steps above; they are for SFTP. Download FileZilla Server (not FileZilla Client) from the official site and install it as a Windows service. It is free and supports FTP plus explicit FTPS. Keep the service set to start with Windows.

Download FileZilla Server for Windows ↗FileZilla installation guide ↗
10

Create a FileZilla user and share the arrival folder

In the FileZilla Server administration window, open Rights management → Users and add a dedicated user with a strong password. Under Mount points, map the real Windows folder, for example D:\CUP-Import, as virtual path /. Give only the access needed to list folders and upload/create files; do not enable anonymous access. The Windows account used by the FileZilla service must have read/write permission on the folder.

11

Require FTPS and set the passive port range

Open Protocol settings → FTP and FTP over TLS (FTPS). Keep the listener on TCP port 21 and require Explicit FTP over TLS. In Connection Security, use the certificate generated for testing or install a trusted certificate for regular use. In Passive mode, set a fixed range such as TCP 50000–50010. Plain FTP is unencrypted; enable it only if a device on your trusted local network cannot use FTPS. Restart or apply the server settings.

FileZilla guide: FTPS and certificate ↗FileZilla guide: passive ports ↗
12

Allow and test FileZilla on the local network

In Windows Defender Firewall, allow inbound TCP 21 and TCP 50000–50010 on the Private profile only. From another device on the same network, use FileZilla Client: enter the PC’s local IP, port 21, the new username and password, choose Require explicit FTP over TLS, and use passive mode. Upload a test image. Because the FileZilla mount point exposes the arrival folder as the account root, its remote path is /.

FileZilla guide: test network setup ↗
13

Choose and test the arrival folder

Choose a dedicated folder, for example D:\CUP-Import, on the disk you want to use. Grant read/write permission to the account used by your selected transfer server. From another device on the same network, test with either SFTP to the PC’s local IP on TCP 22 (OpenSSH) or explicit FTPS on TCP 21 (FileZilla Server) with its passive range. Upload a test image and note the exact remote path shown in the client. With FileZilla’s mount point set to /, the remote path is /; with SFTP, it may differ from the Windows path. Use this tested path in CUP.

14

Start CUP and connect its arrival folder

Return to the same PowerShell window, still open in the docker folder. To start the setup, copy the last command below, paste it in PowerShell and press Enter. The script then asks one question at a time: type one answer and press Enter before the next question.

  • CUP local port:Enter 8080, the installer’s default, or choose another free port. This is CUP’s web port on this PC; it is separate from transfer ports 21 and 22.
  • Shared folder:Enter the exact Windows folder you chose and tested, for example D:\CUP-Import. The FileZilla user or SFTP account must be able to write there.
  • Existing FTP/SFTP server:Enter the PC’s local IP address or name for transfers on your home network. If the server is not ready, leave this blank and finish later in docker/.env.
  • Protocol:Choose ftps for FileZilla with TLS, sftp for Windows OpenSSH, or ftp only on a trusted local network. FTP sends credentials and files without encryption.
  • Server port:Use 21 for FileZilla FTP/FTPS or 22 for Windows OpenSSH SFTP. This is separate from CUP’s web port.
  • Path shown in the client:Enter the exact remote path from your test. For FileZilla, use / if the arrival folder is mapped as the user's root. For SFTP, use the path shown by the client; it can differ from D:\CUP-Import.

Only if PowerShell says scripts are disabled: run this temporary permission in the current window first. Press Enter and confirm if asked.

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\start-cup.ps1

The launcher does not install or start OpenSSH or FileZilla Server, create transfer accounts, change firewall rules or open router ports. It mounts the arrival folder separately in Docker; CUP application data remains in its Docker volume.

15

Check that CUP is running

Wait for Docker Compose to finish. In Docker Desktop, verify that the cup container is running and the selected local port (8080 by default) is mapped to container port 80. The arrival folder is mounted separately at /srv/cup-import. The test setup listens on 127.0.0.1, so CUP opens from this PC only.

16

Open and activate CUP

Open http://localhost:8080/ in your browser, or use the port you selected. Enter the owner name, the email associated with a valid CUP licence, a login and password, and the licence code. Enter these private details only in the installer. If the licence is rejected, verify the licence and email. Stop at activation if you do not have a valid licence.

Open and activate CUP · click to enlarge
17

Confirm CUP is ready

After validation, CUP Central downloads the complete version allowed by the licence. Continue until the screen confirms that CUP is ready and package verification is complete. The version number shown may change.

Confirm CUP is ready · click to enlarge

For this first test, CUP listens on 127.0.0.1 and is accessible from this PC only. For a NAS reverse proxy to reach the PC later, change the listen address to the PC’s local IP and allow that traffic in the firewall; do not forward CUP’s port directly from the Internet. The arrival folder remains separate from application data. Do not delete Docker volumes containing data. If CUP is already installed with the previous procedure, do not run this script with the default settings: it would create another container and a new volume.

This Docker archive prepares storage and the arrival folder; the CUP application is downloaded separately from CUP Central. The application version depends on what is published there. To use V7.33 FTP/SFTP settings, CUP must also receive the V7.33 update through its update centre.

NEXT STEP · AFTER INSTALLATION

Make CUP reachable over the Internet

This diagram is for a self-hosted installation behind your own Internet gateway.

View the network diagram