You are here: Documentation » Self-hosting & download

Self-hosting & download

LoxWatch is open source (AGPL-3.0). You can download the source code and run it yourself on your own server or Proxmox LXC container.

Download

Get the source from the Git repository: git clone <repository URL>. You can find the URL on the home page in the “Open source & self-hosting” section.

Run locally

python3 -m venv venv && ./venv/bin/pip install -r requirements.txt
OPS_SECURE_COOKIES=0 ./venv/bin/python app.py

The application then runs at http://127.0.0.1:8090. Requires Python 3.

Running on Proxmox / LXC

  1. Run deploy/proxmox-create-lxc.sh on the Proxmox host (container ID, storage and bridge via variables).
  2. Copy the project into the container and run NPM_IP=<reverse proxy> bash deploy/install.sh there.
  3. Set up TLS in the upstream reverse proxy (e.g. Nginx Proxy Manager) and point it at the container.

Configuration

Via environment variables: OPS_PORT, OPS_BIND, OPS_COOKIE_SECRET, OPS_SECURE_COOKIES, OPS_DATA_DIR, OPS_PUBLIC_URL, OPS_GIT_URL and optionally OPS_SMTP_HOST and OPS_MAIL_TO for e-mail notifications.

License: The code is licensed under AGPL-3.0. The logo and the name “LoxWatch” are protected by copyright and not licensed – please use your own branding when self-hosting. Imprint and privacy pages are placeholders and must be adapted.
↑