Files
vssm_full/README.md
2026-06-11 22:19:41 -05:00

32 lines
878 B
Markdown

# vssm_full
Build script that produces a single `vssm` binary with the web dashboard (`vssm_web`) embedded.
## Requirements
- Go
- Node.js + npm
- git
***A `flake.nix` is provided for Nix users, run `nix develop` for a shell with all dependencies available.***
## Usage
```sh
./build.sh
```
This clones `vssm` and `vssm_web` at the versions pinned in `versions.txt`, builds the frontend, embeds it into the Go binary, and outputs `./vssm`.
## Versions
Edit `versions.txt` to pin specific tagged releases of `vssm` and `vssm_web`.
## Configuration
See the [vssm README](https://git.bellsworne.tech/chrisbell/vssm) for configuration details, including the config file format, auth tokens, and instance setup.
## Running as a background service
*WIP* — instructions for setting up `vssm daemon` as a systemd service (or equivalent) will be added here in the future.