xonfig

README

xonfig-go v3

Load configuration from XONFIG environment variable. Simple, strict.

Example

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/nixberg/xonfig-go/v3"
)

func main() {
	config := xonfig.MustLoad[struct {
		GinMode         string
		ListenAddress   string
		TrustedPlatform string

		Accounts gin.Accounts
	}]()

	// ...
}

Contents of XONFIG environment variable:

GinMode = "release"
ListenAddress = "0.0.0.0:8080"
TrustedPlatform = "CF-Connecting-IP"

[Accounts]
admin = "8mwf9mrtbu2z2zhbec7qg6kc63"

Documentation

Index

• Variables
• func MustLoad[Config any]() Config

Variables

var (
	ErrMissingEnv    = errors.New("XONFIG environment variable not present")
	ErrEmptyEnv      = errors.New("XONFIG environment variable contains only white space")
	ErrInvalidConfig = errors.New("invalid config")
)

Functions

func MustLoad

func MustLoad[Config any]() Config