-
Notifications
You must be signed in to change notification settings - Fork 0
INSTALLATION en
OpenCloudTouch can be installed in several ways. Choose the option that best fits your setup.
The easiest method! Flash the ready-made image to an SD card, plug it into your Pi — done.
| Image | Architecture | Raspberry Pi Models |
|---|---|---|
opencloudtouch-arm64 |
64-bit | RPi 3, 4, 5 |
opencloudtouch-armhf |
32-bit | RPi 2, 3 (32-bit) |
Download the appropriate image for your Pi from the Releases page:
-
RPi 3 / 4 / 5 →
opencloudtouch-arm64-*.img.xz -
RPi 2 →
opencloudtouch-armhf-*.img.xz
- Download the Raspberry Pi Imager
- Launch the Imager → Use custom → Select the
.img.xzfile - Optional: Click ⚙️ to pre-configure Wi-Fi and SSH
- Flash to your SD card
- Insert the SD card into your Pi and power it on
- Wait 2-3 minutes (first boot takes a bit longer)
- Open in your browser: http://opencloudtouch.local:7777
To configure Wi-Fi before first boot (instead of Ethernet):
- After flashing: Open the boot partition of the SD card
- Edit the file
oct-config.txt:
WIFI_SSID=MyNetwork
WIFI_PASSWORD=MyPassword
WIFI_COUNTRY=DE- Insert SD card and boot — Wi-Fi will be configured automatically
| User | oct |
| Password | opencloudtouch |
| SSH | Enabled |
| Web UI | http://opencloudtouch.local:7777 |
⚠️ Please change the password after first login!passwd
For users who already have a Raspberry Pi or want to set one up.
- Raspberry Pi 2, 3, 4 or 5 (with at least 1 GB RAM, recommended 2 GB)
- microSD card (≥ 8 GB, recommended 16 GB)
- Power supply (USB-C, 5V/3A)
- Ethernet cable or Wi-Fi connection
- Download and install the Raspberry Pi Imager
- Launch the Imager and select:
- Operating System: Raspberry Pi OS Lite (64-bit) — recommended, no desktop needed
- Storage: Your microSD card
- Click the gear icon ⚙️ for advanced settings:
-
Hostname:
opencloudtouch - Enable SSH: Yes (with password)
- Username/Password: Choose a secure password
- Configure Wi-Fi: Your network name (SSID) and password
-
Hostname:
- Click Write and wait for the process to complete
- Insert the microSD card into the Raspberry Pi
- Connect the power supply
- Wait 1-2 minutes for the Pi to boot up
- Find the IP address of your Pi (e.g. via your router or with
ping opencloudtouch.local)
Open a terminal (Windows: PowerShell, Mac: Terminal) and connect:
ssh pi@opencloudtouch.local
# Or with IP address:
ssh pi@192.168.1.xxxOn the Raspberry Pi (via SSH):
# Install Docker (official script)
curl -fsSL https://get.docker.com | sh
# Add your user to the docker group
sudo usermod -aG docker $USER
# Log out and back in (for group membership to take effect)
exitLog back in:
ssh pi@opencloudtouch.local# Create directory
mkdir -p ~/opencloudtouch && cd ~/opencloudtouch
# Create docker-compose.yml
cat > docker-compose.yml << 'EOF'
version: '3.8'
services:
opencloudtouch:
image: ghcr.io/scheilch/opencloudtouch:latest
container_name: opencloudtouch
network_mode: host
volumes:
- oct-data:/data
environment:
- OCT_HOST=0.0.0.0
- OCT_PORT=7777
- OCT_LOG_LEVEL=INFO
- OCT_DISCOVERY_ENABLED=true
restart: unless-stopped
volumes:
oct-data:
driver: local
EOF
# Start the container
docker compose up -dOpen in your browser on your computer or smartphone:
http://opencloudtouch.local:7777
or with the IP address:
http://192.168.1.xxx:7777
🎉 Done! OpenCloudTouch is running. Continue with First Setup.
The container automatically restarts after a reboot thanks to restart: unless-stopped.
cd ~/opencloudtouch
docker compose pull
docker compose up -dOpenCloudTouch runs on any NAS that supports Docker.
- Open the Container Manager package (formerly: Docker)
- Go to Registry → search for
ghcr.io/scheilch/opencloudtouch - Download the image
ghcr.io/scheilch/opencloudtouch:latest - Create a new container:
-
Network:
host(important for device discovery!) -
Volume:
/data→ assign a local folder -
Environment Variables:
-
OCT_PORT=7777 -
OCT_DISCOVERY_ENABLED=true
-
-
Network:
- Start the container
- Open
http://<NAS-IP>:7777
docker run -d \
--name opencloudtouch \
--network host \
--restart unless-stopped \
-v oct-data:/data \
ghcr.io/scheilch/opencloudtouch:latest
⚠️ Important:--network hostis required for OpenCloudTouch to automatically discover SoundTouch devices (SSDP/UPnP multicast). Without it, only manual IP entry works.
For testing or when no dedicated server is available.
- Install Docker Desktop
- Open PowerShell and run:
docker run -d `
--name opencloudtouch `
-p 7777:7777 `
-v oct-data:/data `
-e OCT_DISCOVERY_ENABLED=true `
ghcr.io/scheilch/opencloudtouch:latest
⚠️ On Windows,--network hostcannot be used. Use-p 7777:7777and configure device IPs manually under Settings in the web UI.
- Open
http://localhost:7777
docker run -d \
--name opencloudtouch \
--network host \
--restart unless-stopped \
-v oct-data:/data \
ghcr.io/scheilch/opencloudtouch:latestOpen http://localhost:7777
👉 First Setup — Connect your SoundTouch devices with OpenCloudTouch
# Stop and remove container
docker compose down # or: docker rm -f opencloudtouch
# Delete data (optional)
docker volume rm oct-dataProblems with installation? See FAQ or Troubleshooting
🇩🇪 Benutzerhandbuch
🇬🇧 User Guide
Development
API & Architecture
- REST API
- ADR 001 Clean Architecture
- ADR 002 FastAPI App State
- ADR 003 SSDP Discovery
- ADR 004 React/TS/Vite
Technical Reference
Legal