config

package
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2022 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SetViperDefaults 

func SetViperDefaults()

Types

type Config 

type Config struct {
	// default orgID when none is given
	OrgID             string `json:"orgID"`
	DataNodeURL       string `json:"dataNodeURL"`
	ElasticSearch     `json:"elasticSearch"`
	HTTP              `json:"http"`
	TimeRevisionStore `json:"timeRevisionStore"`
	Logging           `json:"logging"`
	Nats              `json:"nats"`
	EAD               `json:"ead"`
	DB                `json:"db"`
	ImageProxy        `json:"imageProxy"`
	NameSpace         `json:"nameSpace"`
	PostHooks         []PostHook `json:"posthooks"`

	Organization `json:"organization"`
	Org          map[string]domain.OrganizationConfig `json:"org"`
	OAIPMH       `json:"oaipmh"`
	NDE          `json:"nde"`
	RDF          `json:"rdf"`
	// contains filtered or unexported fields
}

func (*Config) GetIndexService 

func (cfg *Config) GetIndexService() (*index.Service, error)

func (*Config) GetRevisionService added in v0.2.0 

func (cfg *Config) GetRevisionService() (*revision.Service, error)

func (*Config) IsDataNode added in v0.1.10 

func (cfg *Config) IsDataNode() bool

func (*Config) Options 

func (cfg *Config) Options(cfgOptions ...Option) ([]ikuzo.Option, error)

type DB 

type DB struct {
	// supported types are "sqlite3" "postgres"
	Type string
	// go sql compatible connection string, e.g. "/tmp/test.db" for sqlit3 or
	// "host=myhost port=myport user=hub3 dbname=hub3 password=mypassword"
	Connect string
	// contains filtered or unexported fields
}

func (*DB) AddOptions 

func (db *DB) AddOptions(cfg *Config) error

func (*DB) Shutdown 

func (db *DB) Shutdown(ctx context.Context) error

type EAD 

type EAD struct {
	CacheDir                string `json:"cacheDir"`
	Metrics                 bool   `json:"metrics"`
	Workers                 int    `json:"workers"`
	ProcessDigital          bool   `json:"processDigital"`
	ProcessDigitalIfMissing bool   `json:"processDigitalIfMissing"`
}

func (*EAD) AddOptions 

func (e *EAD) AddOptions(cfg *Config) error

func (EAD) NewService 

func (e EAD) NewService(cfg *Config) (*ead.Service, error)

type ElasticSearch 

type ElasticSearch struct {
	// enable elasticsearch client
	Enabled bool
	// urls to connect to elasticsearch cluster
	Urls []string
	// enable elasticsearch caching proxy
	Proxy bool
	// number of elasticsearch workers. default: 1
	Workers int
	// maxRetries number of client retries. default: 5
	MaxRetries int
	// clientTimeOut seconds for the client to time out. default 10
	ClientTimeOut int
	// gather elasticsearch metrics
	Metrics bool

	// base of the index aliases
	IndexName string
	// if non-empty digital objects will be indexed in a dedicated v2 index
	DigitalObjectSuffix string
	// number of shards. default 1
	Shards int
	// number of replicas. default 0
	Replicas int

	// UseRemoteIndexer is true when a separate process reads of the queue
	UseRemoteIndexer bool
	// IndexTypes options are v1, v2, fragment
	IndexTypes []string
	// use FastHTTP transport for communication with the ElasticSearch cluster
	FastHTTP bool `json:"fastHTTP"`
	// OrphanWait is the duration in seconds that the orphanDelete will wait for the cluster to be in sync
	OrphanWait int

	// UserName is the BasicAuth username
	UserName string `json:"userName"`
	// Password is the BasicAuth password
	Password string `json:"password"`
	// contains filtered or unexported fields
}

func (*ElasticSearch) AddOptions 

func (e *ElasticSearch) AddOptions(cfg *Config) error

func (*ElasticSearch) CreateDefaultMappings 

func (e *ElasticSearch) CreateDefaultMappings(es *elasticsearch.Client, withAlias, withReset bool) ([]string, error)

func (*ElasticSearch) IndexService 

func (e *ElasticSearch) IndexService(cfg *Config, ncfg *index.NatsConfig) (*index.Service, error)

func (*ElasticSearch) NewBulkIndexer 

func (e *ElasticSearch) NewBulkIndexer(es *elasticsearch.Client) (esutil.BulkIndexer, error)

func (*ElasticSearch) NewClient 

func (e *ElasticSearch) NewClient(l *logger.CustomLogger) (*elasticsearch.Client, error)

func (*ElasticSearch) ResetAll 

func (e *ElasticSearch) ResetAll(w http.ResponseWriter, r *http.Request)

type HTTP 

type HTTP struct {
	Port        int    `json:"port" mapstructure:"port"`
	MetricsPort int    `json:"metricsPort"`
	CertFile    string `json:"certFile"`
	KeyFile     string `json:"keyFile"`
}

func (*HTTP) AddOptions 

func (http *HTTP) AddOptions(cfg *Config) error

type ImageProxy 

type ImageProxy struct {
	Enabled          bool
	CacheDir         string
	MaxSizeCacheDir  int
	ProxyPrefix      string
	Timeout          int
	ProxyReferrer    []string
	RefuseList       []string
	AllowList        []string
	AllowedMimeTypes []string
	LruCacheSize     int
	EnableResize     bool
}

func (*ImageProxy) AddOptions 

func (ip *ImageProxy) AddOptions(cfg *Config) error

type Logging 

type Logging struct {
	DevMode        bool   `json:"devmode"`
	Level          string `json:"level"`
	WithCaller     bool   `json:"withCaller"`
	ConsoleLogger  bool   `json:"consoleLogger"`
	ErrorFieldName string `json:"errorFieldName"`
}

func (*Logging) AddOptions 

func (l *Logging) AddOptions(cfg *Config) error

func (*Logging) GetConfig 

func (l *Logging) GetConfig() logger.Config

type NDE added in v0.2.1 

type NDE struct {
	Enabled          bool     `json:"enabled"`
	Description      string   `json:"description"`
	Name             string   `json:"name"`
	DefaultLanguages []string `json:"defaultLanguages"`
	DefaultLicense   string   `json:"defaultLicense"`
	Publisher        struct {
		Name    string `json:"name"`
		AltName string `json:"altName"`
		URL     string `json:"url"`
	} `json:"publisher"`
	DatasetFmt   string                `json:"datasetFmt"`
	Distribution []nde.DistributionCfg `json:"distribution"`
}

func (*NDE) AddOptions added in v0.2.1 

func (n *NDE) AddOptions(cfg *Config) error

func (*NDE) NewService added in v0.2.1 

func (n *NDE) NewService(cfg *Config) (*nde.Service, error)

type NameSpace added in v0.2.1 

type NameSpace struct{}

func (NameSpace) AddOptions added in v0.2.1 

func (ns NameSpace) AddOptions(cfg *Config) error

type Nats 

type Nats struct {
	Enabled      bool   `json:"enabled"`
	ClusterID    string `json:"clusterID"`
	ClientID     string `json:"clientID"`
	DurableName  string `json:"durableName"`
	DurableQueue string `json:"durableQueue"`
	URL          string `json:"url"`
	// contains filtered or unexported fields
}

Nats are configuration options to access NATS streaming server

func (*Nats) AddOptions 

func (n *Nats) AddOptions(cfg *Config) error

func (*Nats) GetConfig 

func (n *Nats) GetConfig() (*index.NatsConfig, error)

type OAIPMH added in v0.2.0 

type OAIPMH struct {
	Enabled        bool     `json:"enabled"`
	AdminEmails    []string `json:"adminEmails"`
	RepositoryName string   `json:"repositoryName"`
	HarvestDelay   int      `json:"harvestDelay"`
	EadHarvestURL  string   `json:"eadHarvestUrl"`
	MetsHarvestURL string   `json:"metsHarvestUrl"`
	HarvestPath    string   `json:"harvestPath"`
	// contains filtered or unexported fields
}

func (*OAIPMH) AddOptions added in v0.2.0 

func (o *OAIPMH) AddOptions(cfg *Config) error

func (*OAIPMH) NewService added in v0.2.0 

func (o *OAIPMH) NewService(cfg *Config) (*oaipmh.Service, error)

type Option added in v0.2.0 

type Option interface {
	AddOptions(cfg *Config) error
}

type Organization added in v0.2.0 

type Organization struct {
	// domain is a list of all valid domains (including subdomains) for an domain.Organization
	// the domain ID will be injected in each request by the organization middleware.
	Store string
}

func (*Organization) AddOptions added in v0.2.0 

func (o *Organization) AddOptions(cfg *Config) error

type PostHook added in v0.1.10 

type PostHook struct {
	Name        string   `json:"name"`
	ExcludeSpec []string `json:"excludeSpec"`
	URL         string   `json:"url"`
	OrgID       string   `json:"orgID"`
	APIKey      string   `json:"apiKey"`
	UserName    string   `json:"userName"`
	Password    string   `json:"password"`
	CustomWait  int      `json:"customWait"`
}

type RDF added in v0.2.1 

type RDF struct {
	BaseURL string `json:"baseURL"`
}

type TimeRevisionStore 

type TimeRevisionStore struct {
	Enabled  bool   `json:"enabled"`
	DataPath string `json:"dataPath"`
}

func (*TimeRevisionStore) AddOptions 

func (trs *TimeRevisionStore) AddOptions(cfg *Config) error

Source Files

View all Source files

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.