Skip to content

server

Terminal window
turnout server <add|list|show|edit|remove> [...]

A server is a machine: its base URL, the SSH host and port, a TLS policy and a human-friendly label. Who logs in is a credential, and where files land is a path - a server points at both by name. See Entities.

Terminal window
turnout server add [NAME] [--url URL] [--label TEXT]
[--host HOST[:PORT]] [--credential NAME] [--insecure]
Flag Short Description
--url -u Base URL, e.g. https://staging.example.com
--label -l Human-friendly label
--host -H SSH host and port when they differ from the URL’s host
--credential -c Credential used to log in here
--insecure -i Accept self-signed or invalid TLS certificates for this server

--host is optional: with no value, SSH connects to the URL’s own host on port 22, which is right for most stands. Set it when the stand answers HTTP on one name and SSH on another, or on a non-standard port.

With NAME or --url missing, an interactive wizard asks for each field, including which credential to use and whether to accept self-signed TLS certificates.

Terminal window
turnout server add # wizard
turnout server add staging --url https://staging.example.com --label "Team staging"
turnout server add prod --url https://prod.example.com --host ssh.prod.example.com:2200
turnout server add lab --url https://10.0.0.42 --insecure # self-signed cert
turnout server add lab -u https://10.0.0.42 -i # same, short form
Terminal window
turnout server list # one line per server: name, URL, label
turnout server show prod # full card: URL, SSH, credential, which targets land here

show also names the apps whose allow-list has the server (Used by) and the apps bound to it right now (Bound). Both take --json and print the same fields as JSON - list an array of what show prints for one. See JSON output.

Omit the name on a terminal and turnout offers a picker; edit and remove do the same.

Terminal window
turnout server edit prod # interactive wizard
turnout server edit prod --url https://prod-eu.example.com
turnout server edit lab --secure # require valid TLS certificates again
turnout server edit lab --insecure # accept invalid TLS certificates
Flag Short Description
--url -u Base URL
--label -l Human-friendly label
--host -H SSH host and port (empty value falls back to the URL’s host)
--credential -c Credential used to log in here (empty value unsets it)
--insecure -i Accept invalid TLS certificates for this server
--secure -S Require valid TLS certificates for this server

Who logs in:

Terminal window
turnout server edit prod --credential prod-deploy
turnout server edit prod -c prod-deploy # same, short form
Terminal window
turnout server remove staging [--yes]

Apps that allowed this server are updated automatically - the name is removed from their allow-lists.

Credentials and paths are left alone: they are shared, and a login that also reaches three other stands should not disappear with one of them. Remove them explicitly with turnout credential remove and turnout path remove.