Skip to content

Configuration

This library uses library-config('github.com/cloudboss/unobin-library-namecheap') for per-alias settings. Pass a value to library-configs: in factory source, usually from a factory input so stack files can choose the environment-specific settings.

Example usage:

imports: {
  namecheap: 'github.com/cloudboss/unobin-library-namecheap'
}

inputs: {
  namecheap-config: {
    type:    library-config('github.com/cloudboss/unobin-library-namecheap')
    default: {}
  }
}

library-configs: {
  namecheap: input.namecheap-config
}

Description

Configuration is the Namecheap library's configuration. Every credential field falls back to its NAMECHEAP_* environment variable when left empty, so a stack may supply credentials inline or through the environment. BaseURL overrides the endpoint the SDK derives from UseSandbox; it exists for tests and for pointing at a compatible proxy, and is normally left unset.

Fields

user-name

optional(string)

api-user

optional(string)

api-key

optional(string)

client-ip

optional(string)

use-sandbox

optional(boolean)

base-url

optional(string)

Configuration Constraints

This library declares no configuration constraints.