README.md

🤷 Someguy

Someguy is an HTTP Delegated Routing V1 server that proxies requests to the Amino DHT and other delegated routing servers.

Someguy was the backend of https://delegated-ipfs.dev/routing/v1 until 2026 Q3 (see Maintainer Info).

Build

go build -o someguy

Install

go install github.com/ipfs/someguy@latest

Docker

Automated Docker container releases are available from the Github container registry:

• 🟢 Releases
  • latest always points at the latest stable release
  • vN.N.N point at a specific release tag
• 🟠 Unreleased developer builds
  • main-latest always points at the HEAD of the main branch
  • main-YYYY-DD-MM-GITSHA points at a specific commit from the main branch
• ⚠️ Experimental, unstable builds
  • staging-latest always points at the HEAD of the staging branch
  • staging-YYYY-DD-MM-GITSHA points at a specific commit from the staging branch
  • This tag is used by developers for internal testing, not intended for end users

When using Docker, pass configuration via -e:

$ docker pull ghcr.io/ipfs/someguy:main-latest
$ docker run --rm -it --net=host ghcr.io/ipfs/someguy:main-latest

See /docs/environment-variables.md.

Usage

Run someguy as a client or as a server.

Server

Start the server with someguy start. By default it proxies requests to the IPFS Amino DHT and other Delegated Routing V1 servers.

For more details, run someguy start --help.

Client

To query an existing server without running one yourself, use someguy ask <subcommand> to look up a provider, peer, or IPNS record.

For more details, run someguy ask --help.

AutoConf

Automatic configuration of bootstrap peers and delegated routing endpoints. When enabled (default), Someguy replaces the auto placeholder with network-recommended values fetched from a remote URL.

Configuration:

• --autoconf / SOMEGUY_AUTOCONF
• --autoconf-url / SOMEGUY_AUTOCONF_URL
• --autoconf-refresh / SOMEGUY_AUTOCONF_REFRESH

Endpoint flags (default to auto):

• --provider-endpoints / SOMEGUY_PROVIDER_ENDPOINTS
• --peer-endpoints / SOMEGUY_PEER_ENDPOINTS
• --ipns-endpoints / SOMEGUY_IPNS_ENDPOINTS

To use custom endpoints instead of auto:

someguy start --ipns-endpoints https://example.com

See environment-variables.md for URL formats and configuration details.

Documentation

• environment-variables.md: all config flags and environment variables
• peer-address-caching.md: how /providers and /peers cache and refresh peer addresses, and the trade-offs behind what someguy deliberately does not do
• response-streaming.md: NDJSON streaming contract, the timeout budget, and traps that break streaming
• dnsaddr-resolution.md: why /dnsaddr is resolved before filter-addrs, and how it is bounded
• metrics.md: Prometheus metrics
• tracing.md: OpenTelemetry tracing

Deployment

For self-hosting, run the prebuilt Docker image.

Release

1. Create a PR from branch release-vX.Y.Z against main that:
   1. Updates CHANGELOG.md with entries for the current release
   2. Updates the version.json file
2. Once the release checker creates a draft release, copy-paste the changelog into the draft
3. Merge the PR; the release workflow tags and publishes automatically

Maintainer Info

Important

There is no dedicated maintainer at the moment.

After Protocol Labs nucleation, the Shipyard team maintained this project in 2024, 2025 and 2026. Shipyard's IPFS maintenance work ended with 2026 Q3.

Bring support and transition questions to the community forum.

License

Dual-licensed under MIT + Apache 2.0