Skip to content
SHC Docs

shc portal register

register this cluster with the Portal using a registration code

Opt this cluster into the Portal: an agent-initiated outbound channel carrying heartbeats up and install dispatches down. The code comes from the Portal dashboard. The Portal holds no cluster credential; the channel works behind NAT. Run as root on the daemon host. Pass - to read one line from stdin instead of putting the code in argv.

shc portal register <code|-> [flags]
shc portal register PTL-4X9Q-72KM
shc portal register - < registration-code
-h, --help help for register
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc portal - register this cluster with the Selfhosted Cloud Portal