Expand description
Configuration types for ferripfs, ported from Kubo’s config package.
Structs§
- Addresses
- Addresses configuration section
- Api
- API configuration section
- Auto
NatConfig - AutoNAT configuration
- Auto
NatThrottle - AutoNAT throttle settings
- Config
- Main configuration struct, matching Kubo’s Config
- ConnMgr
- Connection manager configuration
- Datastore
- Datastore configuration section
- DhtRouter
Params - DHT router parameters
- Discovery
- Discovery configuration
- DnsConfig
- DNS configuration
- Experiments
- Experimental features
- Gateway
- Gateway configuration section
- Gateway
Spec - Gateway specification for public gateways
- Http
Router Params - HTTP router parameters
- Identity
- Identity configuration section
- Import
- Import configuration
- Internal
- Internal settings
- Internal
Bitswap - Internal bitswap settings
- Ipns
- IPNS configuration
- Mdns
- mDNS discovery settings
- Method
Config - Method routing configuration
- MfsPin
Policy - MFS pin policy
- Migration
- Migration settings
- Mounts
- Mount points configuration
- Multiplexer
Transports - Multiplexer transport configuration
- Network
Transports - Network transport configuration
- Optional
Bytes - Optional bytes size, stored as a string like “10GB”, “1MB”
- Optional
Duration - Optional duration, stored as a string like “1h”, “30m”, “10s”
- Optional
Integer - Optional integer
- Optional
String - Optional string
- Peering
- Peering configuration
- Peering
Peer - A peer in the peering list
- Pinning
- Pinning configuration
- Pubsub
Config - Pubsub configuration
- Relay
Client - Relay client configuration
- Relay
Service - Relay service configuration
- Remote
Pinning Api - Remote pinning API settings
- Remote
Pinning Policies - Remote pinning policies
- Remote
Pinning Service - Remote pinning service configuration
- Resource
Mgr - Resource manager configuration
- Router
Config - Router configuration
- Routing
- Routing configuration section
- RpcAuth
Scope - RPC authentication scope
- Security
Transports - Security transport configuration
- Strings
- Flexible string type that accepts both a single string and array of strings
- Swarm
Config - Swarm configuration section
- Transports
- Transport configuration
Enums§
- Config
Error - Configuration error type
- DhtMode
- DHT mode
- Flag
- Ternary flag: can be true, false, or default (null/missing)
- Priority
- Priority with default (null) and disabled (false) states
- Profile
- Available configuration profiles
- Router
Type - Router types
Constants§
- DEFAULT_
BLOCKS_ DIRECTORY - Default blocks directory name
- DEFAULT_
CONFIG_ FILE - Default config file name
- DEFAULT_
DATASTORE_ DIRECTORY - Default datastore directory name
- DEFAULT_
GC_ PERIOD - Default GC period
- DEFAULT_
PATH_ NAME - Default IPFS path name
- DEFAULT_
PATH_ ROOT - Default IPFS path root
- DEFAULT_
ROUTING_ TYPE - Default routing type
- DEFAULT_
STORAGE_ GC_ WATERMARK - Default GC watermark (percentage)
- DEFAULT_
STORAGE_ MAX - Default storage maximum
- ENV_DIR
- Environment variable for IPFS path
Functions§
- list_
profiles - List all available profiles