config

package
v0.56.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 24, 2026 License: Unlicense Imports: 15 Imported by: 0

Documentation

Overview

Package config provides a go-simpler.org/env configuration table and helpers for working with the list of key/value lists stored in .env files.

IMPORTANT: This file is the SINGLE SOURCE OF TRUTH for all environment variables. All configuration options MUST be defined here with proper `env` struct tags. Never use os.Getenv() directly in other packages - pass configuration via structs. This ensures all options appear in `./orly help` output and are documented.

For database backends, use GetDatabaseConfigValues() to extract database-specific settings, then construct a database.DatabaseConfig in the caller (e.g., main.go).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CuratingModeRequested added in v0.47.0 

func CuratingModeRequested() (requested bool, ownerKey string)

CuratingModeRequested checks if the first command line argument is "curatingmode" and returns the owner npub/hex pubkey if provided.

Return Values

  • requested: true if the 'curatingmode' subcommand was provided
  • ownerKey: the npub or hex pubkey provided as the second argument (empty if not provided)

func GetEnv 

func GetEnv() (requested bool)

GetEnv checks if the first command line argument is "env" and returns whether the environment configuration should be printed.

Return Values

  • requested: A boolean indicating true if the 'env' argument was provided, false otherwise.

Expected Behaviour

The function returns true when the first command line argument is "env" (case-insensitive), signalling that the environment configuration should be printed. Otherwise, it returns false.

func HelpRequested 

func HelpRequested() (help bool)

HelpRequested determines if the command line arguments indicate a request for help

Return Values

  • help: A boolean value indicating true if a help flag was detected in the command line arguments, false otherwise

Expected Behaviour

The function checks the first command line argument for common help flags and returns true if any of them are present. Returns false if no help flag is found

func IdentityRequested added in v0.8.0 

func IdentityRequested() (requested bool)

IdentityRequested checks if the first command line argument is "identity" and returns whether the relay identity should be printed and the program should exit.

Return Values

  • requested: true if the 'identity' subcommand was provided, false otherwise.

func InitBrandingRequested added in v0.52.0 

func InitBrandingRequested() (requested bool, targetDir, style string)

InitBrandingRequested checks if the first command line argument is "init-branding" and returns the target directory and style if provided.

Return Values

  • requested: true if the 'init-branding' subcommand was provided
  • targetDir: optional target directory for branding files (default: ~/.config/ORLY/branding)
  • style: branding style ("orly" or "generic", default: "generic")

Usage: orly init-branding [--style orly|generic] path

func MigrateRequested added in v0.48.1 

func MigrateRequested() (requested bool, fromType, toType, targetPath string)

MigrateRequested checks if the first command line argument is "migrate" and returns the migration parameters.

Return Values

  • requested: true if the 'migrate' subcommand was provided
  • fromType: source database type (badger, bbolt, neo4j)
  • toType: destination database type
  • targetPath: optional target path for destination database

func NRCRequested added in v0.48.9 

func NRCRequested() (requested bool, subcommand string, args []string)

NRCRequested checks if the first command line argument is "nrc" and returns the NRC subcommand parameters.

Return Values

  • requested: true if the 'nrc' subcommand was provided
  • subcommand: the NRC subcommand (generate, list, revoke)
  • args: additional arguments for the subcommand

func PrintEnv 

func PrintEnv(cfg *C, printer io.Writer)

PrintEnv outputs sorted environment key/value pairs from a configuration object to the provided writer

Parameters

  • cfg: Pointer to the configuration object containing env tags

  • printer: Destination for the output, typically an io.Writer implementation

Expected Behaviour

Outputs each environment variable derived from the config's struct tags in sorted order, formatted as "key=value\n" to the specified writer

func PrintHelp 

func PrintHelp(cfg *C, printer io.Writer)

PrintHelp prints help information including application version, environment variable configuration, and details about .env file handling to the provided writer

Parameters

  • cfg: Configuration object containing app name and config directory path

  • printer: Output destination for the help text

Expected Behaviour

Prints application name and version followed by environment variable configuration details, explains .env file behaviour including automatic loading and custom path options, and displays current configuration values using PrintEnv. Outputs all information to the specified writer

func ServeRequested added in v0.30.2 

func ServeRequested() (requested bool)

ServeRequested checks if the first command line argument is "serve" and returns whether the relay should start in ephemeral serve mode with RAM-based storage.

Return Values

  • requested: true if the 'serve' subcommand was provided, false otherwise.

func VersionRequested added in v0.32.0 

func VersionRequested() (requested bool)

VersionRequested checks if the first command line argument is "version" and returns whether the version should be printed and the program should exit.

Return Values

  • requested: true if the 'version' subcommand was provided, false otherwise.

Types

type C 

type C struct {
	AppName             string        `env:"ORLY_APP_NAME" usage:"set a name to display on information about the relay" default:"ORLY"`
	DataDir             string        `env:"ORLY_DATA_DIR" usage:"storage location for the event store" default:"~/.local/share/ORLY"`
	Listen              string        `env:"ORLY_LISTEN" default:"0.0.0.0" usage:"network listen address"`
	Port                int           `env:"ORLY_PORT" default:"3334" usage:"port to listen on"`
	HealthPort          int           `env:"ORLY_HEALTH_PORT" default:"0" usage:"optional health check HTTP port; 0 disables"`
	EnableShutdown      bool          `` /* 142-byte string literal not displayed */
	LogLevel            string        `env:"ORLY_LOG_LEVEL" default:"info" usage:"relay log level: fatal error warn info debug trace"`
	DBLogLevel          string        `env:"ORLY_DB_LOG_LEVEL" default:"info" usage:"database log level: fatal error warn info debug trace"`
	DBBlockCacheMB      int           `` /* 143-byte string literal not displayed */
	DBIndexCacheMB      int           `` /* 145-byte string literal not displayed */
	DBZSTDLevel         int           `` /* 135-byte string literal not displayed */
	LogToStdout         bool          `env:"ORLY_LOG_TO_STDOUT" default:"false" usage:"log to stdout instead of stderr"`
	LogBufferSize       int           `env:"ORLY_LOG_BUFFER_SIZE" default:"10000" usage:"number of log entries to keep in memory for web UI viewing (0 disables)"`
	Pprof               string        `env:"ORLY_PPROF" usage:"enable pprof in modes: cpu,memory,allocation,heap,block,goroutine,threadcreate,mutex"`
	PprofPath           string        `env:"ORLY_PPROF_PATH" usage:"optional directory to write pprof profiles into (inside container); default is temporary dir"`
	PprofHTTP           bool          `env:"ORLY_PPROF_HTTP" default:"false" usage:"if true, expose net/http/pprof on port 6060"`
	IPWhitelist         []string      `` /* 159-byte string literal not displayed */
	IPBlacklist         []string      `` /* 146-byte string literal not displayed */
	Admins              []string      `env:"ORLY_ADMINS" usage:"comma-separated list of admin npubs"`
	Owners              []string      `` /* 138-byte string literal not displayed */
	ACLMode             string        `env:"ORLY_ACL_MODE" usage:"ACL mode: follows, managed (nip-86), curating, none" default:"none"`
	AuthRequired        bool          `env:"ORLY_AUTH_REQUIRED" usage:"require authentication for all requests (works with managed ACL)" default:"false"`
	AuthToWrite         bool          `` /* 135-byte string literal not displayed */
	NIP46BypassAuth     bool          `` /* 150-byte string literal not displayed */
	BootstrapRelays     []string      `env:"ORLY_BOOTSTRAP_RELAYS" usage:"comma-separated list of bootstrap relay URLs for initial sync"`
	NWCUri              string        `env:"ORLY_NWC_URI" usage:"NWC (Nostr Wallet Connect) connection string for Lightning payments"`
	SubscriptionEnabled bool          `` /* 139-byte string literal not displayed */
	MonthlyPriceSats    int64         `env:"ORLY_MONTHLY_PRICE_SATS" default:"6000" usage:"price in satoshis for one month subscription (default ~$2 USD)"`
	RelayURL            string        `env:"ORLY_RELAY_URL" usage:"base URL for the relay dashboard (e.g., https://relay.example.com)"`
	RelayAddresses      []string      `` /* 150-byte string literal not displayed */
	RelayPeers          []string      `` /* 162-byte string literal not displayed */
	RelayGroupAdmins    []string      `env:"ORLY_RELAY_GROUP_ADMINS" usage:"comma-separated list of npubs authorized to publish relay group configuration events"`
	ClusterAdmins       []string      `env:"ORLY_CLUSTER_ADMINS" usage:"comma-separated list of npubs authorized to manage cluster membership"`
	FollowListFrequency time.Duration `env:"ORLY_FOLLOW_LIST_FREQUENCY" usage:"how often to fetch admin follow lists (default: 1h)" default:"1h"`

	// Progressive throttle for follows ACL mode - allows non-followed users to write with increasing delay
	FollowsThrottleEnabled  bool          `env:"ORLY_FOLLOWS_THROTTLE" default:"false" usage:"enable progressive delay for non-followed users in follows ACL mode"`
	FollowsThrottlePerEvent time.Duration `env:"ORLY_FOLLOWS_THROTTLE_INCREMENT" default:"25ms" usage:"delay added per event for non-followed users"`
	FollowsThrottleMaxDelay time.Duration `env:"ORLY_FOLLOWS_THROTTLE_MAX" default:"60s" usage:"maximum throttle delay cap"`

	// Blossom blob storage service settings
	BlossomEnabled       bool   `env:"ORLY_BLOSSOM_ENABLED" default:"true" usage:"enable Blossom blob storage server (only works with Badger backend)"`
	BlossomServiceLevels string `` /* 152-byte string literal not displayed */

	// Blossom upload rate limiting (for non-followed users)
	BlossomRateLimitEnabled bool  `env:"ORLY_BLOSSOM_RATE_LIMIT" default:"false" usage:"enable upload rate limiting for non-followed users"`
	BlossomDailyLimitMB     int64 `env:"ORLY_BLOSSOM_DAILY_LIMIT_MB" default:"10" usage:"daily upload limit in MB for non-followed users (EMA averaged)"`
	BlossomBurstLimitMB     int64 `env:"ORLY_BLOSSOM_BURST_LIMIT_MB" default:"50" usage:"max burst upload in MB (bucket cap)"`

	// Web UI and dev mode settings
	WebDisableEmbedded bool   `env:"ORLY_WEB_DISABLE" default:"false" usage:"disable serving the embedded web UI; useful for hot-reload during development"`
	WebDevProxyURL     string `` /* 147-byte string literal not displayed */

	// Branding/white-label settings
	BrandingDir     string `env:"ORLY_BRANDING_DIR" usage:"directory containing branding assets and configuration (default: ~/.config/ORLY/branding)"`
	BrandingEnabled bool   `env:"ORLY_BRANDING_ENABLED" default:"true" usage:"enable custom branding if branding directory exists"`
	Theme           string `env:"ORLY_THEME" default:"auto" usage:"UI color theme: auto (follow system), light, dark"`

	// CORS settings (for standalone dashboard mode)
	CORSEnabled bool     `env:"ORLY_CORS_ENABLED" default:"false" usage:"enable CORS headers for API endpoints (required for standalone dashboard)"`
	CORSOrigins []string `env:"ORLY_CORS_ORIGINS" usage:"allowed CORS origins (comma-separated, or * for all origins)"`

	// Sprocket settings
	SprocketEnabled bool `env:"ORLY_SPROCKET_ENABLED" default:"false" usage:"enable sprocket event processing plugin system"`

	// Spider settings
	SpiderMode string `env:"ORLY_SPIDER_MODE" default:"none" usage:"spider mode for syncing events: none, follows"`

	// Directory Spider settings
	DirectorySpiderEnabled  bool          `env:"ORLY_DIRECTORY_SPIDER" default:"false" usage:"enable directory spider for metadata sync (kinds 0, 3, 10000, 10002)"`
	DirectorySpiderInterval time.Duration `env:"ORLY_DIRECTORY_SPIDER_INTERVAL" default:"24h" usage:"how often to run directory spider"`
	DirectorySpiderMaxHops  int           `env:"ORLY_DIRECTORY_SPIDER_HOPS" default:"3" usage:"maximum hops for relay discovery from seed users"`

	PolicyEnabled bool   `` /* 135-byte string literal not displayed */
	PolicyPath    string `` /* 150-byte string literal not displayed */

	// NIP-43 Relay Access Metadata and Requests
	NIP43Enabled           bool          `env:"ORLY_NIP43_ENABLED" default:"false" usage:"enable NIP-43 relay access metadata and invite system"`
	NIP43PublishEvents     bool          `env:"ORLY_NIP43_PUBLISH_EVENTS" default:"true" usage:"publish kind 8000/8001 events when members are added/removed"`
	NIP43PublishMemberList bool          `env:"ORLY_NIP43_PUBLISH_MEMBER_LIST" default:"true" usage:"publish kind 13534 membership list events"`
	NIP43InviteExpiry      time.Duration `env:"ORLY_NIP43_INVITE_EXPIRY" default:"24h" usage:"how long invite codes remain valid"`

	// Database configuration
	DBType             string `env:"ORLY_DB_TYPE" default:"badger" usage:"database backend to use: badger, neo4j, or grpc"`
	QueryCacheDisabled bool   `` /* 135-byte string literal not displayed */

	// gRPC database client settings (only used when ORLY_DB_TYPE=grpc)
	GRPCServerAddress  string        `env:"ORLY_GRPC_SERVER" usage:"address of remote gRPC database server (only used when ORLY_DB_TYPE=grpc)"`
	GRPCConnectTimeout time.Duration `env:"ORLY_GRPC_CONNECT_TIMEOUT" default:"10s" usage:"gRPC connection timeout (only used when ORLY_DB_TYPE=grpc)"`

	// gRPC ACL client settings (only used when ORLY_ACL_TYPE=grpc)
	ACLType               string        `env:"ORLY_ACL_TYPE" default:"local" usage:"ACL backend: local (in-process) or grpc (remote ACL server)"`
	GRPCACLServerAddress  string        `env:"ORLY_GRPC_ACL_SERVER" usage:"address of remote gRPC ACL server (only used when ORLY_ACL_TYPE=grpc)"`
	GRPCACLConnectTimeout time.Duration `env:"ORLY_GRPC_ACL_TIMEOUT" default:"10s" usage:"gRPC ACL connection timeout (only used when ORLY_ACL_TYPE=grpc)"`

	// gRPC Sync client settings (only used when ORLY_SYNC_TYPE=grpc)
	SyncType                   string        `env:"ORLY_SYNC_TYPE" default:"local" usage:"sync backend: local (in-process) or grpc (remote sync services)"`
	GRPCSyncDistributedAddress string        `env:"ORLY_GRPC_SYNC_DISTRIBUTED" usage:"address of gRPC distributed sync server"`
	GRPCSyncClusterAddress     string        `env:"ORLY_GRPC_SYNC_CLUSTER" usage:"address of gRPC cluster sync server"`
	GRPCSyncRelayGroupAddress  string        `env:"ORLY_GRPC_SYNC_RELAYGROUP" usage:"address of gRPC relay group server"`
	GRPCSyncNegentropyAddress  string        `env:"ORLY_GRPC_SYNC_NEGENTROPY" usage:"address of gRPC negentropy server"`
	GRPCSyncConnectTimeout     time.Duration `env:"ORLY_GRPC_SYNC_TIMEOUT" default:"10s" usage:"gRPC sync connection timeout"`
	NegentropyEnabled          bool          `env:"ORLY_NEGENTROPY_ENABLED" default:"false" usage:"enable NIP-77 negentropy set reconciliation"`

	QueryCacheSizeMB int    `` /* 132-byte string literal not displayed */
	QueryCacheMaxAge string `env:"ORLY_QUERY_CACHE_MAX_AGE" default:"5m" usage:"maximum age for cached query results (e.g., 5m, 10m, 1h)"`

	// Neo4j configuration (only used when ORLY_DB_TYPE=neo4j)
	Neo4jURI      string `env:"ORLY_NEO4J_URI" default:"bolt://localhost:7687" usage:"Neo4j bolt URI (only used when ORLY_DB_TYPE=neo4j)"`
	Neo4jUser     string `env:"ORLY_NEO4J_USER" default:"neo4j" usage:"Neo4j authentication username (only used when ORLY_DB_TYPE=neo4j)"`
	Neo4jPassword string `env:"ORLY_NEO4J_PASSWORD" default:"password" usage:"Neo4j authentication password (only used when ORLY_DB_TYPE=neo4j)"`

	// Neo4j driver tuning (memory and connection management)
	Neo4jMaxConnPoolSize   int `` /* 126-byte string literal not displayed */
	Neo4jFetchSize         int `env:"ORLY_NEO4J_FETCH_SIZE" default:"1000" usage:"max records per fetch batch (prevents memory overflow, -1=fetch all)"`
	Neo4jMaxTxRetrySeconds int `env:"ORLY_NEO4J_MAX_TX_RETRY_SEC" default:"30" usage:"max seconds for retryable transaction attempts"`
	Neo4jQueryResultLimit  int `` /* 137-byte string literal not displayed */

	// Advanced database tuning (increase for large archives to reduce cache misses)
	SerialCachePubkeys  int `` /* 146-byte string literal not displayed */
	SerialCacheEventIds int `` /* 152-byte string literal not displayed */

	// Connection concurrency control
	MaxHandlersPerConnection int `` /* 148-byte string literal not displayed */
	MaxConnectionsPerIP      int `` /* 134-byte string literal not displayed */

	// Query result limits (prevents memory exhaustion from unbounded queries)
	QueryResultLimit int `` /* 133-byte string literal not displayed */

	// Adaptive rate limiting (PID-controlled)
	RateLimitEnabled            bool    `env:"ORLY_RATE_LIMIT_ENABLED" default:"true" usage:"enable adaptive PID-controlled rate limiting for database operations"`
	RateLimitTargetMB           int     `env:"ORLY_RATE_LIMIT_TARGET_MB" default:"0" usage:"target memory limit in MB (0=auto-detect: 66% of available, min 500MB)"`
	RateLimitWriteKp            float64 `env:"ORLY_RATE_LIMIT_WRITE_KP" default:"0.5" usage:"PID proportional gain for write operations"`
	RateLimitWriteKi            float64 `env:"ORLY_RATE_LIMIT_WRITE_KI" default:"0.1" usage:"PID integral gain for write operations"`
	RateLimitWriteKd            float64 `env:"ORLY_RATE_LIMIT_WRITE_KD" default:"0.05" usage:"PID derivative gain for write operations (filtered)"`
	RateLimitReadKp             float64 `env:"ORLY_RATE_LIMIT_READ_KP" default:"0.3" usage:"PID proportional gain for read operations"`
	RateLimitReadKi             float64 `env:"ORLY_RATE_LIMIT_READ_KI" default:"0.05" usage:"PID integral gain for read operations"`
	RateLimitReadKd             float64 `env:"ORLY_RATE_LIMIT_READ_KD" default:"0.02" usage:"PID derivative gain for read operations (filtered)"`
	RateLimitMaxWriteMs         int     `env:"ORLY_RATE_LIMIT_MAX_WRITE_MS" default:"1000" usage:"maximum delay for write operations in milliseconds"`
	RateLimitMaxReadMs          int     `env:"ORLY_RATE_LIMIT_MAX_READ_MS" default:"500" usage:"maximum delay for read operations in milliseconds"`
	RateLimitWriteTarget        float64 `env:"ORLY_RATE_LIMIT_WRITE_TARGET" default:"0.85" usage:"PID setpoint for writes (throttle when load exceeds this, 0.0-1.0)"`
	RateLimitReadTarget         float64 `env:"ORLY_RATE_LIMIT_READ_TARGET" default:"0.90" usage:"PID setpoint for reads (throttle when load exceeds this, 0.0-1.0)"`
	RateLimitEmergencyThreshold float64 `` /* 153-byte string literal not displayed */
	RateLimitRecoveryThreshold  float64 `` /* 145-byte string literal not displayed */
	RateLimitEmergencyMaxMs     int     `env:"ORLY_RATE_LIMIT_EMERGENCY_MAX_MS" default:"5000" usage:"maximum delay for writes in emergency mode (milliseconds)"`

	// TLS configuration
	TLSDomains []string `env:"ORLY_TLS_DOMAINS" usage:"comma-separated list of domains to respond to for TLS"`
	Certs      []string `` /* 152-byte string literal not displayed */

	// WireGuard VPN configuration (for secure bunker access)
	WGEnabled  bool   `env:"ORLY_WG_ENABLED" default:"false" usage:"enable embedded WireGuard VPN server for private bunker access"`
	WGPort     int    `env:"ORLY_WG_PORT" default:"51820" usage:"UDP port for WireGuard VPN server"`
	WGEndpoint string `env:"ORLY_WG_ENDPOINT" usage:"public IP/domain for WireGuard endpoint (required if WG enabled)"`
	WGNetwork  string `env:"ORLY_WG_NETWORK" default:"10.73.0.0/16" usage:"WireGuard internal network CIDR"`

	// NIP-46 Bunker configuration (remote signing service)
	BunkerEnabled bool `env:"ORLY_BUNKER_ENABLED" default:"false" usage:"enable NIP-46 bunker signing service (requires WireGuard)"`
	BunkerPort    int  `env:"ORLY_BUNKER_PORT" default:"3335" usage:"internal port for bunker WebSocket (only accessible via WireGuard)"`

	// Tor hidden service configuration (subprocess mode - runs tor binary automatically)
	TorEnabled bool   `` /* 136-byte string literal not displayed */
	TorPort    int    `env:"ORLY_TOR_PORT" default:"3336" usage:"internal port for Tor hidden service traffic"`
	TorDataDir string `env:"ORLY_TOR_DATA_DIR" usage:"Tor data directory (default: $ORLY_DATA_DIR/tor)"`
	TorBinary  string `env:"ORLY_TOR_BINARY" default:"tor" usage:"path to tor binary (default: search in PATH)"`
	TorSOCKS   int    `env:"ORLY_TOR_SOCKS" default:"0" usage:"SOCKS port for outbound Tor connections (0=disabled)"`

	// Nostr Relay Connect (NRC) configuration - tunnel private relay through public relay
	NRCEnabled        bool   `env:"ORLY_NRC_ENABLED" default:"false" usage:"enable NRC bridge to expose this relay through a public rendezvous relay"`
	NRCRendezvousURL  string `` /* 130-byte string literal not displayed */
	NRCAuthorizedKeys string `env:"ORLY_NRC_AUTHORIZED_KEYS" usage:"comma-separated list of authorized client pubkeys (hex) for secret-based auth"`
	NRCSessionTimeout string `env:"ORLY_NRC_SESSION_TIMEOUT" default:"30m" usage:"inactivity timeout for NRC sessions"`

	// Cluster replication configuration
	ClusterPropagatePrivilegedEvents bool `` /* 152-byte string literal not displayed */

	// Graph query configuration (NIP-XX)
	GraphQueriesEnabled bool `env:"ORLY_GRAPH_QUERIES_ENABLED" default:"true" usage:"enable graph traversal queries (_graph filter extension)"`
	GraphMaxDepth       int  `env:"ORLY_GRAPH_MAX_DEPTH" default:"16" usage:"maximum depth for graph traversal queries (1-16)"`
	GraphMaxResults     int  `env:"ORLY_GRAPH_MAX_RESULTS" default:"10000" usage:"maximum pubkeys/events returned per graph query"`
	GraphRateLimitRPM   int  `env:"ORLY_GRAPH_RATE_LIMIT_RPM" default:"60" usage:"graph queries per minute per connection (0=unlimited)"`

	// Archive relay configuration (query augmentation from authoritative archives)
	ArchiveEnabled     bool     `` /* 127-byte string literal not displayed */
	ArchiveRelays      []string `` /* 133-byte string literal not displayed */
	ArchiveTimeoutSec  int      `env:"ORLY_ARCHIVE_TIMEOUT_SEC" default:"30" usage:"timeout in seconds for archive relay queries"`
	ArchiveCacheTTLHrs int      `env:"ORLY_ARCHIVE_CACHE_TTL_HRS" default:"24" usage:"hours to cache query fingerprints to avoid repeated archive requests"`

	// Storage management configuration (access-based garbage collection)
	// TODO: GC implementation needs batch transaction handling to avoid Badger race conditions
	// TODO: GC should use smaller batches with delays between transactions on large datasets
	// TODO: GC deletion should be serialized or use transaction pools to prevent concurrent txn issues
	MaxStorageBytes int64 `env:"ORLY_MAX_STORAGE_BYTES" default:"0" usage:"maximum storage in bytes (0=auto-detect 80%% of filesystem)"`
	GCEnabled       bool  `` /* 153-byte string literal not displayed */
	GCIntervalSec   int   `env:"ORLY_GC_INTERVAL_SEC" default:"60" usage:"seconds between GC runs when storage exceeds limit"`
	GCBatchSize     int   `env:"ORLY_GC_BATCH_SIZE" default:"1000" usage:"number of events to consider per GC run"`

	// ServeMode is set programmatically by the 'serve' subcommand to grant full owner
	// access to all users (no env tag - internal use only)
	ServeMode bool
}

C holds application configuration settings loaded from environment variables and default values. It defines parameters for app behaviour, storage locations, logging, and network settings used across the relay service.

func New 

func New() (cfg *C, err error)

New creates and initializes a new configuration object for the relay application

Return Values

  • cfg: A pointer to the initialized configuration struct containing default or environment-provided values

  • err: An error object that is non-nil if any operation during initialization fails

Expected Behaviour:

Initializes a new configuration instance by loading environment variables and checking for a .env file in the default configuration directory. Sets logging levels based on configuration values and returns the populated configuration or an error if any step fails

func (*C) GetArchiveConfigValues added in v0.46.0 

func (cfg *C) GetArchiveConfigValues() (
	enabled bool,
	relays []string,
	timeoutSec int,
	cacheTTLHrs int,
)

GetArchiveConfigValues returns the archive relay configuration values. This avoids circular imports with pkg/archive while allowing main.go to construct the archive manager configuration.

func (*C) GetDatabaseConfigValues added in v0.31.8 

func (cfg *C) GetDatabaseConfigValues() (
	dataDir, logLevel string,
	blockCacheMB, indexCacheMB, queryCacheSizeMB int,
	queryCacheMaxAge time.Duration,
	queryCacheDisabled bool,
	serialCachePubkeys, serialCacheEventIds int,
	zstdLevel int,
	neo4jURI, neo4jUser, neo4jPassword string,
	neo4jMaxConnPoolSize, neo4jFetchSize, neo4jMaxTxRetrySeconds, neo4jQueryResultLimit int,
)

GetDatabaseConfigValues returns the database configuration values as individual fields. This avoids circular imports with pkg/database while allowing main.go to construct a database.DatabaseConfig with the correct type.

func (*C) GetFollowsThrottleConfigValues added in v0.48.10 

func (cfg *C) GetFollowsThrottleConfigValues() (
	enabled bool,
	perEvent time.Duration,
	maxDelay time.Duration,
)

GetFollowsThrottleConfigValues returns the progressive throttle configuration values for the follows ACL mode. This allows non-followed users to write with increasing delay.

func (*C) GetGRPCACLConfigValues added in v0.54.0 

func (cfg *C) GetGRPCACLConfigValues() (
	aclType string,
	serverAddress string,
	connectTimeout time.Duration,
)

GetGRPCACLConfigValues returns the gRPC ACL client configuration values. This avoids circular imports with pkg/acl/grpc while allowing main.go to construct the gRPC ACL client configuration.

func (*C) GetGRPCConfigValues added in v0.53.0 

func (cfg *C) GetGRPCConfigValues() (
	serverAddress string,
	connectTimeout time.Duration,
)

GetGRPCConfigValues returns the gRPC database client configuration values. This avoids circular imports with pkg/database/grpc while allowing main.go to construct the gRPC client configuration.

func (*C) GetGRPCSyncConfigValues added in v0.55.0 

func (cfg *C) GetGRPCSyncConfigValues() (
	syncType string,
	distributedAddress string,
	clusterAddress string,
	relayGroupAddress string,
	negentropyAddress string,
	connectTimeout time.Duration,
	negentropyEnabled bool,
)

GetGRPCSyncConfigValues returns the gRPC sync client configuration values. This avoids circular imports with pkg/sync/*/grpc packages while allowing main.go to construct the gRPC sync client configurations.

func (*C) GetGraphConfigValues added in v0.47.0 

func (cfg *C) GetGraphConfigValues() (
	enabled bool,
	maxDepth int,
	maxResults int,
	rateLimitRPM int,
)

GetGraphConfigValues returns the graph query configuration values. This avoids circular imports with pkg/protocol/graph while allowing main.go to construct the graph executor configuration.

func (*C) GetNRCConfigValues added in v0.48.9 

func (cfg *C) GetNRCConfigValues() (
	enabled bool,
	rendezvousURL string,
	authorizedKeys []string,
	sessionTimeout time.Duration,
)

GetNRCConfigValues returns the NRC (Nostr Relay Connect) configuration values. This avoids circular imports with pkg/protocol/nrc while allowing main.go to construct the NRC bridge configuration.

func (*C) GetRateLimitConfigValues added in v0.34.7 

func (cfg *C) GetRateLimitConfigValues() (
	enabled bool,
	targetMB int,
	writeKp, writeKi, writeKd float64,
	readKp, readKi, readKd float64,
	maxWriteMs, maxReadMs int,
	writeTarget, readTarget float64,
	emergencyThreshold, recoveryThreshold float64,
	emergencyMaxMs int,
)

GetRateLimitConfigValues returns the rate limiting configuration values. This avoids circular imports with pkg/ratelimit while allowing main.go to construct a ratelimit.Config with the correct type.

func (*C) GetStorageConfigValues added in v0.46.0 

func (cfg *C) GetStorageConfigValues() (
	maxStorageBytes int64,
	gcEnabled bool,
	gcIntervalSec int,
	gcBatchSize int,
)

GetStorageConfigValues returns the storage management configuration values. This avoids circular imports with pkg/storage while allowing main.go to construct the garbage collector and access tracker configuration.

func (*C) GetTorConfigValues added in v0.46.0 

func (cfg *C) GetTorConfigValues() (
	enabled bool,
	port int,
	dataDir string,
	binary string,
	socksPort int,
)

GetTorConfigValues returns the Tor hidden service configuration values. This avoids circular imports with pkg/tor while allowing main.go to construct the Tor service configuration.

func (*C) GetWireGuardConfigValues added in v0.40.0 

func (cfg *C) GetWireGuardConfigValues() (
	enabled bool,
	port int,
	endpoint string,
	network string,
	bunkerEnabled bool,
	bunkerPort int,
)

GetWireGuardConfigValues returns the WireGuard VPN configuration values. This avoids circular imports with pkg/wireguard while allowing main.go to construct the WireGuard server configuration.

type KV 

type KV struct{ Key, Value string }

KV is a key/value pair.

type KVSlice 

type KVSlice []KV

KVSlice is a sortable slice of key/value pairs, designed for managing configuration data and enabling operations like merging and sorting based on keys.

func EnvKV 

func EnvKV(cfg any) (m KVSlice)

EnvKV generates key/value pairs from a configuration object's struct tags

Parameters

  • cfg: A configuration object whose struct fields are processed for env tags

Return Values

  • m: A KVSlice containing key/value pairs derived from the config's env tags

Expected Behaviour

Processes each field of the config object, extracting values tagged with "env" and converting them to strings. Skips fields without an "env" tag. Handles various value types including strings, integers, booleans, durations, and string slices by joining elements with commas.

func (KVSlice) Compose 

func (kv KVSlice) Compose(kv2 KVSlice) (out KVSlice)

Compose merges two KVSlice instances into a new slice where key-value pairs from the second slice override any duplicate keys from the first slice.

Parameters

  • kv2: The second KVSlice whose entries will be merged with the receiver.

Return Values

  • out: A new KVSlice containing all entries from both slices, with keys from kv2 taking precedence over keys from the receiver.

Expected Behaviour

The method returns a new KVSlice that combines the contents of the receiver and kv2. If any key exists in both slices, the value from kv2 is used. The resulting slice remains sorted by keys as per the KVSlice implementation.

func (KVSlice) Len 

func (kv KVSlice) Len() int

func (KVSlice) Less 

func (kv KVSlice) Less(i, j int) bool

func (KVSlice) Swap 

func (kv KVSlice) Swap(i, j int)

Source Files

  • config.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.