Operations and reference

Configuration reference

A quick reference for published clmbot commands, core configuration fields, ports, logs, and backup behavior.

Last reviewed: 2026-08-31Language: English

This page lists only commands and configuration covered by current public material. Releases and upstream adapters can introduce other fields. Prefer configuration generated by the same program version, and treat that version’s --help output as authoritative.

config.yaml fields

config.yaml is stored in the clmbot runtime directory. Generate it with discover-certificate where possible, then review it manually.

Field Type Description
servers[] Array Server configurations, with one item per certificate installation point
servers[].format String Certificate format, such as PEM or JKS
servers[].before_script String Script run before certificate replacement; requires manual review
servers[].after_script String Script run after replacement, usually for configuration checks or service reloads

servers[].format

Published examples include PEM and JKS. Other formats depend on the current release and deployment adapter. Do not copy fields or enum values from another release without confirmation.

Commands

These examples use the current compatible Linux amd64 binary name, clm-bot-linux-amd64.

Command Purpose Notes
./clm-bot-linux-amd64 --help Show subcommands and parameters for the current release Check this first
./clm-bot-linux-amd64 login Enter an Endpoint and credentials to initialize CaaS upstream example
./clm-bot-linux-amd64 discover-certificate Scan existing certificates and generate config.yaml See Certificate discovery
./clm-bot-linux-amd64 update-certificate Check, retrieve, back up, replace, and run activation scripts See Automatic updates and service reloads
./clm-bot-linux-amd64 server -a="0.0.0.0:8862" Listen in Server mode for an upstream push See Remote push

This site lists common commands only. Use the --help output from the downloaded version for the complete command set, global parameters, and exit codes.

Ports

Port Purpose
8862/TCP Example Server mode listening port; allow only trusted upstream sources

Scheduled pull requires no inbound port.

Logs

File Location Description
update.log Runtime directory Documentation examples append command output with >> update.log

Files and backups

  • The old certificate is copied to a .bak file in the certificate directory before replacement.
  • The clmbot runtime account needs permission to create and remove .bak files. See Least privilege.