docs(config): clarify Ipns.DelegatedPublishers auto behavior
- explain how 'auto' resolution depends on Routing.Type - add command to inspect effective publishers - simplify publishing behavior explanation
Marcin Rataj committed
Aug 27, 2025 at 20:13 UTC
6971f9f5577ea5e802e335bc5452f54e971358ee
1 file changed
+9
-10
docs/config.md
+9
-10
@@ -1646,22 +1646,21 @@ Type: `flag`
1646
1647
### `Ipns.DelegatedPublishers`
1648
1649
-A list of IPNS publishers to delegate publishing operations to. When configured, IPNS publish operations are sent to these remote HTTP services in addition to or instead of local DHT publishing, depending on [`Routing.Type`](#routingtype) configuration.
1649
+HTTP endpoints for delegated IPNS publishing operations. These endpoints must support the [IPNS API](https://specs.ipfs.tech/routing/http-routing-v1/#ipns-api) from the Delegated Routing V1 HTTP specification.
1650
1651
-These endpoints must support the [IPNS API](https://specs.ipfs.tech/routing/http-routing-v1/#ipns-api) from the Delegated Routing V1 HTTP specification.
1652
-
1653
-The special value `"auto"` uses delegated publishers from [AutoConf](#autoconf) when enabled.
1651
+The special value `"auto"` loads delegated publishers from [AutoConf](#autoconf) when enabled.
1652
1653
**Publishing behavior depends on routing configuration:**
1654
1657
-- `Routing.Type=auto` (default): Uses both DHT and HTTP delegated publishers
1658
-- `Routing.Type=delegated`: Uses only HTTP delegated publishers (DHT disabled)
1655
+- `Routing.Type=auto` (default): Uses DHT for publishing, `"auto"` resolves to empty list
1656
+- `Routing.Type=delegated`: Uses HTTP delegated publishers only, `"auto"` resolves to configured endpoints
1657
+
1658
+When using `"auto"`, inspect the effective publishers with: `ipfs config Ipns.DelegatedPublishers --expand-auto`
1659
1660
-**Command flags control publishing method:**
1660
+**Command flags override publishing behavior:**
1661
1662
-- `ipfs name publish /ipfs/QmHash` - Uses configured routing (default behavior)
1663
-- `ipfs name publish --allow-offline /ipfs/QmHash` - Local datastore only, no network requests
1664
-- `ipfs name publish --delegated-only /ipfs/QmHash` - HTTP delegated publishers only, requires configuration
1662
+- `--allow-offline` - Publishes to local datastore without requiring network connectivity
1663
+- `--allow-delegated` - Uses local datastore and HTTP delegated publishers only (no DHT connectivity required)
1664
1665
For self-hosting, you can run your own `/routing/v1/ipns` endpoint using [someguy](https://github.com/ipfs/someguy/).
1666