runner settings

Gerencia as configuracoes globais do Runner (config.yml). Permite ler, modificar e remover valores sem editar o arquivo manualmente.

Sintaxe

runner settings show [--json]
runner settings get <key> [--json]
runner settings set <key> <value> [--json]
runner settings delete <key> [--json]

Subcomandos

show

Mostra toda a configuracao atual.

runner settings show          # YAML (formato nativo)
runner settings show --json   # JSON (integracao)

get

Le um valor especifico por dot-notation.

runner settings get github.default_user
runner settings get paths.apps_dir
runner settings get keep_versions --json

Valores aninhados usam . como separador:

runner settings get traefik.entrypoints    # array
runner settings get notify.telegram_bot_token  # string
runner settings get security.enabled       # boolean

set

Define um valor no config.yml.

runner settings set github.default_user devborlot
runner settings set paths.apps_dir /data/apps
runner settings set keep_versions 5
runner settings set notify.telegram_bot_token "123:ABC"

Cria chaves intermediarias automaticamente se nao existirem:

runner settings set staging.custom_field valor
# Cria a chave staging.custom_field mesmo se staging nao existia

delete

Remove uma chave do config.yml (volta ao default).

runner settings delete staging.domain_suffix
runner settings delete notify.discord_webhook

Exemplos Praticos

Configurar servidor novo via SSH

ssh prod "runner settings set github.default_user devborlot --json"
ssh prod "runner settings set paths.apps_dir /data/apps --json"
ssh prod "runner settings set notify.telegram_bot_token '123:ABC' --json"
ssh prod "runner settings set notify.telegram_chat_id '-100123' --json"

Verificar configuracao atual

runner settings show --json | jq '.paths'

Usar com runner init

O runner init --set e equivalente a runner init + runner settings set:

# Equivalente:
runner init --set github.default_user=devborlot
# Mesmo que:
runner init && runner settings set github.default_user devborlot

Chaves Comuns

Chave Tipo Default Descricao
paths.apps_dir string /data/apps Diretorio base das apps
paths.traefik_dynamic string /etc/traefik/dynamic Config Traefik
paths.logs_dir string /opt/runner/logs Logs do Runner
paths.state_dir string /opt/runner/state State files
github.default_user string "" Usuario GitHub padrao
keep_versions integer 3 Versoes mantidas por instancia
max_deploy_retries integer 3 Retries antes de skipar commit
notify.telegram_bot_token string "" Token do bot Telegram
notify.telegram_chat_id string "" Chat ID Telegram
notify.discord_webhook string "" Webhook Discord
auto_cleanup_prs boolean true Limpar PRs expirados no fetch

Veja Tambem

By Borlot.com.br on 20/04/2026