Update readme

This commit is contained in:
2026-06-05 20:11:06 -05:00
parent 8f3ef2a06d
commit 82029bf143

View File

@@ -24,26 +24,38 @@ Setup is easy from source, all you need is:
## Configuration ## Configuration
**For now, the configuration file is stored in `~/.config/vssm/config.json`, but this will be configurable later.** **For now, the configuration file is stored in `~/.config/vssm/config.json`, but this will be configurable later.**
## Web Interface
Alongside this project, I am developing a seperate web-based dashboard that can be used to manage you servers with a very simple UI. You can get it [here](https://git.bellsworne.tech/chrisbell/vssm_web).
## Roadmap ## Roadmap
- [-] Configuration - [ ] Configuration
- [x] Application data path - [ ] Custom configuration path (passed to the daemon with a flag `--config-path`)
- [x] Declarative Servers - [ ] Custom application data path (*for templates, etc, and to be used as a base for the other config directories*)
- [ ] Daemon listen port (kind of implemented, could be cleaner)
- [x] Declarative Server configuration (Create servers in config)
- [-] Server management - [ ] Server management
- [x] Create servers - [x] Create servers
- [x] Automatic server binary downloading by version (*Caveat: This works BUT the configuration template downloader needs to be figured out, otherwise you have to manually add a template for each version before it can actually be ran*)
- [ ] Delete servers
- [x] Start/Stop servers - [x] Start/Stop servers
- [ ] Server configuration
- [ ] Download correct configuration template for version
- [x] Version
- [x] Server Name
- [x] Port
- [x] Multiple servers support - [x] Multiple servers support
- [x] List servers and their status - [x] List servers and their status
- [ ] Delete servers - [x] Send commands to servers
- [ ] Automated server backups - [ ] Automated server backups
- [ ] Binary releases - [ ] Binary releases
- [-] Other - [ ] Automatically set up background service
- [-] First class NixOS support
- [ ] Other
- [ ] First class NixOS support
- [x] Patch downloaded server binaries for NixOS - [x] Patch downloaded server binaries for NixOS
- [ ] Official nix package or flake - [ ] Official nix package or flake
- [ ] All configuration options - [ ] All configuration options