Skip to content

INSTALL.md

Latest commit

 

History

History
64 lines (43 loc) · 2.86 KB

INSTALL.md

File metadata and controls

64 lines (43 loc) · 2.86 KB
Raw

Installation Guide

👉 See the full installation guide in the wiki.

Covers Docker Run, Docker Compose, Portainer, Synology NAS, Unraid, updating, and troubleshooting.

Windows chooser

If you want to... Start here
Quickly try DOCSight on a Windows PC without Docker Desktop Preview for Windows
Monitor your connection continuously on Windows Windows Docker Desktop quick start

On Windows 10/11, the normal 24/7 monitoring path is Docker Desktop. Start with the Windows quick start when you want the supported Docker path. The Desktop Preview is a portable tryout build and is not intended for always-on collection.

If setup or collection does not behave as expected, run the passive local doctor inside the same container before collecting manual environment details:

docker exec docsight python -m app.doctor
docker exec docsight python -m app.doctor --json > docsight-doctor.json

The default doctor checks local runtime, config, storage, database, secret-file presence, and optional integration configuration without contacting third-party services.

Optional alert fan-out through an Apprise sidecar is covered in docs/notifications-apprise.md. Optional browser/app push alerts are covered in docs/notifications-pwa-web-push.md.

Quick Start

docker run -d \
  --name docsight \
  --restart unless-stopped \
  -p 8765:8765 \
  -v docsight_data:/data \
  ghcr.io/itsdnns/docsight:latest

Open http://localhost:8765 and follow the setup wizard.

Bare-Metal / systemd

If you run DOCSight outside of Docker (e.g. as a systemd service), you need to compile and install the native helpers manually. These are tiny C programs that need setuid root because ICMP raw sockets require elevated privileges.

# Install build dependencies (Debian/Ubuntu)
sudo apt install gcc libffi-dev libjpeg62-turbo-dev zlib1g-dev

# Install Python dependencies
pip install -r requirements.txt

# Compile and install the ICMP helpers
sudo gcc -O2 -Wall -o /usr/local/bin/docsight-icmp-helper tools/icmp_probe_helper.c
sudo gcc -O2 -Wall -o /usr/local/bin/docsight-traceroute-helper tools/traceroute_helper.c

# Set ownership and setuid bit
sudo chown root:root /usr/local/bin/docsight-icmp-helper /usr/local/bin/docsight-traceroute-helper
sudo chmod 4755 /usr/local/bin/docsight-icmp-helper /usr/local/bin/docsight-traceroute-helper

Without these binaries, traceroute and ICMP probes will log errors but the rest of DOCSight works fine.

Reverse Proxy

Exposing DOCSight beyond your local network? See the reverse proxy guide for Caddy, Nginx, and Traefik examples with TLS.