config

package

Go to main page

Versions in this module

v0

v0.4.9

Dec 24, 2025

Changes in this version

+ const YAMLConfigType

+ const YAMLDBType

+ func GenerateAPIConfigFile(path string, cfg *ServiceParameters, overwrite bool) error

+ func GenerateAdminConfigFile(path string, cfg *ServiceParameters, overwrite bool) error

+ func GenerateGenericConfigFile(path string, cfg any, overwrite bool) error

+ func GenerateTLSConfigFile(path string, cfg *ServiceParameters, overwrite bool) error

+ func ValidateTLSConfigValues(cfg TLSConfiguration) error

type APIConfiguration

+ Carver YAMLConfigurationCarver

+ Logger YAMLConfigurationLogger

+ Osquery YAMLConfigurationOsquery

type AdminConfiguration

+ SAML YAMLConfigurationSAML

+ type ElasticLogger struct

+ DateSeparator string

+ Host string

+ IndexPrefix string

+ IndexSeparator string

+ Port string

+ type GraylogLogger struct

+ Host string

+ Queries string

+ Results string

+ Status string

+ URL string

+ type KafkaLogger struct

+ BootstrapServer string

+ ConnectionTimeout time.Duration

+ SASL KafkaSASLConfigurations

+ SSLCALocation string

+ Topic string

+ type KinesisLogger struct

+ AccessKeyID string

+ Endpoint string

+ Region string

+ SecretAccessKey string

+ SessionToken string

+ Stream string

+ type LocalCarver struct

+ CarvesDir string

+ type LocalLogger struct

+ Compress bool

+ FilePath string

+ MaxAge int

+ MaxBackups int

+ MaxSize int

+ type LogstashLogger struct

+ Host string

+ Path string

+ Port string

+ Protocol string

+ type S3Carver struct

+ AccessKey string

+ Bucket string

+ Region string

+ SecretAccessKey string

+ type S3Logger struct

+ AccessKey string

+ Bucket string

+ Region string

+ SecretAccessKey string

+ type ServiceParameters struct

+ Admin *YAMLConfigurationAdmin

+ BatchWriter *YAMLConfigurationWriter

+ Carver *YAMLConfigurationCarver

+ ConfigFlag bool

+ DB *YAMLConfigurationDB

+ Debug *YAMLConfigurationDebug

+ JWT *YAMLConfigurationJWT

+ Logger *YAMLConfigurationLogger

+ Metrics *YAMLConfigurationMetrics

+ Osctrld *YAMLConfigurationOsctrld

+ Osquery *YAMLConfigurationOsquery

+ Redis *YAMLConfigurationRedis

+ SAML *YAMLConfigurationSAML

+ Service *YAMLConfigurationService

+ ServiceConfigFile string

+ TLS *YAMLConfigurationTLS

+ type SplunkLogger struct

+ Host string

+ Index string

+ Token string

+ URL string

type YAMLConfigurationCarver

+ Local *LocalCarver

+ S3 *S3Carver

type YAMLConfigurationLogger

+ DB *YAMLConfigurationDB

+ Elastic *ElasticLogger

+ Graylog *GraylogLogger

+ Kafka *KafkaLogger

+ Kinesis *KinesisLogger

+ Local *LocalLogger

+ Logstash *LogstashLogger

+ S3 *S3Logger

+ Splunk *SplunkLogger

type YAMLConfigurationService

+ AuditLog bool

v0.4.8

Nov 5, 2025

Changes in this version

type AdminConfiguration

+ Admin YAMLConfigurationAdmin

type ServiceFlagParams

+ AuditLog bool

+ BackgroundImage string

+ BrandingImage string

+ type YAMLConfigurationAdmin struct

+ BackgroundImage string

+ BrandingImage string

+ SessionKey string

+ StaticDir string

+ StaticOffline bool

+ TemplatesDir string

v0.4.7

Sep 30, 2025

Changes in this version

+ const DBTypeMySQL

+ const DBTypePostgres

+ const DBTypeSQLite

+ type APIConfiguration struct

+ DB YAMLConfigurationDB

+ Debug YAMLConfigurationDebug

+ JWT YAMLConfigurationJWT

+ Redis YAMLConfigurationRedis

+ Service YAMLConfigurationService

+ TLS YAMLConfigurationTLS

+ type AdminConfiguration struct

+ Carver YAMLConfigurationCarver

+ DB YAMLConfigurationDB

+ Debug YAMLConfigurationDebug

+ JWT YAMLConfigurationJWT

+ Logger YAMLConfigurationLogger

+ Osctrld YAMLConfigurationOsctrld

+ Osquery YAMLConfigurationOsquery

+ Redis YAMLConfigurationRedis

+ Service YAMLConfigurationService

+ TLS YAMLConfigurationTLS

+ type OsqueryConfiguration struct

+ Carve bool

+ Config bool

+ Logger bool

+ Query bool

+ TablesFile string

+ Version string

type ServiceFlagParams

+ OsqueryConfigValues OsqueryConfiguration

type TLSConfiguration

+ Osquery YAMLConfigurationOsquery

type YAMLConfigurationDB

+ FilePath string

+ Type string

+ type YAMLConfigurationJWT struct

+ HoursToExpire int

+ JWTSecret string

+ type YAMLConfigurationOsquery struct

+ Carve bool

+ Config bool

+ Logger bool

+ Query bool

+ TablesFile string

+ Version string

v0.4.6

Sep 2, 2025

Changes in this version

+ type TLSConfiguration struct

+ BatchWriter YAMLConfigurationWriter

+ Carver YAMLConfigurationCarver

+ DB YAMLConfigurationDB

+ Debug YAMLConfigurationDebug

+ Logger YAMLConfigurationLogger

+ Metrics YAMLConfigurationMetrics

+ Osctrld YAMLConfigurationOsctrld

+ Redis YAMLConfigurationRedis

+ Service YAMLConfigurationService

+ TLS YAMLConfigurationTLS

+ type YAMLConfigurationCarver struct

+ CertificateFile string

+ KeyFile string

+ Type string

+ type YAMLConfigurationDB struct

+ ConnMaxLifetime int

+ ConnRetry int

+ Host string

+ MaxIdleConns int

+ MaxOpenConns int

+ Name string

+ Password string

+ Port string

+ SSLMode string

+ Username string

+ type YAMLConfigurationDebug struct

+ EnableHTTP bool

+ HTTPFile string

+ ShowBody bool

+ type YAMLConfigurationLogger struct

+ AlwaysLog bool

+ LoggerDBSame bool

+ Type string

+ type YAMLConfigurationMetrics struct

+ Enabled bool

+ Listener string

+ Port string

+ type YAMLConfigurationOsctrld struct

+ Enabled bool

+ type YAMLConfigurationRedis struct

+ ConnRetry int

+ ConnectionString string

+ DB int

+ Host string

+ Password string

+ Port string

+ type YAMLConfigurationSAML struct

+ CertPath string

+ JITProvision bool

+ KeyPath string

+ LoginURL string

+ LogoutURL string

+ MetaDataURL string

+ RootURL string

+ SPInitiated bool

+ type YAMLConfigurationService struct

+ Auth string

+ Host string

+ Listener string

+ LogFormat string

+ LogLevel string

+ Port string

+ type YAMLConfigurationTLS struct

+ CertificateFile string

+ KeyFile string

+ Termination bool

+ type YAMLConfigurationWriter struct

+ WriterBatchSize int

+ WriterBufferSize int

+ WriterTimeout int

v0.4.5

Aug 9, 2025

Changes in this version

+ type DebugHTTPConfiguration struct

+ Enabled bool

+ File string

+ ShowBody bool

+ type OsctrldConfiguration struct

+ Enabled bool

type ServiceFlagParams

+ DebugHTTPValues DebugHTTPConfiguration

+ OsctrldConfigValues OsctrldConfiguration

v0.4.4

Mar 26, 2025

Changes in this version

+ const AuthDB

+ const AuthJSON

+ const AuthJWT

+ const AuthNone

+ const AuthOAuth

+ const AuthOIDC

+ const AuthSAML

+ const CarverDB

+ const CarverLocal

+ const CarverS3

+ const LogFormatConsole

+ const LogFormatJSON

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ const LoggingDB

+ const LoggingElastic

+ const LoggingFile

+ const LoggingGraylog

+ const LoggingKafka

+ const LoggingKinesis

+ const LoggingLogstash

+ const LoggingNone

+ const LoggingS3

+ const LoggingSplunk

+ const LoggingStdout

+ const ServiceAPI

+ const ServiceAdmin

+ const ServiceTLS

+ func InitAPIFlags(params *ServiceFlagParams) []cli.Flag

+ func InitAdminFlags(params *ServiceFlagParams) []cli.Flag

+ func InitTLSFlags(params *ServiceFlagParams) []cli.Flag

+ type JSONConfigurationJWT struct

+ HoursToExpire int

+ JWTSecret string

+ type JSONConfigurationService struct

+ Auth string

+ Carver string

+ Host string

+ Listener string

+ LogFormat string

+ LogLevel string

+ Logger string

+ MetricsEnabled bool

+ MetricsListener string

+ MetricsPort string

+ Port string

+ SessionKey string

+ type JSONConfigurationWriter struct

+ WriterBatchSize int

+ WriterBufferSize int

+ WriterTimeout time.Duration

+ type KafkaConfiguration struct

+ BoostrapServer string

+ ConnectionTimeout time.Duration

+ SASL KafkaSASLConfigurations

+ SSLCALocation string

+ Topic string

+ type KafkaSASLConfigurations struct

+ Mechanism string

+ Password string

+ Username string

+ type S3Configuration struct

+ AccessKey string

+ Bucket string

+ Region string

+ SecretAccessKey string

+ type ServiceFlagParams struct

+ AlwaysLog bool

+ CarvedDir string

+ CarverConfigFile string

+ ConfigFlag bool

+ ConfigValues JSONConfigurationService

+ DBConfigFile string

+ DBConfigValues backend.JSONConfigurationDB

+ DBFlag bool

+ JWTConfigFile string

+ JWTConfigValues JSONConfigurationJWT

+ JWTFlag bool

+ KafkaConfiguration KafkaConfiguration

+ LoggerDBSame bool

+ LoggerFile string

+ OsqueryTablesFile string

+ OsqueryVersion string

+ RedisConfigFile string

+ RedisConfigValues cache.JSONConfigurationRedis

+ RedisFlag bool

+ S3CarverConfig S3Configuration

+ S3LogConfig S3Configuration

+ SAMLConfigFile string

+ ServiceConfigFile string

+ StaticFiles string

+ StaticOffline bool

+ TLSCertFile string

+ TLSKeyFile string

+ TLSServer bool

+ TemplatesDir string

+ WriterConfig JSONConfigurationWriter

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL