ts settings

Read and change server-wide settings. Bare prints every setting, one argument reads one, two arguments write one.

Usage

ts settings [<property> [<value>]]

Description

Property names are lower-case and hyphenated: api-rate-limit, support-link, ticket-long-life-timeout. ts settings with no arguments lists them all with their current values, which is the quickest way to find the name you want.

A setting that has never been set shows as (unset) and takes its built-in default. To clear one, pass an empty string as a separate argument:

ts settings support-link ""

Settings that hold secrets or large embedded images — encryption keys, the signing key, the portal logo blobs, the license — are not readable or writable here. Use ts license for the license and the Administration site for portal artwork.

A write that does not change the value is not recorded, so re-running a configuration script does not fill the audit log with no-ops. Real changes are recorded with the previous and new values.

Examples

# What is configurable, and what is it now
ts settings

# Read one
ts settings support-link

# Change one
ts settings support-link https://help.example.net

# Clear one
ts settings support-link ""

# Turn on rate limiting and set the ceiling
ts settings api-rate-limit true
ts settings api-rate-limit-requests 20

# Capture the whole configuration for review
ts settings --format=json > settings.json

Output

PROPERTY                  VALUE
administrator-email       [email protected]
api-rate-limit            true
api-rate-limit-requests   20
authentication-type       Forms
domain                    turbo.example.net

Reading one property prints only its value, so it substitutes directly:

DOMAIN=$(ts settings domain)

Exit Codes

0 on success. -6 when the property name is not recognized. -5 when the account is not a Server Administrator.

Related Commands

• ts server — Per-server settings, as opposed to server-wide ones.
• ts audit — Who changed a setting, and from what.