Compare commits

1 Commits

Author SHA1 Message Date
71d5cbcd85 Merge pull request 'Merge dev into master' (#1) from dev into master
Reviewed-on: #1
2026-06-07 00:44:41 -04:00
8 changed files with 24 additions and 391 deletions

View File

@@ -22,84 +22,19 @@ Setup is easy from source, all you need is:
- Run `./vssm` with no arguments to show usage - Run `./vssm` with no arguments to show usage
## Configuration ## Configuration
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. **For now, the configuration file is stored in `~/.config/vssm/config.json`, but this will be configurable later.**
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 ## 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).
### NEW: [v1.0.0 Bundled Release (Includes Web Interface)](https://git.bellsworne.tech/chrisbell/vssm_full/releases/tag/v1.0.0)
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
- [x] Configuration - [ ] Configuration
- [x] Custom configuration path (passed to the daemon with a flag `--config`) - [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 instance remembers config path (*so you don't have to pass `--config` everytime you run an ipc command*)
- [x] Daemon listen port - [ ] Daemon listen port (kind of implemented, could be cleaner)
- [x] Declarative Server configuration (Create servers in config) - [x] Declarative Server configuration (Create servers in config)
- [x] All configuration options - [x] All configuration options
- [x] Endpoint for modifying instance configuration (for web ui)
- [ ] Server management - [ ] Server management
- [x] Create servers - [x] Create servers

View File

@@ -19,7 +19,6 @@ type AppConfig struct {
Daemon struct { Daemon struct {
ListenAddress string `json:"listen_address"` ListenAddress string `json:"listen_address"`
Port int `json:"port"` Port int `json:"port"`
AuthToken string `json:"auth_token"`
} `json:"daemon"` } `json:"daemon"`
Instances map[string]InstanceMetadata `json:"instances"` Instances map[string]InstanceMetadata `json:"instances"`

209
daemon.go
View File

@@ -1,26 +1,18 @@
package main package main
import ( import (
"embed"
"encoding/json" "encoding/json"
"fmt" "fmt"
"io"
"io/fs"
"net/http" "net/http"
"os" "os"
"os/signal" "os/signal"
"path/filepath" "path/filepath"
"slices"
"strconv" "strconv"
"strings"
"sync" "sync"
"syscall" "syscall"
"time" "time"
) )
//go:embed web/dist
var webFS embed.FS
type CommandPayload struct { type CommandPayload struct {
Command string `json:"command"` Command string `json:"command"`
} }
@@ -54,49 +46,17 @@ func StartDaemon(cfg *AppConfig, configPath string) error {
mux.HandleFunc("/instances/list", ds.handleList) mux.HandleFunc("/instances/list", ds.handleList)
mux.HandleFunc("/instances/logs", ds.handleGetLogs) mux.HandleFunc("/instances/logs", ds.handleGetLogs)
mux.HandleFunc("/instances/delete", ds.handleDelete) 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) { corsWrappedHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Access-Control-Allow-Origin", "*") w.Header().Set("Access-Control-Allow-Origin", "*")
w.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS") w.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS")
w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization") w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
if r.Method == http.MethodOptions { if r.Method == http.MethodOptions {
w.WriteHeader(http.StatusOK) w.WriteHeader(http.StatusOK)
return 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) mux.ServeHTTP(w, r)
}) })
@@ -397,16 +357,6 @@ 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.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK) w.WriteHeader(http.StatusOK)
json.NewEncoder(w).Encode(responseList) json.NewEncoder(w).Encode(responseList)
@@ -513,160 +463,3 @@ func (ds *DaemonServer) handleDelete(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Successfully deleted instance %s", name) 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,12 +98,14 @@ func patchBinaryForNixos(binaryPath string) error {
return nil return nil
} }
fmt.Println("[NixOS Detected] Patching server binary...") fmt.Println("[NixOS Detected] Patching server interpreter pathway...")
dotnetRoot := os.Getenv("DOTNET_ROOT") dotnetRoot := os.Getenv("DOTNET_ROOT")
var interpreter string var interpreter string
if dotnetRoot != "" { 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() out, err := exec.Command("patchelf", "--print-interpreter", filepath.Join(dotnetRoot, "dotnet")).Output()
if err == nil && len(out) > 0 { if err == nil && len(out) > 0 {
interpreter = strings.TrimSpace(string(out)) interpreter = strings.TrimSpace(string(out))

View File

@@ -30,7 +30,7 @@ func CreateNewInstance(name string, version string, meta InstanceMetadata, cfg *
instanceConfigPath := filepath.Join(instanceDir, "serverconfig.json") instanceConfigPath := filepath.Join(instanceDir, "serverconfig.json")
if err := PrepareInstanceConfig(version, instanceConfigPath, meta, cfg); err != nil { if err := PrepareInstanceConfig(version, instanceConfigPath, meta, cfg); err != nil {
return fmt.Errorf("Failed to create baseline configuration: %w", err) return fmt.Errorf("Failed provisioning server baseline configuration: %w", err)
} }
fmt.Printf("Instance '%s' (v%s) successfully initialized\n", name, version) fmt.Printf("Instance '%s' (v%s) successfully initialized\n", name, version)

View File

@@ -62,16 +62,8 @@ func SyncInstanceConfig(templateVersion string, instanceConfigPath string, meta
} }
for key, value := range meta.Config { 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[key] = value
} }
}
rawConfig["ServerName"] = meta.ServerName rawConfig["ServerName"] = meta.ServerName
rawConfig["Port"] = meta.Port rawConfig["Port"] = meta.Port

114
main.go
View File

@@ -2,8 +2,6 @@ package main
import ( import (
"bytes" "bytes"
"crypto/rand"
"encoding/hex"
"encoding/json" "encoding/json"
"flag" "flag"
"fmt" "fmt"
@@ -15,7 +13,6 @@ import (
"path/filepath" "path/filepath"
"strconv" "strconv"
"text/tabwriter" "text/tabwriter"
"time"
) )
func main() { func main() {
@@ -24,7 +21,7 @@ func main() {
log.Fatalf("Could not locate user home dir: %v", err) log.Fatalf("Could not locate user home dir: %v", err)
} }
defaultConfigPath := filepath.Join(home, ".local", "share", "vssm", "config.json") defaultConfigPath := filepath.Join(home, ".config", "vssm", "config.json")
configFlag := flag.String("config", defaultConfigPath, "Explicit path targeting a custom vssm config.json profile") configFlag := flag.String("config", defaultConfigPath, "Explicit path targeting a custom vssm config.json profile")
@@ -74,42 +71,11 @@ func main() {
switch subCommand { switch subCommand {
case "daemon": case "daemon":
if isDaemonRunning(cfg) { fmt.Printf("Initializing VS server manager background supervisor [Config: %s]...\n", absConfigPath)
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 { if err := StartDaemon(cfg, absConfigPath); err != nil {
log.Fatalf("Daemon runtime fatal error: %v", err) log.Fatalf("Daemon runtime fatal error: %v", err)
} }
case "generate-token":
if isDaemonRunning(cfg) {
log.Fatalf("Cannot generate a new token while the daemon is running. Stop it first (`pkill vssm`).")
}
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": case "create":
if len(args) < 4 { if len(args) < 4 {
log.Fatalf("Usage: vssm create <instance_name> <version> <port>") log.Fatalf("Usage: vssm create <instance_name> <version> <port>")
@@ -163,15 +129,6 @@ func main() {
sendIPCRequest(cfg, "POST", fmt.Sprintf("/instances/delete?name=%s&purge=%s", url.QueryEscape(name), url.QueryEscape(strconv.FormatBool(*purge))), nil) 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: default:
printUsage() printUsage()
} }
@@ -183,20 +140,16 @@ func sendIPCRequest(cfg *AppConfig, method string, path string, body io.Reader)
fmt.Printf("Listen Addr: %s; Target URL: %s\n", listenAddress, targetUrl) fmt.Printf("Listen Addr: %s; Target URL: %s\n", listenAddress, targetUrl)
req, err := http.NewRequest(method, targetUrl, body) req, err := http.NewRequest(method, targetUrl, body)
if err != nil { if err != nil {
log.Fatalf("Failed to construct IPC request: %v", err) log.Fatalf("Failed to construct IPC frame: %v", err)
} }
if body != nil { if body != nil {
req.Header.Set("Content-Type", "application/json") 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) resp, err := http.DefaultClient.Do(req)
if err != nil { if err != nil {
log.Fatalf("IPC connection failed. Is the VSSM daemon running? Error: %v", err) log.Fatalf("IPC connection failed. Is the vs-manager daemon running? Error: %v", err)
} }
defer resp.Body.Close() defer resp.Body.Close()
@@ -212,19 +165,9 @@ func sendIPCRequest(cfg *AppConfig, method string, path string, body io.Reader)
func fetchAndPrintStatus(cfg *AppConfig) { func fetchAndPrintStatus(cfg *AppConfig) {
listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port) listenAddress := cfg.Daemon.ListenAddress + ":" + strconv.Itoa(cfg.Daemon.Port)
targetUrl := fmt.Sprintf("http://%s/instances/list", listenAddress) targetUrl := fmt.Sprintf("http://%s/instances/list", listenAddress)
resp, err := http.Get(targetUrl)
req, err := http.NewRequest("GET", targetUrl, nil)
if err != nil { if err != nil {
log.Fatalf("Failed to construct status request: %v", err) log.Fatalf("IPC connection failed. Is the vs-manager daemon running? Error: %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() defer resp.Body.Close()
@@ -239,7 +182,7 @@ func fetchAndPrintStatus(cfg *AppConfig) {
} }
if len(instances) == 0 { if len(instances) == 0 {
fmt.Println("No instances configured yet. Use 'create' to create one.") fmt.Println("No instances configured yet. Use 'create' to provision one.")
return return
} }
@@ -253,44 +196,15 @@ func fetchAndPrintStatus(cfg *AppConfig) {
w.Flush() 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() { func printUsage() {
fmt.Println("VintageStory Server Manager") fmt.Println("VintageStory Server Manager")
fmt.Println("\nGlobal Options:") fmt.Println("\nGlobal Options:")
fmt.Println(" --config <path> Explicitly target a non-default config structure file location")
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:") fmt.Println("\nUsage Commands:")
fmt.Println(" vssm daemon Starts the background process supervisor")
w = tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', 0) fmt.Println(" vssm create <name> <version> Provisions baseline configuration and stores instance profile")
fmt.Fprintln(w, " vssm daemon\tStarts the daemon") fmt.Println(" vssm start <name> Launches an existing server instance using stored profile")
fmt.Fprintln(w, " vssm generate-token\tGenerates a new auth token and stores it in the config") fmt.Println(" vssm stop <name> Gracefully shuts down a server instance")
fmt.Fprintln(w, " vssm create <name> <version> <port>\tCreates the instance configuration and profile") fmt.Println(" vssm cmd <name> \"<command>\" Dispatches a terminal console command down the pipe")
fmt.Fprintln(w, " vssm delete <name> [--purge]\tDeletes an instance profile, optionally deleting all files") fmt.Println(" vssm list Displays the operational matrix of all instances")
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()
} }

2
web/dist/index.html vendored
View File

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