docs: finalize v1 design and Windows service model

2026-08-28 11:00:58 +00:00
parent a89253be96
commit 85f4d5d2a0
11 changed files with 833 additions and 241 deletions
@@ -0,0 +1,53 @@
+# RVBox v1 Windows-first client example. Omitted keys use client.toml defaults.
+
+[client]
+# Reverse WebSocket endpoint exposed by nginx; replace before first connection.
+server_url = "wss://rvbox.example.test/v1/agent"
+# Private durable state; first-run code resolves ProgramData rather than expanding env text.
+state_dir = "C:\\ProgramData\\RVBox\\state"
+# Empty selects the local hostname; otherwise use an opaque 1-128 ASCII ID.
+client_id = ""
+# Protected root for per-identity default CWDs when a request omits cwd.
+daemon_cwd = "C:\\ProgramData\\RVBox\\work"
+# Maximum simultaneously running supervised Job Objects.
+max_running_commands = 16
+# Maximum durably accepted commands waiting to start.
+max_queued_commands = 100
+# Grace for reserved terminal cleanup during orderly exit.
+shutdown_grace = "30s"
+
+[tls]
+# Optional PEM CA bundle; empty uses the Windows trust store.
+ca_file = ""
+# Optional certificate-name override; empty derives it from server_url.
+server_name = ""
+
+[shells]
+# Required Windows default shell enum.
+default_windows = "powershell"
+# Unix shell is inactive on Windows but remains syntax-checked.
+default_unix = "sh"
+# Inactive Unix path.
+sh = ""
+# Inactive Unix path.
+bash = ""
+# Exact absolute executable used for SHELL_CMD.
+cmd = "C:\\Windows\\System32\\cmd.exe"
+# Exact absolute executable used for SHELL_POWERSHELL.
+powershell = "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
+# Absolute CWD roots permitted by local policy; empty allows any accessible path.
+allowed_cwd_roots = []
+
+[observability]
+# Loopback HTTP listener for local liveness, storage, and supervisor health.
+listen = "127.0.0.1:6902"
+# Structured logging threshold: debug, info, warn, or error.
+log_level = "info"
+# Structured log encoding used in the rotating file.
+log_format = "json"
+# Current service log opened read-only by the tray menu.
+log_file = "C:\\ProgramData\\RVBox\\logs\\rvbox.log"
+# Rotate the current log after this many bytes (10 MiB).
+log_max_bytes = 10485760
+# Number of sealed rotated log files to retain.
+log_max_files = 5