sandervdh76/spotnas repository overview

⁠SpotNAS

An independent Spotnet reader for your NAS: it indexes Spotnet posts from your own Usenet provider into a local SQLite database and gives you a fast web interface to search, read details and comments, download NZBs or send them to SABnzbd.

The interface is available in English and Dutch.

⁠Features

• Search by title and poster, filter by category and genre, and see what arrived in the latest update.
• Spot details with images, comments, NZB file list, par2 recovery and missing segments.
• NZB download and one-click sending to SABnzbd.
• Personal lists per user: saved spots, download history, saved searches with new-result counters and a poster blacklist.
• Scheduled updates and a resumable historical import up to your provider's retention.
• Backups and restore from the web interface.
• Works behind a reverse proxy such as Nginx Proxy Manager.

⁠Quick start

SpotNAS needs two folders: one for the configuration and one for the database (preferably on your large volume).

services:
  spotnas:
    image: sandervdh76/spotnas:0.24.0
    restart: unless-stopped
    user: "1000:1000"
    ports:
      - "8390:8390"
    volumes:
      - /path/to/spotnas/data:/data
      - /path/to/spotnas/config:/config:ro
    read_only: true
    tmpfs:
      - /tmp:size=32m

Put a recovery token of at least 32 characters in /path/to/spotnas/config/config.toml:

[app]
database = "/data/spots.sqlite3"
api_token = "<random token, e.g. from: python3 -c 'import secrets; print(secrets.token_urlsafe(32))'>"

Start the container, open http://NAS-IP:8390/ and create the first administrator straight away. Then configure your Usenet provider in Settings → Provider and click Fetch new spots.

The container user (UID/GID 1000 by default) needs write access to the data folder and read access to config.toml.

⁠Tags and platforms

• Fixed versions such as 0.24.0, plus 0.23 and latest.
• linux/amd64 and linux/arm64.

Use a fixed version rather than latest, so an update with a database migration never installs unexpectedly. SpotNAS makes a backup before every migration.

⁠Reverse proxy

Behind a reverse proxy, set the environment variable SPOT_TRUSTED_PROXIES to the address the proxy connects from (shown in Settings → Maintenance → Connection). SpotNAS then uses the visitor's real address for sign-in limits and marks the session cookie Secure over HTTPS.

⁠Also available

The same image is published on GitHub Container Registry as ghcr.io/sanderhill/spotnas.