Installation

Prerequisites

• Python 3.14 or newer
• A running NVIDIA OpenShell gateway (or use --local mode for local Docker-based gateways)

Install from PyPI

The fastest way to get started:

pip install shoreguard

Or, if you prefer uv:

uv pip install shoreguard

Install from source

git clone https://github.com/FloHofstetter/shoreguard.git
cd shoreguard
uv sync
uv run shoreguard

First run

On first launch ShoreGuard creates a SQLite database at:

~/.config/shoreguard/shoreguard.db

No manual migration step is needed — the schema is applied automatically.

Once the server is running, open your browser. The setup wizard appears on the first visit and walks you through creating an admin account.

Using PostgreSQL

For multi-instance deployments, ShoreGuard supports PostgreSQL. See Configuration — Database for setup.