Skip to content

environment-variables.md

Latest commit

 

History

History
239 lines (145 loc) · 7.99 KB

environment-variables.md

File metadata and controls

239 lines (145 loc) · 7.99 KB

Someguy Environment Variables

someguy ships with some implicit defaults that can be adjusted via env variables below.

Configuration

SOMEGUY_LISTEN_ADDRESS

The address to listen on.

Default: 127.0.0.1:8190

SOMEGUY_DHT

Controls DHT client mode: standard, accelerated, disabled

Default: accelerated

SOMEGUY_CACHED_ADDR_BOOK

Whether or not the Cached Address Book is enabled or not. If disabled, someguy will not return cached addresses for peers without multiaddrs in FindProviders.

Default: true

SOMEGUY_CACHED_ADDR_BOOK_RECENT_TTL

The TTL for recently connected peers' multiaddrs in the cached address book. Only applies if SOMEGUY_CACHED_ADDR_BOOK is enabled.

Default: 48h

SOMEGUY_CACHED_ADDR_BOOK_ACTIVE_PROBING

Whether or not the Cached Address Book should actively probe peers in cache to keep their multiaddrs up to date. Only applies if SOMEGUY_CACHED_ADDR_BOOK is enabled.

Default: true

SOMEGUY_PROVIDER_ENDPOINTS

Comma-separated list of Delegated Routing V1 endpoints for provider lookups.

Supports two URL formats:

  • Base URL without path: https://example.com
  • Full URL with path: https://example.com/routing/v1/providers

When using the auto placeholder (default), endpoints are automatically configured from the network configuration at SOMEGUY_AUTOCONF_URL.

Default: auto

SOMEGUY_PEER_ENDPOINTS

Comma-separated list of Delegated Routing V1 endpoints for peer routing.

URL formats: same as SOMEGUY_PROVIDER_ENDPOINTS (use /routing/v1/peers path).

Default: auto

SOMEGUY_IPNS_ENDPOINTS

Comma-separated list of Delegated Routing V1 endpoints for IPNS records.

URL formats: same as SOMEGUY_PROVIDER_ENDPOINTS (use /routing/v1/ipns path).

Default: auto

SOMEGUY_AUTOCONF

Enable or disable automatic configuration (autoconf) of delegated routing endpoints and bootstrap peers.

When enabled, the auto placeholder in endpoint configuration is replaced with network-recommended values fetched from the autoconf URL.

Default: true

SOMEGUY_AUTOCONF_URL

URL to fetch autoconf data from. Defaults to the service that provides configuration for IPFS Mainnet.

Default: https://conf.ipfs-mainnet.org/autoconf.json

SOMEGUY_AUTOCONF_REFRESH

How often to refresh the autoconf data. The configuration is cached and updated at this interval.

Default: 24h

SOMEGUY_HTTP_BLOCK_PROVIDER_ENDPOINTS

Comma-separated list of HTTP trustless gateway for probing and generating synthetic provider records.

When the configured gateway responds with HTTP 200 to an HTTP HEAD request for a block (HEAD /ipfs/{cid}?format=raw), FindProviders returns a provider record containing a PeerID from SOMEGUY_HTTP_BLOCK_PROVIDER_PEERIDS and the HTTP gateway endpoint as a multiaddr with /tls/http suffix.

Important

When creating a synthetic /routing/v1 for your gateway, and not a general-purpose routing endpoint, set SOMEGUY_DHT=disabled and SOMEGUY_PROVIDER_ENDPOINTS="" to disable default DHT and HTTP routers and exclusively use the explicitly defined SOMEGUY_HTTP_BLOCK_PROVIDER_ENDPOINTS.

Default: none

SOMEGUY_HTTP_BLOCK_PROVIDER_PEERIDS

Comma-separated list of multibase-encoded peerIDs to use in synthetic provider records returned for HTTP providers in SOMEGUY_HTTP_BLOCK_PROVIDER_ENDPOINTS. The order of PeerIDs must match the order of endpoints.

If no peerIDs are passed but provider endpoints are configured, synthetic PeerIDs will be automatically generated. These are deterministic identifiers derived from SHA256 hashes of the endpoint URLs, used solely for routing system compatibility. Since these providers use HTTP trustless gateway protocol rather than libp2p, the PeerIDs are purely synthetic and never participate in any cryptographic operations or peer authentication.

Default: none

SOMEGUY_LIBP2P_LISTEN_ADDRS

Multiaddresses for libp2p host to listen on (comma-separated).

Default: someguy start --help

SOMEGUY_LIBP2P_CONNMGR_LOW

Minimum number of libp2p connections to keep.

Default: 100

SOMEGUY_LIBP2P_CONNMGR_HIGH

Maximum number of libp2p connections to keep.

Default: 3000

SOMEGUY_LIBP2P_CONNMGR_GRACE_PERIOD

Minimum libp2p connection TTL.

Default: 1m

SOMEGUY_LIBP2P_MAX_MEMORY

Maximum memory to use for libp2p.

Default: 0 (85% of the system's available RAM)

SOMEGUY_LIBP2P_MAX_FD

Maximum number of file descriptors used by libp2p node.

Default: 0 (50% of the process' limit)

Logging

GOLOG_LOG_LEVEL

Specifies the log-level, both globally and on a per-subsystem basis. Level can be one of:

  • debug
  • info
  • warn
  • error
  • dpanic
  • panic
  • fatal

Per-subsystem levels can be specified with subsystem=level. One global level and one or more per-subsystem levels can be specified by separating them with commas.

Default: error

Example:

GOLOG_LOG_LEVEL="error,someguy=debug" someguy

GOLOG_LOG_FMT

Specifies the log message format. It supports the following values:

  • color -- human readable, colorized (ANSI) output
  • nocolor -- human readable, plain-text output.
  • json -- structured JSON.

For example, to log structured JSON (for easier parsing):

export GOLOG_LOG_FMT="json"

The logging format defaults to color when the output is a terminal, and nocolor otherwise.

GOLOG_FILE

Sets the file to which the logs are saved. By default, they are printed to the standard error output.

GOLOG_TRACING_FILE

Sets the file to which the tracing events are sent. By default, tracing is disabled.

Warning: Enabling tracing will likely affect performance.

Tracing

See tracing.md.

SOMEGUY_TRACING_AUTH

Optional, setting to non-empty value enables on-demand tracing per-request.

The ability to pass Traceparent or Tracestate headers is guarded by an Authorization header. The value of the Authorization header should match the value in the SOMEGUY_TRACING_AUTH environment variable.

SOMEGUY_SAMPLING_FRACTION

Optional, set to 0 by default.

The fraction (between 0 and 1) of requests that should be sampled. This is calculated independently of any Traceparent based sampling.