Skip to content

nyx_domain_add

Register a custom hostname. The backend returns the CNAME (and optional Apex-A) you have to point the hostname at. Once the DNS record resolves, the operator provisions an Ingress + Let’s-Encrypt certificate and the domain moves through CertPending → Ready.

The hostname must be a real RFC-1123 subdomain (e.g. app.acme.com, not a wildcard, not *.nyxory.app). The app must already exist in the project; create it first with nyx deploy.

Standard flow:

nyx domain add app.acme.com —app frontend

The output shows the CNAME. Add it to your DNS, then:

Section titled “The output shows the CNAME. Add it to your DNS, then:”

nyx domain status app.acme.com —watch

For agents / CI:

nyx domain add app.acme.com —app frontend —json | jq ‘.data.ingress_target’

ArgumentRequired
hostnameyes
FlagTypeDefaultDescription
--appstringApp name to route this hostname to (required)
--contextstringOverride the active context for this invocation (also: NYX_CONTEXT env var)
--jsonboolfalseEmit one JSON envelope per invocation (stdout for success, stderr for errors)
--path-prefixstringIngress path prefix (default: ’/‘)
--service-namestringOverride which Kubernetes Service the Ingress points at (default: the app’s single Service, or the one labeled nyxory.com/primary-service)
--service-portstringOverride the Service port (default: the Service’s first port)

Generated from tree.json @ fallbac.