coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: add IPLD Logical Format note to AllowCodecConversion

Browse Source
This commit is contained in:
Marcin Rataj 2026-02-06 01:37:41 +01:00
parent beabc9ecd1
commit fcb3c236db
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/config.md
View File

@ -1152,9 +1152,13 @@ When disabled (the default), the gateway returns `406 Not Acceptable` for
codec mismatches, following behavior specified in
[IPIP-524](https://github.com/ipfs/specs/pull/524).
**Recommended approach**: Instead of relying on gateway-side conversion,
fetch the raw block using `?format=raw` (`application/vnd.ipld.raw`) and
perform conversion client-side. This approach:
Most users should keep this disabled unless legacy
[IPLD Logical Format](https://web.archive.org/web/20260204204727/https://ipld.io/specs/codecs/dag-pb/spec/#logical-format)
support is needed as a stop-gap while switching clients to `?format=raw`
and converting client-side.
Instead of relying on gateway-side conversion, fetch the raw block using
`?format=raw` (`application/vnd.ipld.raw`) and convert client-side. This:
- Allows clients to use any codec without waiting for gateway support
- Enables ecosystem innovation without gateway operator coordination