Self-hosted server command-line options
Flags for version and info, service install and repair, logs, and read-only database export on the self-hosted server.
Run the server with no flags to start it. Each flag below does one thing and exits without starting the server. --help prints the full list.
Information
| Flag | Does |
|---|---|
--version | Prints the build version |
--help, -h | Prints help |
--data-dir | Prints the data folder this install uses |
--community-id | Prints the community ID built into this binary |
--community-name | Prints this server's name |
Install and service
| Flag | Does |
|---|---|
--install, --install-service | Installs as a Windows service or systemd service. On Windows you can add --data-dir=PATH, --tcp-port=N, --udp-port=N and --no-prompt. The Linux installer always asks. |
--uninstall[=N], --uninstall-service[=N] | Removes the service and keeps the data folder. N picks an instance. |
--repair[=N] | Rebuilds the program files and service entry, keeping the data folder and ports. Needs root or Administrator. |
--tray | Windows only. Runs the system tray icon only. |
Unattended install on Windows, from an Administrator PowerShell:
.\gamevox-self-hosted-server.exe --install-service --data-dir=D:\GameVox-Data --tcp-port=8088 --udp-port=7070 --no-prompt Logs
| Flag | Does |
|---|---|
--logs | Prints the last 200 lines of the current log |
--logs --follow, -f | Follows the log live, across restarts, until Ctrl+C |
--logs --lines=N | Prints the last N lines |
--logs --all | Prints the whole current log |
--log-path | Lists every session log, newest first |
Linux control command
A Linux service install adds gamevox, with these commands: logs, log-path, journal, status, start, stop, restart, enable, disable, version, data-dir, flags and man. Put -i N first for instance 2 or higher, for example sudo gamevox -i 2 status.
Export data
Exports are read-only, and passwords, tokens and keys are redacted.
| Flag | Does |
|---|---|
--list-tables [--db=NAME] | Lists tables. NAME is community (default), content or audit. |
--export-table=TABLE [--db=NAME] [--format=FMT] [--output=PATH] | Exports a table as csv (default), json or sql. Without --output, prints to the screen. |
gamevox-self-hosted-server --list-tables --db=content
gamevox-self-hosted-server --export-table=channels --format=json
gamevox-self-hosted-server --export-table=messages --db=content --format=sql --output=msgs.sql Run export and log flags from the installed binary so they find the right data folder: sudo /opt/gamevox/gamevox-self-hosted-server on Linux, or the .exe in %ProgramFiles%\GameVox-Server on Windows. If you chose another data folder, set DATA_DIR first.
Ports, paths and addresses are set with environment variables, not flags.