Metadata-Version: 2.5
Name: vpstream
Version: 0.8.0
Summary: On-demand video streaming from a VPS, controlled over SSH or a private dashboard
License-Expression: MIT
License-File: LICENSE
License-File: src/vpstream/assets/hls.js.LICENSE
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.12
Requires-Dist: flask>=3.0
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == 'dev'
Description-Content-Type: text/markdown

# vpstream

On-demand video streaming from a VPS. The public port opens only while a stream runs, and
everything is controlled over SSH or a private dashboard.

Status: early development. This release streams a file or a folder as it is, for players such
as VLC (direct mode). Playing in a TV browser comes next.

| Command | What it does |
| --- | --- |
| `vpstream doctor` | Checks this host for everything vpstream needs |
| `sudo vpstream init` / `uninstall` | Sets the service up on this host, and removes it again |
| `vpstream start --file F` or `--dir D` | Starts a stream of one video, or of the videos in a folder |
| `vpstream stop` / `status` | Stops the stream, or shows its addresses and what the daemon is doing |
| `vpstream devices` | Lists the devices that asked for the stream; `enable`, `disable`, `lock`, `unlock` |
| `vpstream alias NAME` | Changes the short name in the stream's address |
| `vpstream bench FILE` | Measures how fast this host copies, transcodes and burns in subtitles for a file |
| `vpstream caps` | Serves a test page that checks what a TV browser can play |
| `vpstream selftest` | Runs the tests shipped with the package (`--integration` uses the real ffmpeg) |
| `vpstream install ffmpeg` | Installs the newest stable ffmpeg build; `vpstream update ffmpeg` updates it |

## Requirements

- Linux, Python 3.12 or newer
- ffmpeg and ffprobe on `PATH` (not bundled), with libx264; libx265 and an AV1 encoder
  (libsvtav1 or libaom-av1) for the full `caps` test set. `vpstream install ffmpeg` installs a
  build with all of them.
- Optional: mkvtoolnix (`sudo apt install mkvtoolnix`), only for WebVTT subtitle tracks written
  by mkvmerge, which ffmpeg cannot read; vpstream says when a file needs it

## Install

```text
sudo PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install "vpstream[dev]"
vpstream --version
vpstream doctor
sudo vpstream init
```

The dev extra adds pytest for `vpstream selftest`. The install is for the whole system and
owned by root, because the service runs as its own user and its firewall helper runs as root;
a per-user `pipx install` cannot be used for the service. Upgrade with the same prefix:

```text
sudo PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx upgrade vpstream
sudo vpstream init               # restarts the service on the new version
```

## `sudo vpstream init` and `sudo vpstream uninstall`

`init` sets the service up and is safe to run again, for example after an upgrade:

- a service user and group, `vpstream`, with no login and no home
- `/etc/vpstream/config.toml` (kept if it exists), a state folder and a cache folder
- a sudoers rule that lets the service user run `vpstream-fw open` and `vpstream-fw close` as
  root and nothing else; it is checked with `visudo` before and after it is installed
- the dashboard, published on your tailnet with `tailscale serve`: HTTPS on the dashboard
  port of this host's tailnet name, proxied to `127.0.0.1`. No firewall rule is added for it
- the systemd service, enabled and started; it closes the stream port after a stop or a crash
- the user who ran `sudo` is added to the `vpstream` group, to use `vpstream status` without
  sudo (log out and in once)

`uninstall` removes what `init` created and nothing else: a user, a group membership or a
served port that was there before stays, and on a host that was never set up no ufw rule is
touched. The configuration and state are removed; prepared
videos are kept unless `--purge` is given. It asks first; `--yes` skips the question.

Neither command ever enables, disables, resets or reloads ufw, or touches any ufw rule other
than the stream port. Neither resets `tailscale serve`: only the dashboard port is added or
turned off, and a port that already serves something else is refused.

`init` needs Tailscale running, with HTTPS certificates enabled for the tailnet. It refuses a
dashboard port that another program on this host already listens on.

## `vpstream doctor`

Checks this host for everything vpstream needs and lists all of it in one report: the Python
version, ffmpeg, ffprobe, Caddy, ufw, Tailscale, systemd and sudo, whether ufw is enabled,
Tailscale is connected and the tailnet issues HTTPS certificates, the fonts burned-in subtitles fall back to, the configuration file,
and where vpstream itself is installed. Each problem comes with the command that fixes it.
The exit code is 1 when something required is missing. Nothing is changed and no root is
needed.

A per-user `pipx install` is reported as a problem, with the system-wide install command as
the fix (see Install); remove the per-user copy afterwards with `pipx uninstall vpstream`.

Settings are read from `/etc/vpstream/config.toml` when it exists: `port` under `[stream]`
(default 1337), `host` under `[stream]` (the address in the URLs shown; by default the one
this host uses to reach the internet) and `port` under `[dashboard]` (default 1338).

## `vpstream daemon` and `vpstream status`

One daemon does the work, and the command line and the dashboard both talk to it.
`vpstream daemon` runs it in the foreground; normally the service does that. It refuses to
start while another daemon is listening on the same socket.

- **Command line:** `vpstream status` asks the daemon over a unix socket,
  `/run/vpstream/daemon.sock`, which only the service user and its group can use.
  `--json` prints the raw answer.
- **Dashboard port:** bound to `127.0.0.1` only, never to every interface. `vpstream init`
  publishes it on your tailnet with `tailscale serve`, so the dashboard is
  `https://<this host's tailnet name>:1338/`, reachable only from your own devices.
  `vpstream status` shows that address, or says that the dashboard is not published.

## Streaming: `vpstream start`, `stop`, `devices` and `alias`

```text
vpstream start --file /srv/media/film.mkv             # http://<ip>:1337/abc
vpstream start --dir /srv/media/show --alias show     # http://<ip>:1337/show, /show/1, /show/2 ...
vpstream devices                                      # who asked for it
vpstream stop
```

One stream runs at a time, and only video files are streamed (by their extension). The
service has its own user, which must be able to read the videos and enter the folders above
them. A link is followed once, when the stream starts.

- **Addresses:** `/ALIAS` plays the video of a `--file` stream. For a `--dir` stream it is the
  episode list for a browser and an M3U playlist for a player, so VLC can open it directly;
  `/ALIAS/1`, `/ALIAS/2` and so on are the videos, in natural order of their file names
  (episode 2 before episode 10), and `/ALIAS/playlist.m3u` is always the playlist. Only the
  top level of the folder is read. Numbers stay as they are while the stream runs.
- **Alias:** three random letters, or `--alias NAME`. `vpstream alias NAME` changes it while
  the stream runs, and the old address stops working at once.
- **Time limit:** a stream stops by itself after `--ttl MINUTES` (default 180; 0 for none).
- **Who gets in** (`--policy`, changed live from the dashboard or with `vpstream devices`):

  | Policy | Who gets in |
  | --- | --- |
  | `open` (the default) | Everyone, except the devices you disable |
  | `approval` | Only the devices you approve. The others get a 403 and wait in the list, marked WL |
  | `locked` | Only the enabled devices. `devices lock` keeps the ones that get in at that moment; `devices unlock` goes back |

  A device is an IP address. `vpstream devices enable ADDRESS` and `disable ADDRESS` let one
  in or keep it out, under every policy. Decisions last until the stream stops.
- **How it is served:** Caddy listens on the stream port only while a stream runs, as a child
  of the daemon and as the same unprivileged user. It asks the daemon about every request, so
  a change applies on the next one, and then sends the file itself, with range requests.
  Requests for anything but the alias get a 404 and are not listed as devices.
- **Guessing the alias:** an address that asks for 20 things that are not there, without
  being a device that gets in, gets a 404 for everything until the stream stops.
  `vpstream devices` lists such addresses, and `devices enable ADDRESS` lets one back in.
- **Dashboard:** the same controls, on the tailnet address `vpstream status` shows.
- **Stop, crash and reboot:** `vpstream stop`, the time limit and stopping the service all
  close the port. After a crash the service starts again and takes the stream up where it
  was, with the devices you enabled or disabled. A stream is never carried over a reboot.
- **Plain HTTP:** the stream is not encrypted, and anyone who knows the address can fetch it
  under the `open` policy.

## The firewall helper, `vpstream-fw`

The stream port is open in ufw only while a stream runs. The daemon has no privileges, so a
small helper does it as root: `vpstream-fw open` and `vpstream-fw close`, nothing else.

- **One port:** the helper takes no port. It reads `port` under `[stream]` from the root-owned
  `/etc/vpstream/config.toml` and refuses a file that other users can write, so its caller
  cannot make it touch any other port.
- **What it opened, it closes:** `open` writes the port down in `/etc/vpstream/open-ports`
  before it opens it, and `close` closes every port written there as well as the configured
  one. A port therefore stays closable after the configuration was changed, or broken, while
  it was open.
- **Two ufw commands:** `ufw allow PORT/tcp` and `ufw delete allow PORT/tcp`. It never enables,
  disables, resets or reloads ufw and never touches another rule.
- **After a crash or reboot:** a ufw rule stays on disk, so when the daemon starts it closes
  the stream port unless it takes up a stream that was running when it crashed.
  `vpstream status` shows the port's state, and a warning when the helper could not be run.

## `vpstream install ffmpeg` and `vpstream update ffmpeg`

Distribution packages of ffmpeg are often several versions old. `vpstream install ffmpeg`
installs the newest stable build from [FFmpeg-Builds](https://github.com/FFmpeg-Builds/FFmpeg-Builds),
the Linux build that ffmpeg.org links to: the highest release branch (9.0 now, 10.0 once it
exists), never the development snapshot. `vpstream update ffmpeg` replaces it with a newer
build when there is one, including a new major version.

- **Where:** ffmpeg and ffprobe go to `/opt/vpstream-ffmpeg`, linked from `/usr/local/bin`,
  which comes before `/usr/bin` on `PATH`. System changes run through `sudo`.
- **Checked first:** the download is checked against its published SHA-256, and the new ffmpeg
  is run and must have libx264, libx265, an AV1 encoder and the zscale, tonemap, subtitles,
  overlay and scale2ref filters. If anything fails, nothing on the system is changed.
- **Libraries:** the builds need glibc 2.28 or newer (Ubuntu 20.04 and later) on x86-64 or
  ARM64. On apt systems, the packages they use are installed when missing: `libgcc-s1`,
  `fontconfig`, and the fonts burned-in subtitles fall back to (`fonts-dejavu-core`,
  `fonts-liberation`, and `fonts-noto-cjk` for Chinese, Japanese and Korean, about 90 MB).
  Running `vpstream install ffmpeg` again adds any that are missing.
- **An existing ffmpeg:** you are asked first, `This will uninstall the existing ffmpeg (...).
  Do you want to proceed? [y/N]`; the question lists every package apt would remove with it.
  An apt or snap ffmpeg is removed after the new one is in place. An ffmpeg from elsewhere is
  never removed: vpstream asks you to remove it yourself. `--yes` skips the question.
- **Uninstall:** `sudo rm -r /opt/vpstream-ffmpeg /usr/local/bin/ffmpeg /usr/local/bin/ffprobe`.

## `vpstream bench FILE`

Encodes a sample of the file (120 seconds from about 10% in, `--sample` to change) at low CPU
and I/O priority, and reports the speed of each step as a multiple of real time, with the
estimated time for the whole file:

- **copy:** the video copied into fMP4 HLS, audio converted to AAC
- **transcode:** H.264 at the source resolution, for each x264 preset in `--presets`
  (default `veryfast,medium`); HDR sources are tone mapped
- **burn-in:** the first image, ASS or SSA subtitle track (or `--sub N`) drawn into the video;
  for ASS tracks, font substitutions reported by libass are listed

`--json PATH` saves the results.

## `vpstream caps`

Generates short test clips (H.264, HEVC and AV1 in 8 and 10 bit, two audio tracks, WebVTT),
then serves a page on port 1337 (`--port`) that a TV browser opens at
`http://<server-ip>:1337/caps`. The page is driven with the arrow keys and OK. It tests MP4 and
HLS playback (hls.js and native), a subtitle overlay, audio track switching, download speed,
and records which remote keys reach the page. Results are sent back and saved to
`caps-results-*.json`. The server stops after 60 minutes (`--ttl`).

Clips are cached under `~/.cache/vpstream`. `--clips DIR` must be a new or empty folder, or one
that `vpstream caps` made before; any other folder is refused, never cleared. `--regen` makes
the clips again.

The port must be reachable: open it in your firewall for the test and close it afterwards.

## Development

```text
python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest                  # unit tests
.venv/bin/pytest --integration    # also the tests that run ffmpeg
git config core.hooksPath .githooks
```

Pull requests need a Conventional Commit title (`feat: ...`, `fix: ...`). Releases are made
from `main` by python-semantic-release.

hls.js (Apache-2.0) is bundled in `src/vpstream/assets`, with its version in `hls.js.version`.
`python scripts/update-hlsjs.py` updates it from npm (checked against npm's sha512 integrity;
`--version X` for a given release, `--check` to only compare). A weekly workflow runs the same
script and opens a pull request when a new release is out.

## License

MIT
