Saphan StudioDocs
Reference/Commands

saphan service

Registers Saphan Studio's background services with this machine's service supervisor so they come back after a restart.

Registers Saphan Studio's background services with this machine's service supervisor so they come back after a restart. A machine-wide installation registers system services that start at boot; a per-user installation registers per-user services that start when you log in and stop when you log out.

saphan service

saphan service install

Registers and starts the server (saphan-server), the gateway that serves the console, and — always on a per-user installation, and on a machine-wide one when --operator is given — the launcher (saphan-agent launcher), which starts the models, terminals and runs the console asks for as the operator. Anything already running is stopped first only if the supervisor can take over; otherwise the unit files are written and load at the next login. It prints the address the console will answer on.

saphan service install
flagtypedefaultwhat it does
--gateway-userstringMachine-wide installation only: the OS user the gateway runs as (default: the supervisor's own, usually root); the launcher accepts connections from exactly this user. ⚠ Without it, the launcher accepts connections from root. With it, that user's numeric ID is recorded in the installation's etc/gateway-uid file, and the installation's ownership checks on its own files and directories then trust that user alongside root (the record is believed only while it is owned by root and writable by root alone).
--operatorstringMachine-wide installation only: the OS user who owns the models' logins and runs the launcher. Without it, no launcher is registered.
--socket-groupstringMachine-wide installation only: the group given to the launcher's socket so the gateway's user can connect; the operator must already belong to it. Refused on a per-user installation. It is written into the launcher's unit file only: pass it again on every reinstall, or the new unit is written without it and the gateway's user can no longer reach the launcher.

saphan service status

Reports whether this installation's services are registered with the machine's supervisor, and their state.

saphan service status

saphan service uninstall

Stops the services and removes their unit files, so they no longer come back after a restart. Services registered by another installation are never touched.

saphan service uninstall

Global options apply to every command — see Every command.

On this page