auth

Documentation

Index

• func Description() string
• func FieldSpec() docs.FieldSpec
• func GetOptions(auth Config) []nats.Option
• type Config
  • func New() Config

Functions

func Description

func Description() string

Description returns a markdown version of NATs authentication documentation.

func FieldSpec

func FieldSpec() docs.FieldSpec

FieldSpec returns documentation authentication specs for NATS components

func GetOptions

func GetOptions(auth Config) []nats.Option

GetOptions initialises NATS functional options for the auth fields

Types

type Config

type Config struct {
	NKeyFile            string `json:"nkey_file" yaml:"nkey_file"`
	UserCredentialsFile string `json:"user_credentials_file" yaml:"user_credentials_file"`
}

Config contains configuration params for NATS authentication.

func New

func New() Config

New creates a new Config instance