Skip to content

Commit 6971f9f

Browse files
committed
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
1 parent 5661dfd commit 6971f9f

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/config.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1646,22 +1646,21 @@ Type: `flag`
16461646

16471647
### `Ipns.DelegatedPublishers`
16481648

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.
16501650

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.
16541652

16551653
**Publishing behavior depends on routing configuration:**
16561654

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`
16591659

1660-
**Command flags control publishing method:**
1660+
**Command flags override publishing behavior:**
16611661

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)
16651664

16661665
For self-hosting, you can run your own `/routing/v1/ipns` endpoint using [someguy](https://github.com/ipfs/someguy/).
16671666

0 commit comments

Comments
 (0)