# README
go-ipfs-config
Go-ipfs configuration datastructure.
Documentation lives in the go-ipfs repo: docs/config.md.
Table of Contents
Contribute
PRs are welcome!
Small note: If editing the Readme, please conform to the standard-readme specification.
License
MIT © Juan Batiz-Benet
# Packages
No description provided by the author
# Functions
BootstrapPeerStrings formats a list of AddrInfos as a bootstrap peer list suitable for serialization.
CreateIdentity initializes a new identity.
DataStorePath returns the default data store path given a configuration root (set an empty string to have the default configuration root).
DefaultBootstrapPeers returns the (parsed) set of default bootstrap peers.
DefaultDatastoreConfig is an internal function exported to aid in testing.
Filename returns the configuration file path given a configuration root directory.
No description provided by the author
HumanOutput gets a config value ready for printing.
No description provided by the author
No description provided by the author
Marshal configuration with JSON.
ParseBootstrapPeer parses a bootstrap list into a list of AddrInfos.
Path returns the path `extension` relative to the configuration root.
PathRoot returns the default configuration root directory.
No description provided by the author
# Constants
AutoNATServiceDisabled indicates that the user has disabled the AutoNATService.
AutoNATServiceEnabled indicates that the user has enabled the AutoNATService.
AutoNATServiceUnset indicates that the user has not set the AutoNATService mode.
No description provided by the author
DefaultConfigFile is the filename of the configuration file.
DefaultConnMgrGracePeriod is the default value for the connection managers grace period.
DefaultConnMgrHighWater is the default value for the connection managers 'high water' mark.
DefaultConnMgrLowWater is the default value for the connection managers 'low water' mark.
DefaultDataStoreDirectory is the directory to store all the local IPFS data.
No description provided by the author
DefaultPathName is the default config dir name.
DefaultPathRoot is the path to the default config dir location.
No description provided by the author
No description provided by the author
EnvDir is the environment variable used to change the path root.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
DefaultBootstrapAddresses are the hardcoded bootstrap addresses for IPFS.
No description provided by the author
ErrInvalidPeerAddr signals an address is not a valid peer address.
No description provided by the author
Profiles is a map holding configuration transformers.
No description provided by the author
# Structs
Addresses stores the (string) multiaddr addresses for the node.
No description provided by the author
AutoNATConfig configures the node's AutoNAT subsystem.
AutoNATThrottleConfig configures the throttle limites.
Config is used to load ipfs config files.
ConnMgr defines configuration options for the libp2p connection manager.
Datastore tracks the configuration of the datastore.
No description provided by the author
DNS specifies DNS resolution rules using custom resolvers.
No description provided by the author
Gateway contains options for the HTTP gateway server.
No description provided by the author
Identity tracks the configuration of the local node's identity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Migration configures how migrations are downloaded and if the downloads are added to IPFS locally.
Mounts stores the (string) mount points.
OptionalDuration wraps time.Duration to provide json serialization and deserialization.
OptionalInteger represents an integer that has a default value
When encoded in json, Default is encoded as "null".
OptionalString represents a string that has a default value
When encoded in json, Default is encoded as "null".
Peering configures the peering service.
No description provided by the author
No description provided by the author
No description provided by the author
Profile contains the profile transformer the description of the profile.
No description provided by the author
No description provided by the author
No description provided by the author
RelayService configures the resources of the circuit v2 relay.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Routing defines configuration options for libp2p routing.
No description provided by the author
No description provided by the author
# Type aliases
AutoNATServiceMode configures the ipfs node's AutoNAT service.
Flag represents a ternary value: false (-1), default (0), or true (+1).
Priority represents a value with a priority where 0 means "default" and -1 means "disabled".
Strings is a helper type that (un)marshals a single string to/from a single JSON string and a slice of strings to/from a JSON array of strings.
Transformer is a function which takes configuration and applies some filter to it.