DocsCLIConfiguration

Configuration

YAML configuration file reference.

Location

Default: ~/.serverme/serverme.yml

Example

yaml
server: serverme.site:8443
authtoken: sm_live_your_token
log_level: info

tunnels: webapp: proto: http addr: "3000" subdomain: myapp inspect: true

api: proto: http addr: "8080" subdomain: api

database: proto: tcp addr: "5432" remote_port: 54320 ```

Top-level fields

FieldRequiredDefaultDescription
serverNoserverme.site:8443Server address
authtokenNosaved tokenAPI key or JWT
log_levelNoinfodebug, info, warn, error
inspector_addrNo127.0.0.1:4040Local inspector address

Tunnel fields

FieldRequiredDescription
protoYeshttp, tcp, or tls
addrYesLocal port or address
subdomainNoCustom subdomain (HTTP/TLS)
hostnameNoCustom domain (HTTP/TLS)
remote_portNoRemote port (TCP only)
inspectNoEnable inspection (default: true)
authNoBasic auth user:pass (HTTP only)