config

package
v0.11.2 Latest Latest
Warning

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

 Go to latest Published: May 17, 2023 License: Apache-2.0, MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// DefaultPathName is the default config dir name.
	DefaultPathName = ".index-provider"
	// DefaultPathRoot is the path to the default config dir location.
	DefaultPathRoot = "~/" + DefaultPathName
	// DefaultConfigFile is the filename of the configuration file.
	DefaultConfigFile = "config"
	// EnvDir is the environment variable used to change the path root.
	EnvDir = "PROVIDER_PATH"
)
View Source 
const (
	PrivateKeyPathEnvVar = "INDEXPROVIDER_PRIV_KEY_PATH"
)

Variables

View Source 
var (
	ErrInitialized    = errors.New("configuration file already exists")
	ErrNotInitialized = errors.New("not initialized")
)
View Source 
var ErrInvalidPeerAddr = errors.New("invalid peer address")

ErrInvalidPeerAddr signals an address is not a valid peer address.

Functions

func Filename 

func Filename(configRoot string) (string, error)

Filename returns the configuration file path given a configuration root directory. If the configuration root directory is empty, use the default.

func Marshal 

func Marshal(value interface{}) ([]byte, error)

Marshal configuration with JSON.

func Path 

func Path(configRoot, configFile string) (string, error)

Path returns the config file path relative to the configuration root. If an empty string is provided for `configRoot`, the default root is used. If configFile is an absolute path, then configRoot is ignored.

func PathRoot 

func PathRoot() (string, error)

PathRoot returns the default configuration root directory.

Types

type AdminServer 

type AdminServer struct {
	// Admin is the admin API listen address
	ListenMultiaddr string
	ReadTimeout     Duration
	WriteTimeout    Duration
}

func NewAdminServer 

func NewAdminServer() AdminServer

NewAdminServer instantiates a new AdminServer config with default values.

func (*AdminServer) ListenNetAddr 

func (as *AdminServer) ListenNetAddr() (string, error)

func (*AdminServer) PopulateDefaults 

func (c *AdminServer) PopulateDefaults()

PopulateDefaults replaces zero-values in the config with default values.

type Bootstrap 

type Bootstrap struct {
	// Peers is the local nodes's bootstrap peer addresses
	Peers []string
	// MinimumPeers governs whether to bootstrap more connections. If the node
	// has less open connections than this number, it will open connections to
	// the bootstrap nodes.  Set to 0 to disable bootstrapping.
	MinimumPeers int
}

func NewBootstrap 

func NewBootstrap() Bootstrap

NewBootstrap instantiates a new Bootstrap config with default values.

func (Bootstrap) PeerAddrs 

func (b Bootstrap) PeerAddrs() ([]peer.AddrInfo, error)

PeerAddrs returns the bootstrap peers as a list of AddrInfo.

func (*Bootstrap) SetPeers 

func (b *Bootstrap) SetPeers(addrs []peer.AddrInfo)

SetPeers sers the bootstrap peers from a list of AddrInfo.

type Config 

type Config struct {
	Identity       Identity
	Datastore      Datastore
	Ingest         Ingest
	ProviderServer ProviderServer
	AdminServer    AdminServer
	Bootstrap      Bootstrap
	DirectAnnounce DirectAnnounce
	Reframe        Reframe
}

Config is used to load config files.

func Init 

func Init(out io.Writer) (*Config, error)

func InitWithIdentity 

func InitWithIdentity(identity Identity) (*Config, error)

func Load 

func Load(filePath string) (*Config, error)

Load reads the json-serialized config at the specified path.

func (*Config) PopulateDefaults 

func (c *Config) PopulateDefaults()

func (*Config) Save 

func (c *Config) Save(filePath string) error

Save writes the json-serialized config to the specified path.

func (*Config) String 

func (c *Config) String() string

String returns a pretty-printed json config.

type Datastore 

type Datastore struct {
	// Type is the type of datastore
	Type string
	// Dir is the directory within the config root where the datastore is kept
	Dir string
}

Datastore tracks the configuration of the datastore.

func NewDatastore 

func NewDatastore() Datastore

NewDatastore instantiates a new Datastore config with default values.

func (*Datastore) PopulateDefaults 

func (c *Datastore) PopulateDefaults()

PopulateDefaults replaces zero-values in the config with default values.

type DirectAnnounce 

type DirectAnnounce struct {
	// URLs is a list of indexer URLs to send HTTP announce messages to.
	URLs []string
}

DirectAnnounce configures the target indexers that advertisement announce messages are sent directly to via HTTP.

func NewDirectAnnounce 

func NewDirectAnnounce() DirectAnnounce

NewDirectAnnounce returns DirectAnnounce with values set to their defaults.

func (DirectAnnounce) ParseURLs 

func (d DirectAnnounce) ParseURLs() ([]*url.URL, error)

ParseURLs returns parsed URLs.

type Duration 

type Duration time.Duration

Duration wraps time.Duration to provide json serialization and deserialization.

NOTE: the zero value encodes to an empty string.

func (Duration) MarshalText 

func (d Duration) MarshalText() ([]byte, error)

func (Duration) String 

func (d Duration) String() string

func (*Duration) UnmarshalText 

func (d *Duration) UnmarshalText(text []byte) error

type HttpPublisher 

type HttpPublisher struct {
	// AnnounceMultiaddr is the address supplied in the announce message
	// telling indexers the address to use to retrieve advertisements. If not
	// specified, the ListenMultiaddr is used.
	AnnounceMultiaddr string
	// ListenMultiaddr is the address of the interface to listen for HTTP
	// requests for advertisements.
	ListenMultiaddr string
}

func NewHttpPublisher 

func NewHttpPublisher() HttpPublisher

NewHttpPublisher instantiates a new config with default values.

func (*HttpPublisher) ListenNetAddr 

func (hs *HttpPublisher) ListenNetAddr() (string, error)

type Identity 

type Identity struct {
	PeerID  string
	PrivKey string `json:",omitempty"`
}

Identity tracks the configuration of the local node's identity.

func CreateIdentity 

func CreateIdentity(out io.Writer) (Identity, error)

CreateIdentity initializes a new identity.

func (Identity) DecodeOrCreate 

func (identity Identity) DecodeOrCreate(out io.Writer) (peer.ID, ic.PrivKey, error)

func (Identity) DecodeOrCreatePrivateKey 

func (identity Identity) DecodeOrCreatePrivateKey(out io.Writer, passphrase string) (ic.PrivKey, error)

DecodeOrCreatePrivateKey is a helper to decode the user's PrivateKey. If the key hasn't been provided in json config then it's going to be read from PrivateKeyPathEnvVar. If that file doesn't exist then a new key is going to be generated and saved there.

type Ingest 

type Ingest struct {
	// LinkCacheSize is the maximum number of links that cash can store before
	// LRU eviction.  If a single linked list has more links than the cache can
	// hold, the cache is resized to be able to hold all links.
	LinkCacheSize int
	// LinkedChunkSize is the number of multihashes in each chunk of in the
	// advertised entries linked list.  If multihashes are 128 bytes, then
	// setting LinkedChunkSize = 16384 will result in blocks of about 2Mb when
	// full.
	LinkedChunkSize int
	// PubSubTopic used to advertise ingestion announcements.
	PubSubTopic string
	// PurgeLinkCache tells whether to purge the link cache on daemon startup.
	PurgeLinkCache bool

	// HttpPublisher configures the dagsync httpsync publisher.
	HttpPublisher HttpPublisher

	// PublisherKind specifies which dagsync.Publisher implementation to use.
	PublisherKind PublisherKind

	// SyncPolicy configures which indexers are allowed to sync advertisements
	// with this provider over a data transfer session.
	SyncPolicy Policy
}

Ingest configures settings related to the ingestion protocol.

func NewIngest 

func NewIngest() Ingest

NewIngest instantiates a new Ingest configuration with default values.

func (*Ingest) PopulateDefaults 

func (c *Ingest) PopulateDefaults()

PopulateDefaults replaces zero-values in the config with default values.

type Policy 

type Policy struct {
	// Allow is either false or true, and determines whether a peer is allowed
	// (true) or is blocked (false), by default.
	Allow bool
	// Except is a list of peer IDs that are exceptions to the Allow policy.
	// If Allow is true, then all peers are allowed except those listed in
	// Except. If Allow is false, then no peers are allowed except those listed
	// in Except. in other words, Allow=true means that Except is a deny-list
	// and Allow=false means that Except is an allow-list.
	Except []string
}

Policy configures which indexer peers are allowed and which are blocked.

func NewPolicy 

func NewPolicy() Policy

NewPolicy returns Policy with values set to their defaults.

type ProviderServer 

type ProviderServer struct {
	// ListenMultiaddr is the multiaddr string for the node's listen address
	ListenMultiaddr string
	// RetrievalMultiaddrs are the addresses to advertise for data retrieval.
	// Defaults to the provider's libp2p host listen addresses.
	RetrievalMultiaddrs []string
}

func NewProviderServer 

func NewProviderServer() ProviderServer

NewProviderServer instantiates a new ProviderServer config with default values.

func (*ProviderServer) PopulateDefaults 

func (c *ProviderServer) PopulateDefaults()

PopulateDefaults replaces zero-values in the config with default values.

type PublisherKind 

type PublisherKind string
const (
	DTSyncPublisherKind PublisherKind = "dtsync"
	HttpPublisherKind   PublisherKind = "http"
)

type Reframe 

type Reframe struct {
	ListenMultiaddr string
	ReadTimeout     Duration
	WriteTimeout    Duration
	// CidTtl is a lifetime of a cid after which it is considered expired
	CidTtl Duration
	// ChunkSize is size of a chunk before it gets advertised to an indexer.
	// In other words it's a number of CIDs per advertisement
	ChunkSize int
	// SnapshotSize is the maximum number of records in the Provide payload after which it is considered a snapshot.
	// Snapshots don't have individual timestamps recorded into the datastore. Instead, timestamps are recorded as a binary blob after processing is done.
	SnapshotSize int
	// ProviderID is a Peer ID of the IPFS node that the reframe server is expecting advertisements from
	ProviderID string
	// DsPageSize is a size of the database page that is going to be used on reframe server initialisation.
	DsPageSize int
	// Addrs is a list of multiaddresses of the IPFS node that the reframe server is expecting advertisements from
	Addrs []string
}

Reframe tracks the configuration of reframe serber. If specified, index provider will expose a reframe server that will allow an IPFS node to advertise their CIDs through the delegated routing protocol.

func NewReframe 

func NewReframe() Reframe

NewReframe instantiates a new Reframe config with default values.

func (*Reframe) ListenNetAddr 

func (as *Reframe) ListenNetAddr() (string, error)

func (*Reframe) PopulateDefaults 

func (c *Reframe) PopulateDefaults()

PopulateDefaults replaces zero-values in the config with default values.

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.