kubo/docs/environment-variables.md

go-ipfs environment variables

LIBP2P_TCP_REUSEPORT

go-ipfs tries to reuse the same source port for all connections to improve NAT traversal. If this is an issue, you can disable it by setting LIBP2P_TCP_REUSEPORT to false.

Default: true

IPFS_PATH

Sets the location of the IPFS repo (where the config, blocks, etc. are stored).

Default: ~/.ipfs

IPFS_LOGGING

Sets the log level for go-ipfs. It can be set to one of:

• CRITICAL
• ERROR
• WARNING
• NOTICE
• INFO
• DEBUG

Logging can also be configured (on a subsystem by subsystem basis) at runtime with the ipfs log command.

Default: ERROR

IPFS_LOGGING_FMT

Sets the log message format. Can be one of:

• color
• nocolor

Default: color

GOLOG_FILE

Sets the file to which go-ipfs logs. By default, go-ipfs logs to standard error.

GOLOG_TRACING_FILE

Sets the file to which go-ipfs sends tracing events. By default, tracing is disabled.

This log can be read at runtime (without writing it to a file) using the ipfs log tail command.

Warning: Enabling tracing will likely affect performance.

IPFS_FUSE_DEBUG

Enables fuse debug logging.

Default: false

YAMUX_DEBUG

Enables debug logging for the yamux stream muxer.

Default: false

IPFS_FD_MAX

Sets the file descriptor limit for go-ipfs. If go-ipfs fails to set the file descriptor limit, it will log an error.

Defaults: 2048

IPFS_DIST_PATH

IPFS Content Path from which go-ipfs fetches repo migrations (when the daemon is launched with the --migrate flag).

Default: /ipfs/<cid> (the exact path is hardcoded in migrations.CurrentIpfsDist, depends on the IPFS version)

IPFS_NS_MAP

Adds static namesys records for deterministic tests and debugging. Useful for testing things like DNSLink without real DNS lookup.

Example:

$ IPFS_NS_MAP="dnslink-test1.example.com:/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am,dnslink-test2.example.com:/ipns/dnslink-test1.example.com" ipfs daemon
...
$ ipfs resolve -r /ipns/dnslink-test2.example.com
/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am

LIBP2P_MUX_PREFS

Deprecated: Use the Swarm.Transports.Multiplexers config field.

Tells go-ipfs which multiplexers to use in which order.

Default: "/yamux/1.0.0 /mplex/6.7.0"

Tracing

NOTE Tracing support is experimental--releases may contain tracing-related breaking changes.

IPFS_TRACING

Enables OpenTelemetry tracing.

Default: false

IPFS_TRACING_JAEGER

Enables the Jaeger exporter for OpenTelemetry.

For additional Jaeger exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#jaeger-exporter

Default: false

How to use Jaeger UI

One can use the jaegertracing/all-in-one Docker image to run a full Jaeger stack and configure go-ipfs to publish traces to it (here, in an ephemeral container):

$ docker run --rm -it --name jaeger \
    -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
    -p 5775:5775/udp \
    -p 6831:6831/udp \
    -p 6832:6832/udp \
    -p 5778:5778 \
    -p 16686:16686 \
    -p 14268:14268 \
    -p 14250:14250 \
    -p 9411:9411 \
    jaegertracing/all-in-one

Then, in other terminal, start go-ipfs with Jaeger tracing enabled:

$ IPFS_TRACING=1 IPFS_TRACING_JAEGER=1 ipfs daemon

Finally, the Jaeger UI is available at http://localhost:16686

IPFS_TRACING_OTLP_HTTP

Enables the OTLP HTTP exporter for OpenTelemetry.

For additional exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md

Default: false

IPFS_TRACING_OTLP_GRPC

Enables the OTLP gRPC exporter for OpenTelemetry.

For additional exporter configuration, see: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md

Default: false

IPFS_TRACING_FILE

Enables the file exporter for OpenTelemetry, writing traces to the given file in JSON format.

Example: "/var/log/ipfs-traces.json"

Default: "" (disabled)

IPFS_TRACING_RATIO

The ratio of traces to export, as a floating point value in the interval [0, 1].

Deault: 1.0 (export all traces)