Repository navigation
Getting Started
This page is the shortest supported path from a prepared Raspberry Pi or Debian machine to a secured OSPy installation. Use the complete installation guide for all package choices, remote-access modes, HTTPS, uninstallation and recovery details.
- Raspberry Pi OS or Debian 12
- Python 3.11 or newer
- SSH or local terminal access with
sudo - A supported Raspberry Pi output board or other configured station hardware
wget https://raw.githubusercontent.com/martinpihrt/OSPy/master/ospy_setup.sh
sudo bash ospy_setup.shThe interactive installer selects optional system components, the installation directory and one remote-access mode. The stable installation channel uses the tested master branch.
For a first setup, local-network access is the simplest choice. Managed Cloudflare Tunnel, temporary Cloudflare Quick Tunnel, Tailscale Serve, Tailscale Funnel and direct OSPy HTTPS are described with their security implications in Installation.
Security warning: Passwordless mode is only for a trusted, isolated LAN. Every device that can reach OSPy has administrator access until a password is configured. Never expose passwordless OSPy to the Internet or an untrusted network.
- Open the local or remote address printed by the installer.
- Sign in with the generated administrator password unless trusted-LAN passwordless mode was deliberately selected.
- Open Options and change or create the administrator password immediately.
- Configure the correct number of outputs, stations and master-station behavior for the connected hardware.
- Create an OSPy backup after the initial configuration.
Open Programs, add a program, choose its days or repetition rule, set a start time and assign station durations. The Programs page explains all supported schedule types, calendar filters, program groups, pauses, sunrise/sunset scheduling and one-time postponement.
Open Plugins → Manage → Install New Plugin and use the official repository. Review compatibility, dependencies, hardware resources and requested permissions before activation. The plug-in catalog lists every official plug-in with its current version and description.
Choose your language on the web-interface guide page. It covers Home, programs, run-once control, plug-ins, logs, options, users, security, stations, sensors, diagnostics, backup and recovery.
Do not delete ospy/data, because it contains configuration and history. Use the recovery procedure in Installation and collect relevant Diagnostics information before opening an Issue.
OSPy repository · Releases · Plug-ins · Issues · Discussions