Compare commits

19 Commits

Author SHA1 Message Date
dcee28d00f added change to allow embedding the web portal 2026-06-11 21:45:26 -05:00
d610a84718 Auth token functionality 2026-06-11 20:16:33 -05:00
806ca3d2e7 Update readme 2026-06-11 19:22:48 -05:00
4b5e957eaa Added set/get instance config endpoints; fixed declarative config bug 2026-06-11 19:19:47 -05:00
61934bb2f4 Cleanup before merging to main 2026-06-10 10:55:59 -05:00
c52e505c18 Update README.md 2026-06-10 01:03:21 -04:00
2497b37d21 Update the README 2026-06-10 00:01:18 -05:00
318d473fec Added a modify endpoint to change name and port 2026-06-09 23:32:31 -05:00
0a5cfe83fc Forced 'list' to return instance list sorted alphebetically 2026-06-09 18:46:54 -05:00
96cc41ee43 Merge branch 'config_rework' into dev 2026-06-06 23:43:30 -05:00
988bdfcf6c Fixed IPC calls in main to use new ip and port seperation in the config 2026-06-06 23:42:54 -05:00
c3e17f9a80 Can now change all configuration options per instance 2026-06-06 18:09:07 -05:00
336973443d Daemon remembers the config path if started with --config flag 2026-06-06 17:03:54 -05:00
0e4d96b1be Added delete functionality 2026-06-06 16:39:48 -05:00
3a01e835a1 Cleanup; Adding locks where needed, and checking port availibility 2026-06-06 15:48:43 -05:00
9f4e27869b Made the create command require a port number 2026-06-05 23:38:42 -05:00
53b9f30d50 Fixed bugs with --config flag 2026-06-05 21:48:25 -05:00
17117e2376 Can now set custom config path flag when starting daemon 2026-06-05 20:58:50 -05:00
82029bf143 Update readme 2026-06-05 20:11:06 -05:00
10 changed files with 796 additions and 116 deletions

2
.gitignore vendored
View File

@@ -2,3 +2,5 @@
.direnv
.cache
.vscode
vssm
test/

View File

@@ -22,28 +22,104 @@ Setup is easy from source, all you need is:
- Run `./vssm` with no arguments to show usage
## Configuration
**For now, the configuration file is stored in `~/.config/vssm/config.json`, but this will be configurable later.**
The default configuration file is stored in `~/.local/share/vssm/config.json`, however you can pass the `--config <path>` flag to any command to use a custom configuration. You can also set the `VSSM_CONFIG_PATH` environment variable in lieu of using the config flag for every command.
The default configuration:
```json
{
"storage": {
"app_data_dir": "",
"install_dir": "/home/user/.local/share/vssm/vssm_data/installs",
"instances_dir": "/home/user/.local/share/vssm/vssm_data/instances",
"backup_dir": "/home/user/.local/share/vssm/vssm_data/backups",
"config_templates_dir": "/home/user/.local/share/vssm/vssm_data/config_templates"
},
"daemon": {
"listen_address": "127.0.0.1",
"port": 65000
},
"instances": {
"test_server": {
"Version": "1.22.3",
"ServerName": "test_server",
"Port": 12345,
"config": null
}
}
```
- Storage
- install_dir - The directory where versioned server binaries are stored
- instances_dir - Directory for instances and their data
- backup_dir - Directory for automatic backups of instances
- config_templates_dir - Directory for versioned server configuration templates
- Daemon
- port - The port the daemon listens on for http requests
- listen_address - The IP address the daemon listens on
- Instances
- Version - The game version
- ServerName - The name of the instance
- Port - The port the instance is listening on
- config - This allows you to set ANY configuration item from the config, example below:
Example instance with extra configuration:
**NOTE:** Most settings that are filepaths should be left alone in the instance config settings, as they will be overwritten automatically (like the ModPaths setting).
**NOTE:** Roles settings must be modified in the actual instance config
```json
"test_server": {
"Version": "1.22.3",
"ServerName": "test_server",
"Port": 12345,
"config": {
"AllowPvP": true,
"WhiteListMode": 1,
"WelcomeMessage": "Welcome to the server, {0}!",
"WorldConfig": {
"Seed": "superawesomeseed",
"WorldName": "A new world",
"PlayStyle": "surviveandbuild"
}
}
}
```
## 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
- [-] Configuration
- [x] Application data path
- [x] Declarative Servers
- [x] Configuration
- [x] Custom configuration path (passed to the daemon with a flag `--config`)
- [x] Daemon instance remembers config path (*so you don't have to pass `--config` everytime you run an ipc command*)
- [x] Daemon listen port
- [x] Declarative Server configuration (Create servers in config)
- [x] All configuration options
- [x] Endpoint for modifying instance configuration (for web ui)
- [-] Server management
- [ ] Server management
- [x] Create servers
- [x] Automatic server binary downloading by version
- [x] Delete servers
- [x] Start/Stop servers
- [x] Server configuration
- [x] Download correct configuration template for version (see availible templates [here](https://git.bellsworne.tech/chrisbell/vssm_config_templates))
- [x] Version
- [x] Server Name
- [x] Port
- [x] Full declarative configuration support in main app config
- [x] Multiple servers support
- [x] List servers and their status
- [ ] Delete servers
- [x] Send commands to servers
- [ ] Automated server backups
- [ ] Binary releases
- [-] Other
- [-] First class NixOS support
- [ ] Automatically set up background service
- [ ] Other
- [ ] First class NixOS support
- [x] Patch downloaded server binaries for NixOS
- [ ] Official nix package or flake
- [ ] All configuration options

View File

@@ -9,6 +9,7 @@ import (
type AppConfig struct {
Storage struct {
AppDataDir string `json:"app_data_dir"`
InstallDir string `json:"install_dir"`
InstancesDir string `json:"instances_dir"`
BackupDir string `json:"backup_dir"`
@@ -16,16 +17,16 @@ type AppConfig struct {
} `json:"storage"`
Daemon struct {
// UseNixOs bool `json:"use_nixos"`
ListenAddress string `json:"listen_address"`
}
Port int `json:"port"`
AuthToken string `json:"auth_token"`
} `json:"daemon"`
Instances map[string]VsServerConfigOptions `json:"instances"`
Instances map[string]InstanceMetadata `json:"instances"`
}
func DefaultConfig() *AppConfig {
home, _ := os.UserHomeDir()
basePath := filepath.Join(home, ".local", "share", "vssm")
func CreateConfigWithDefaults(configPath string) *AppConfig {
basePath := filepath.Join(filepath.Dir(configPath), "vssm_data")
cfg := &AppConfig{}
cfg.Storage.InstallDir = filepath.Join(basePath, "installs")
@@ -33,16 +34,17 @@ func DefaultConfig() *AppConfig {
cfg.Storage.BackupDir = filepath.Join(basePath, "backups")
cfg.Storage.ConfigTemplatesDir = filepath.Join(basePath, "config_templates")
cfg.Daemon.ListenAddress = "127.0.0.1:12345"
cfg.Daemon.ListenAddress = "127.0.0.1"
cfg.Daemon.Port = 65000
cfg.Instances = make(map[string]VsServerConfigOptions)
cfg.Instances = make(map[string]InstanceMetadata)
return cfg
}
func LoadOrCreateConfig(configPath string) (*AppConfig, error) {
if _, err := os.Stat(configPath); os.IsNotExist(err) {
cfg := DefaultConfig()
cfg := CreateConfigWithDefaults(configPath)
if err := os.MkdirAll(filepath.Dir(configPath), 0755); err != nil {
return nil, fmt.Errorf("Failed to create config directory: %w", err)

410
daemon.go
View File

@@ -1,17 +1,26 @@
package main
import (
"embed"
"encoding/json"
"fmt"
"io"
"io/fs"
"net/http"
"os"
"os/signal"
"path/filepath"
"slices"
"strconv"
"strings"
"sync"
"syscall"
"time"
)
//go:embed web/dist
var webFS embed.FS
type CommandPayload struct {
Command string `json:"command"`
}
@@ -24,13 +33,16 @@ type InstanceStatusResponse struct {
}
type DaemonServer struct {
sync.RWMutex
cfg *AppConfig
configPath string
procManager *ProcessManager
}
func StartDaemon(cfg *AppConfig) error {
func StartDaemon(cfg *AppConfig, configPath string) error {
ds := &DaemonServer{
cfg: cfg,
configPath: configPath,
procManager: NewProcessManager(),
}
@@ -40,22 +52,58 @@ func StartDaemon(cfg *AppConfig) error {
mux.HandleFunc("/instances/stop", ds.handleStop)
mux.HandleFunc("/instances/command", ds.handleCommand)
mux.HandleFunc("/instances/list", ds.handleList)
mux.HandleFunc("/instances/logs", ds.handleGetLogs)
mux.HandleFunc("/instances/delete", ds.handleDelete)
mux.HandleFunc("/instances/modify", ds.handleModify)
mux.HandleFunc("/instances/getConfig", ds.handleGetConfig)
mux.HandleFunc("/instances/setConfig", ds.handleSetConfig)
webContent, err := fs.Sub(webFS, "web/dist")
if err != nil {
return fmt.Errorf("failed to load embedded web assets: %w", err)
}
mux.Handle("/", http.FileServer(http.FS(webContent)))
corsWrappedHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Access-Control-Allow-Origin", "*")
w.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS")
w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization")
if r.Method == http.MethodOptions {
w.WriteHeader(http.StatusOK)
return
}
authCheck := func() bool {
if !strings.HasPrefix(r.URL.Path, "/instances/") {
return true
}
ds.RLock()
defer ds.RUnlock()
if ds.cfg.Daemon.AuthToken != "" {
authHeader := r.Header.Get("Authorization")
expected := "Bearer " + ds.cfg.Daemon.AuthToken
if authHeader != expected {
http.Error(w, "Unauthorized", http.StatusUnauthorized)
return false
}
}
return true
}()
if !authCheck {
return
}
mux.ServeHTTP(w, r)
})
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
server := &http.Server{
Addr: cfg.Daemon.ListenAddress,
Addr: listenAddress,
Handler: corsWrappedHandler,
}
@@ -63,7 +111,7 @@ func StartDaemon(cfg *AppConfig) error {
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
go func() {
fmt.Printf("Engine daemon actively listening on http://%s\n", cfg.Daemon.ListenAddress)
fmt.Printf("Engine daemon actively listening on http://%s\n", listenAddress)
if err := server.ListenAndServe(); err != http.ErrServerClosed {
fmt.Printf("Daemon runtime failure: %v\n", err)
}
@@ -79,6 +127,19 @@ func StartDaemon(cfg *AppConfig) error {
return nil
}
func (ds *DaemonServer) reloadConfig() error {
cfg, err := LoadOrCreateConfig(ds.configPath)
if err != nil {
fmt.Printf("Could not reload configuration file: %v\n", err)
return err
}
ds.Lock()
defer ds.Unlock()
ds.cfg = cfg
return nil
}
func (ds *DaemonServer) shutdownAllRunningServers() {
ds.procManager.Lock()
@@ -142,47 +203,75 @@ func (ds *DaemonServer) handleCreate(w http.ResponseWriter, r *http.Request) {
name := r.URL.Query().Get("name")
version := r.URL.Query().Get("version")
if name == "" || version == "" {
http.Error(w, "Missing name or version parameters", http.StatusBadRequest)
port := r.URL.Query().Get("port")
if name == "" || version == "" || port == "" {
http.Error(w, "Missing name, version, or port parameters", http.StatusBadRequest)
return
}
converted_port, err := strconv.Atoi(port)
if err != nil {
http.Error(w, "Could not convert provided port to a valid port number", http.StatusBadRequest)
return
}
if ds.reloadConfig() != nil {
http.Error(w, "Could not reload config", http.StatusInternalServerError)
return
}
ds.Lock()
defer ds.Unlock()
if _, exists := ds.cfg.Instances[name]; exists {
http.Error(w, fmt.Sprintf("Instance '%s' already exists in configuration", name), http.StatusConflict)
return
}
options := VsServerConfigOptions{
Version: version,
ServerName: name,
Port: 42424,
MaxClients: 10,
for name, options := range ds.cfg.Instances {
if options.Port == converted_port {
http.Error(w, fmt.Sprintf("Port already occupied by instance '%s'", name), http.StatusConflict)
return
}
}
err := DownloadAndExtractServer(version, ds.cfg.Storage.InstallDir)
metadata := InstanceMetadata{
Version: version,
ServerName: name,
Port: converted_port,
}
err = DownloadAndExtractServer(version, ds.cfg.Storage.InstallDir)
if err != nil {
http.Error(w, fmt.Sprintf("Installation failed: %v", err), http.StatusInternalServerError)
return
}
err = CreateNewInstance(name, version, options, ds.cfg)
err = CreateNewInstance(name, version, metadata, ds.cfg)
if err != nil {
http.Error(w, fmt.Sprintf("Instance provisioning failed: %v", err), http.StatusInternalServerError)
return
}
ds.cfg.Instances[name] = options
ds.cfg.Instances[name] = metadata
home, _ := os.UserHomeDir()
configPath := filepath.Join(home, ".config", "vs-manager", "config.json")
data, _ := json.MarshalIndent(ds.cfg, "", " ")
_ = os.WriteFile(configPath, data, 0644)
data, err := json.MarshalIndent(ds.cfg, "", " ")
if err != nil {
http.Error(w, fmt.Sprintf("Failed processing profile adjustments: %v", err), http.StatusInternalServerError)
return
}
if err := os.WriteFile(ds.configPath, data, 0644); err != nil {
http.Error(w, fmt.Sprintf("Failed saving configuration adjustments to disk: %v", err), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusCreated)
fmt.Fprintf(w, "Successfully created and stored profile for instance %s", name)
}
func (ds *DaemonServer) handleStart(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
@@ -194,6 +283,14 @@ func (ds *DaemonServer) handleStart(w http.ResponseWriter, r *http.Request) {
return
}
if ds.reloadConfig() != nil {
http.Error(w, "Could not reload config", http.StatusInternalServerError)
return
}
ds.RLock()
defer ds.RUnlock()
options, exists := ds.cfg.Instances[name]
if !exists {
http.Error(w, fmt.Sprintf("Instance '%s' does not exist. Run 'create' first", name), http.StatusNotFound)
@@ -273,6 +370,14 @@ func (ds *DaemonServer) handleList(w http.ResponseWriter, r *http.Request) {
return
}
if ds.reloadConfig() != nil {
http.Error(w, "Could not reload config", http.StatusInternalServerError)
return
}
ds.RLock()
defer ds.RUnlock()
ds.procManager.RLock()
defer ds.procManager.RUnlock()
@@ -292,7 +397,276 @@ func (ds *DaemonServer) handleList(w http.ResponseWriter, r *http.Request) {
})
}
slices.SortFunc(responseList, func(a, b InstanceStatusResponse) int {
if a.Name < b.Name {
return -1
}
if a.Name > b.Name {
return 1
}
return 0
})
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
json.NewEncoder(w).Encode(responseList)
}
func (ds *DaemonServer) handleGetLogs(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
}
name := r.URL.Query().Get("name")
if name == "" {
http.Error(w, "Missing name parameter", http.StatusBadRequest)
return
}
ds.procManager.RLock()
buf, exists := ds.procManager.LogBuffers[name]
ds.procManager.RUnlock()
if !exists || buf == nil {
w.Header().Set("Content-Type", "application/json")
w.Write([]byte("[]"))
return
}
logLines := buf.GetSnapshot()
w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(logLines); err != nil {
http.Error(w, fmt.Sprintf("Failed encoding log matrix: %v", err), http.StatusInternalServerError)
}
}
func (ds *DaemonServer) handleDelete(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
}
name := r.URL.Query().Get("name")
if name == "" {
http.Error(w, "Missing name parameter", http.StatusBadRequest)
return
}
purge := false
purgeParam := r.URL.Query().Get("purge")
if purgeParam != "" {
result, err := strconv.ParseBool(purgeParam)
if err != nil {
http.Error(w, "Invalid value for 'purge' parameter", http.StatusBadRequest)
return
}
purge = result
}
if ds.reloadConfig() != nil {
http.Error(w, "Could not reload config", http.StatusInternalServerError)
return
}
ds.Lock()
defer ds.Unlock()
ds.procManager.RLock()
defer ds.procManager.RUnlock()
_, exists := ds.cfg.Instances[name]
if !exists {
http.Error(w, fmt.Sprintf("Cannot delete instance '%s'; Does not exist.", name), http.StatusBadRequest)
return
}
if _, running := ds.procManager.ActiveInstances[name]; running {
http.Error(w, fmt.Sprintf("Cannot delete instance '%s'; It is currently running.", name), http.StatusBadRequest)
return
}
delete(ds.cfg.Instances, name)
data, err := json.MarshalIndent(ds.cfg, "", " ")
if err != nil {
http.Error(w, fmt.Sprintf("Failed processing profile adjustments: %v", err), http.StatusInternalServerError)
return
}
if err := os.WriteFile(ds.configPath, data, 0644); err != nil {
http.Error(w, fmt.Sprintf("Failed saving configuration adjustments to disk: %v", err), http.StatusInternalServerError)
return
}
if purge {
path := filepath.Join(ds.cfg.Storage.InstancesDir, name)
err := os.RemoveAll(path)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to delete instance from disk: %v", err), http.StatusInternalServerError)
return
}
}
w.WriteHeader(http.StatusOK)
fmt.Fprintf(w, "Successfully deleted instance %s", name)
}
func (ds *DaemonServer) handleModify(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
}
name := r.URL.Query().Get("name")
if name == "" {
http.Error(w, "Missing name parameter", http.StatusBadRequest)
return
}
newName := r.URL.Query().Get("newName")
if newName == "" {
http.Error(w, "Missing newName parameter", http.StatusBadRequest)
return
}
newPort := r.URL.Query().Get("newPort")
if newPort == "" {
http.Error(w, "Missing newPort parameter", http.StatusBadRequest)
return
}
convertedPort, err := strconv.Atoi(newPort)
if err != nil {
http.Error(w, "Could not convert provided port to a valid port number", http.StatusBadRequest)
return
}
ds.Lock()
defer ds.Unlock()
ds.procManager.RLock()
defer ds.procManager.RUnlock()
instance, exists := ds.cfg.Instances[name]
if !exists {
http.Error(w, fmt.Sprintf("Cannot modify instance '%s'; Does not exist.", name), http.StatusBadRequest)
return
}
if _, running := ds.procManager.ActiveInstances[name]; running {
http.Error(w, fmt.Sprintf("Cannot modify instance '%s'; It is currently running.", name), http.StatusBadRequest)
return
}
instance.ServerName = newName
instance.Port = convertedPort
ds.cfg.Instances[name] = instance
data, err := json.MarshalIndent(ds.cfg, "", " ")
if err != nil {
http.Error(w, fmt.Sprintf("Failed processing profile adjustments: %v", err), http.StatusInternalServerError)
return
}
if err := os.WriteFile(ds.configPath, data, 0644); err != nil {
http.Error(w, fmt.Sprintf("Failed saving configuration adjustments to disk: %v", err), http.StatusInternalServerError)
return
}
instanceConfigPath := filepath.Join(ds.cfg.Storage.InstancesDir, name, "serverconfig.json")
err = SyncInstanceConfig(instance.Version, instanceConfigPath, instance, ds.cfg)
if err != nil {
http.Error(w, "Failed to sync config: "+err.Error(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
fmt.Fprintf(w, "Successfully modified instance %s", name)
}
func (ds *DaemonServer) handleGetConfig(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
}
name := r.URL.Query().Get("name")
if name == "" {
http.Error(w, "Missing name parameter", http.StatusBadRequest)
return
}
exists := func() bool {
ds.RLock()
defer ds.RUnlock()
_, ok := ds.cfg.Instances[name]
return ok
}()
if !exists {
http.Error(w, fmt.Sprintf("Cannot modify instance config for: '%s'; Does not exist.", name), http.StatusBadRequest)
return
}
confPath := filepath.Join(ds.cfg.Storage.InstancesDir, name, "serverconfig.json")
data, err := os.ReadFile(confPath)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to get instance config: %v", err), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
w.Write(data)
}
func (ds *DaemonServer) handleSetConfig(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
return
}
name := r.URL.Query().Get("name")
if name == "" {
http.Error(w, "Missing name parameter", http.StatusBadRequest)
return
}
exists := func() bool {
ds.RLock()
defer ds.RUnlock()
_, ok := ds.cfg.Instances[name]
return ok
}()
if !exists {
http.Error(w, fmt.Sprintf("Cannot modify instance config for: '%s'; Does not exist.", name), http.StatusBadRequest)
return
}
running := func() bool {
ds.procManager.RLock()
defer ds.procManager.RUnlock()
_, ok := ds.procManager.ActiveInstances[name]
return ok
}()
if running {
http.Error(w, fmt.Sprintf("Cannot modify instance config for: '%s'; It is currently running.", name), http.StatusBadRequest)
return
}
data, err := io.ReadAll(r.Body)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to set instance config: %v", err), http.StatusInternalServerError)
return
}
confPath := filepath.Join(ds.cfg.Storage.InstancesDir, name, "serverconfig.json")
if err = os.WriteFile(confPath, data, 0644); err != nil {
http.Error(w, fmt.Sprintf("Failed to get instance config: %v", err), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
}

View File

@@ -98,14 +98,12 @@ func patchBinaryForNixos(binaryPath string) error {
return nil
}
fmt.Println("[NixOS Detected] Patching server interpreter pathway...")
fmt.Println("[NixOS Detected] Patching server binary...")
dotnetRoot := os.Getenv("DOTNET_ROOT")
var interpreter string
if dotnetRoot != "" {
// Use the glibc version that matches the active .NET runtime exactly
// Finds the underlying ld-linux-x86-64.so.2 link within the .NET store closure
out, err := exec.Command("patchelf", "--print-interpreter", filepath.Join(dotnetRoot, "dotnet")).Output()
if err == nil && len(out) > 0 {
interpreter = strings.TrimSpace(string(out))

View File

@@ -3,7 +3,6 @@ package main
import (
"fmt"
"os"
"os/exec"
"path/filepath"
)
@@ -14,17 +13,7 @@ const (
StateRunning InstanceState = "RUNNING"
)
type ManagedInstance struct {
Name string `json:"name"`
Version string `json:"version"`
Port int `json:"port"`
Status InstanceState `json:"status"`
Cmd *exec.Cmd `json:"-"`
Stdin interface{} `json:"-"`
}
func CreateNewInstance(name string, version string, options VsServerConfigOptions, cfg *AppConfig) error {
func CreateNewInstance(name string, version string, meta InstanceMetadata, cfg *AppConfig) error {
instanceDir := filepath.Join(cfg.Storage.InstancesDir, name)
dirs := []string{
@@ -40,8 +29,8 @@ func CreateNewInstance(name string, version string, options VsServerConfigOption
}
instanceConfigPath := filepath.Join(instanceDir, "serverconfig.json")
if err := PrepareInstanceConfig(version, instanceConfigPath, options, cfg); err != nil {
return fmt.Errorf("Failed provisioning server baseline configuration: %w", err)
if err := PrepareInstanceConfig(version, instanceConfigPath, meta, cfg); err != nil {
return fmt.Errorf("Failed to create baseline configuration: %w", err)
}
fmt.Printf("Instance '%s' (v%s) successfully initialized\n", name, version)

View File

@@ -4,30 +4,30 @@ import (
"encoding/json"
"fmt"
"io"
"net/http"
"os"
"path/filepath"
"strings"
)
type VsServerConfigOptions struct {
type InstanceMetadata struct {
Version string `json:"Version"`
ServerName string `json:"ServerName"`
Port int `json:"Port"`
IpAddress string `json:"IpAddress"`
MaxClients int `json:"MaxClients"`
Password string `json:"Password"`
DefaultRole string `json:"DefaultRole"`
GuestRole string `json:"GuestRole"`
PreApprovedRole string `json:"PreApprovedRole"`
Config map[string]interface{} `json:"config"`
}
func PrepareInstanceConfig(templateVersion string, instanceConfigPath string, options VsServerConfigOptions, cfg *AppConfig) error {
return SyncInstanceConfig(templateVersion, instanceConfigPath, options, cfg)
func PrepareInstanceConfig(templateVersion string, instanceConfigPath string, meta InstanceMetadata, cfg *AppConfig) error {
return SyncInstanceConfig(templateVersion, instanceConfigPath, meta, cfg)
}
func SyncInstanceConfig(templateVersion string, instanceConfigPath string, options VsServerConfigOptions, cfg *AppConfig) error {
func SyncInstanceConfig(templateVersion string, instanceConfigPath string, meta InstanceMetadata, cfg *AppConfig) error {
templatePath := filepath.Join(cfg.Storage.ConfigTemplatesDir, templateVersion, "serverconfig.json")
if err := ensureTemplateExists(templateVersion, templatePath, cfg); err != nil {
return fmt.Errorf("failed ensuring configuration template availability: %w", err)
}
if _, err := os.Stat(instanceConfigPath); os.IsNotExist(err) {
if err := os.MkdirAll(filepath.Dir(instanceConfigPath), 0755); err != nil {
return fmt.Errorf("failed creating instance directory tree: %w", err)
@@ -61,15 +61,20 @@ func SyncInstanceConfig(templateVersion string, instanceConfigPath string, optio
return fmt.Errorf("failed parsing configuration JSON payload: %w", err)
}
rawConfig["ServerName"] = options.ServerName
rawConfig["Port"] = options.Port
rawConfig["MaxClients"] = options.MaxClients
if options.Password != "" {
rawConfig["Password"] = options.Password
} else {
rawConfig["Password"] = nil
for key, value := range meta.Config {
if sub, ok := value.(map[string]interface{}); ok {
if existing, ok := rawConfig[key].(map[string]interface{}); ok {
for k, v := range sub {
existing[k] = v
}
}
} else {
rawConfig[key] = value
}
}
rawConfig["ServerName"] = meta.ServerName
rawConfig["Port"] = meta.Port
instanceDir := filepath.Dir(instanceConfigPath)
if worldConfig, ok := rawConfig["WorldConfig"].(map[string]interface{}); ok {
@@ -91,3 +96,43 @@ func SyncInstanceConfig(templateVersion string, instanceConfigPath string, optio
return os.WriteFile(instanceConfigPath, updatedData, 0644)
}
func ensureTemplateExists(version string, targetPath string, cfg *AppConfig) error {
if _, err := os.Stat(targetPath); err == nil {
return nil
}
fmt.Printf("Template for version %s not found locally. Fetching remote layout from git server...\n", version)
if err := os.MkdirAll(filepath.Dir(targetPath), 0755); err != nil {
return fmt.Errorf("failed to create local template cache directory: %w", err)
}
remoteURL := fmt.Sprintf("https://git.bellsworne.tech/chrisbell/vssm_config_templates/raw/branch/main/%s/serverconfig.json", version)
resp, err := http.Get(remoteURL)
if err != nil {
return fmt.Errorf("network error attempting to pull config template: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode == http.StatusNotFound {
return fmt.Errorf("version template '%s' does not exist in the remote git repository asset tree", version)
} else if resp.StatusCode != http.StatusOK {
return fmt.Errorf("remote git mirror returned unexpected HTTP status: %s", resp.Status)
}
out, err := os.Create(targetPath)
if err != nil {
return fmt.Errorf("failed creating cache file hook on system storage: %w", err)
}
defer out.Close()
_, err = io.Copy(out, resp.Body)
if err != nil {
return fmt.Errorf("failed stream-writing network payload cache frame to disk: %w", err)
}
fmt.Printf("Successfully cached configuration layout template for version %s\n", version)
return nil
}

225
main.go
View File

@@ -2,7 +2,10 @@ package main
import (
"bytes"
"crypto/rand"
"encoding/hex"
"encoding/json"
"flag"
"fmt"
"io"
"log"
@@ -10,7 +13,9 @@ import (
"net/url"
"os"
"path/filepath"
"strconv"
"text/tabwriter"
"time"
)
func main() {
@@ -19,54 +24,121 @@ func main() {
log.Fatalf("Could not locate user home dir: %v", err)
}
configPath := filepath.Join(home, ".config", "vssm", "config.json")
cfg, err := LoadOrCreateConfig(configPath)
if err != nil {
log.Fatalf("Initialization failed: %v", err)
}
defaultConfigPath := filepath.Join(home, ".local", "share", "vssm", "config.json")
if len(os.Args) < 2 {
configFlag := flag.String("config", defaultConfigPath, "Explicit path targeting a custom vssm config.json profile")
flag.Usage = printUsage
flag.Parse()
args := flag.Args()
if len(args) < 1 {
printUsage()
return
}
subCommand := os.Args[1]
configExplicitlySet := false
flag.Visit(func(f *flag.Flag) {
if f.Name == "config" {
configExplicitlySet = true
}
})
if !configExplicitlySet {
if envConfig := os.Getenv("VSSM_CONFIG_PATH"); envConfig != "" {
configFlag = &envConfig
}
}
absConfigPath, err := filepath.Abs(*configFlag)
if err != nil {
log.Fatalf("Failed to resolve absolute configuration path target: %v", err)
}
if configExplicitlySet {
if err := os.Setenv("VSSM_CONFIG_PATH", absConfigPath); err != nil {
log.Fatalf("Warning: could not set VSSM_CONFIG_PATH: %v", err)
}
}
cfg, err := LoadOrCreateConfig(absConfigPath)
if err != nil {
log.Fatalf("Initialization failed: %v", err)
}
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
fmt.Printf("Got listen address from config: %s\n", listenAddress)
subCommand := args[0]
switch subCommand {
case "daemon":
fmt.Println("Initializing VS server manager background supervisor...")
if err := StartDaemon(cfg); err != nil {
if isDaemonRunning(cfg) {
log.Fatalf("Cannot start daemon as it is already running. Stop it first (`pkill vssm`).")
}
fmt.Printf("Initializing VSSM Daemon [Config: %s]...\n", absConfigPath)
if err := StartDaemon(cfg, absConfigPath); err != nil {
log.Fatalf("Daemon runtime fatal error: %v", err)
}
case "create":
if len(os.Args) < 4 {
log.Fatalf("Usage: go run . create <instance_name> <version>")
case "generate-token":
if isDaemonRunning(cfg) {
log.Fatalf("Cannot generate a new token while the daemon is running. Stop it first (`pkill vssm`).")
}
name := os.Args[2]
version := os.Args[3]
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/create?name=%s&version=%s", url.QueryEscape(name), url.QueryEscape(version)), nil)
token, err := generateToken()
if err != nil {
log.Fatalf("Failed to generate token: %v", err)
}
overwritten := cfg.Daemon.AuthToken != ""
cfg.Daemon.AuthToken = token
data, err := json.MarshalIndent(cfg, "", " ")
if err != nil {
log.Fatalf("Failed to marshal config: %v", err)
}
if err := os.WriteFile(absConfigPath, data, 0644); err != nil {
log.Fatalf("Failed to write config: %v", err)
}
if overwritten {
fmt.Println("Existing auth token was overwritten.")
}
fmt.Printf("New auth token: %s\n", token)
case "create":
if len(args) < 4 {
log.Fatalf("Usage: vssm create <instance_name> <version> <port>")
}
name := args[1]
version := args[2]
port := args[3]
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/create?name=%s&version=%s&port=%s", url.QueryEscape(name), url.QueryEscape(version), url.QueryEscape(port)), nil)
case "start":
if len(os.Args) < 3 {
log.Fatalf("Usage: go run . start <instance_name>")
if len(args) < 2 {
log.Fatalf("Usage: vssm start <instance_name>")
}
name := os.Args[2]
name := args[1]
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/start?name=%s", url.QueryEscape(name)), nil)
case "stop":
if len(os.Args) < 3 {
log.Fatalf("Usage: go run . stop <instance_name>")
if len(args) < 2 {
log.Fatalf("Usage: vssm stop <instance_name>")
}
name := os.Args[2]
name := args[1]
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/stop?name=%s", url.QueryEscape(name)), nil)
case "cmd":
if len(os.Args) < 4 {
log.Fatalf("Usage: go run . cmd <instance_name> \"<server command>\"")
if len(args) < 3 {
log.Fatalf("Usage: vssm cmd <instance_name> \"<server command>\"")
}
name := os.Args[2]
serverCmd := os.Args[3]
name := args[1]
serverCmd := args[2]
payload := CommandPayload{Command: serverCmd}
body, _ := json.Marshal(payload)
@@ -75,30 +147,62 @@ func main() {
case "list", "status":
fetchAndPrintStatus(cfg)
case "show-config":
fmt.Printf("%v", cfg.Storage.AppDataDir)
case "delete":
if len(args) < 2 {
log.Fatalf("Usage: vssm delete <instance_name>")
}
name := args[1]
deleteCmd := flag.NewFlagSet("delete", flag.ExitOnError)
purge := deleteCmd.Bool("purge", false, "Delete instance files from disk")
deleteCmd.Parse(args[2:])
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/delete?name=%s&purge=%s", url.QueryEscape(name), url.QueryEscape(strconv.FormatBool(*purge))), nil)
case "modify":
if len(args) < 4 {
log.Fatalf("Usage: vssm modify <instance_name> <new_name> <new_port>")
}
name := args[1]
newName := args[2]
newPort := args[3]
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/modify?name=%s&newName=%s&newPort=%s", url.QueryEscape(name), url.QueryEscape(newName), url.QueryEscape(newPort)), nil)
default:
printUsage()
}
}
func sendIPCRequest(cfg *AppConfig, method string, path string, body io.Reader) {
targetUrl := fmt.Sprintf("http://%s%s", cfg.Daemon.ListenAddress, path)
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
targetUrl := fmt.Sprintf("http://%s%s", listenAddress, path)
fmt.Printf("Listen Addr: %s; Target URL: %s\n", listenAddress, targetUrl)
req, err := http.NewRequest(method, targetUrl, body)
if err != nil {
log.Fatalf("Failed to construct IPC frame: %v", err)
log.Fatalf("Failed to construct IPC request: %v", err)
}
if body != nil {
req.Header.Set("Content-Type", "application/json")
}
if cfg.Daemon.AuthToken != "" {
req.Header.Set("Authorization", "Bearer "+cfg.Daemon.AuthToken)
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatalf("IPC connection failed. Is the vs-manager daemon running? Error: %v", err)
log.Fatalf("IPC connection failed. Is the VSSM daemon running? Error: %v", err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
if resp.StatusCode != http.StatusOK {
if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
log.Fatalf("Error from daemon: %s", string(respBody))
}
@@ -106,10 +210,21 @@ func sendIPCRequest(cfg *AppConfig, method string, path string, body io.Reader)
}
func fetchAndPrintStatus(cfg *AppConfig) {
targetUrl := fmt.Sprintf("http://%s/instances/list", cfg.Daemon.ListenAddress)
resp, err := http.Get(targetUrl)
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
targetUrl := fmt.Sprintf("http://%s/instances/list", listenAddress)
req, err := http.NewRequest("GET", targetUrl, nil)
if err != nil {
log.Fatalf("IPC connection failed. Is the vs-manager daemon running? Error: %v", err)
log.Fatalf("Failed to construct status request: %v", err)
}
if cfg.Daemon.AuthToken != "" {
req.Header.Set("Authorization", "Bearer "+cfg.Daemon.AuthToken)
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatalf("IPC connection failed. Is the VSSM daemon running? Error: %v", err)
}
defer resp.Body.Close()
@@ -124,7 +239,7 @@ func fetchAndPrintStatus(cfg *AppConfig) {
}
if len(instances) == 0 {
fmt.Println("No instances configured yet. Use 'create' to provision one.")
fmt.Println("No instances configured yet. Use 'create' to create one.")
return
}
@@ -138,12 +253,44 @@ func fetchAndPrintStatus(cfg *AppConfig) {
w.Flush()
}
func generateToken() (string, error) {
bytes := make([]byte, 32)
if _, err := rand.Read(bytes); err != nil {
return "", err
}
return hex.EncodeToString(bytes), nil
}
func isDaemonRunning(cfg *AppConfig) bool {
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
client := http.Client{Timeout: 500 * time.Millisecond}
resp, err := client.Get(fmt.Sprintf("http://%s/instances/list", listenAddress))
if err != nil {
return false
}
resp.Body.Close()
return true
}
func printUsage() {
fmt.Println("VintageStory Server Manager")
fmt.Println("\nUsage:")
fmt.Println(" vssm daemon Starts the background process supervisor")
fmt.Println(" vssm create <name> <version> Provisions baseline configuration and stores instance profile")
fmt.Println(" vssm start <name> Launches an existing server instance using stored profile")
fmt.Println(" vssm stop <name> Gracefully shuts down a server instance")
fmt.Println(" vssm cmd <name> \"<command>\" Dispatches a terminal console command down the pipe")
fmt.Println("\nGlobal Options:")
w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', 0)
fmt.Fprintln(w, " --config <path>\tExplicitly target a non-default config structure file location")
w.Flush()
fmt.Println("\nUsage Commands:")
w = tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', 0)
fmt.Fprintln(w, " vssm daemon\tStarts the daemon")
fmt.Fprintln(w, " vssm generate-token\tGenerates a new auth token and stores it in the config")
fmt.Fprintln(w, " vssm create <name> <version> <port>\tCreates the instance configuration and profile")
fmt.Fprintln(w, " vssm delete <name> [--purge]\tDeletes an instance profile, optionally deleting all files")
fmt.Fprintln(w, " vssm start <name>\tLaunches an existing server instance from a stored profile")
fmt.Fprintln(w, " vssm stop <name>\tGracefully shuts down a server instance")
fmt.Fprintln(w, " vssm cmd <name> \"<command>\"\tSends a command to an instance")
fmt.Fprintln(w, " vssm modify <name> <new_name> <new_port>\tRenames an instance and/or changes its port")
fmt.Fprintln(w, " vssm list\tDisplays a list of all instances and their status")
w.Flush()
}

View File

@@ -15,16 +15,24 @@ type ProcessManager struct {
sync.RWMutex
ActiveInstances map[string]*exec.Cmd
StdinPipes map[string]io.WriteCloser
LogBuffers map[string]*InstanceLogBuffer
}
type InstanceLogBuffer struct {
sync.RWMutex
Lines []string
MaxLines int
}
func NewProcessManager() *ProcessManager {
return &ProcessManager{
ActiveInstances: make(map[string]*exec.Cmd),
StdinPipes: make(map[string]io.WriteCloser),
LogBuffers: map[string]*InstanceLogBuffer{},
}
}
func (pm *ProcessManager) StartInstance(name string, version string, options VsServerConfigOptions, config *AppConfig) error {
func (pm *ProcessManager) StartInstance(name string, version string, meta InstanceMetadata, config *AppConfig) error {
pm.Lock()
defer pm.Unlock()
@@ -66,6 +74,7 @@ func (pm *ProcessManager) StartInstance(name string, version string, options VsS
pm.ActiveInstances[name] = cmd
pm.StdinPipes[name] = stdinPipe
pm.LogBuffers[name] = NewInstanceLogBuffer(200)
go pm.streamLogs(name, stdoutPipe)
go pm.watchProcessExit(name, cmd)
@@ -79,9 +88,17 @@ func (pm *ProcessManager) streamLogs(name string, stdout io.ReadCloser) {
scanner := bufio.NewScanner(stdout)
for scanner.Scan() {
//stream straight to the manager console terminal,
// but later dispatch payloads to our web UI or a log file
fmt.Printf("[%s]: %s\n", name, scanner.Text())
line := scanner.Text()
fmt.Printf("[%s]: %s\n", name, line)
pm.RLock()
buf, exists := pm.LogBuffers[name]
pm.RUnlock()
if exists {
buf.Append(line)
}
}
}
@@ -119,3 +136,31 @@ func (pm *ProcessManager) SendCommand(name string, command string) error {
return nil
}
func NewInstanceLogBuffer(maxLines int) *InstanceLogBuffer {
return &InstanceLogBuffer{
Lines: make([]string, 0, maxLines),
MaxLines: maxLines,
}
}
func (lb *InstanceLogBuffer) Append(line string) {
lb.Lock()
defer lb.Unlock()
if len(lb.Lines) >= lb.MaxLines {
// Shift array out by dropping index 0
lb.Lines = lb.Lines[1:]
}
lb.Lines = append(lb.Lines, line)
}
func (lb *InstanceLogBuffer) GetSnapshot() []string {
lb.RLock()
defer lb.RUnlock()
// Return a copy so the caller can safely iterate or serialize to JSON without lock conflicts
snapshot := make([]string, len(lb.Lines))
copy(snapshot, lb.Lines)
return snapshot
}

2
web/dist/index.html vendored Normal file
View File

@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html><body>Web UI not embedded in this build.</body></html>