coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-25 20:37:53 +08:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity

docs: apply suggestions from code review

Browse Source 
Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>
This commit is contained in:
Marcin Rataj 2024-10-28 18:24:27 +01:00 committed by GitHub
parent 21b5c8898b
commit 7eeda1bb6f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/config.md
View File

@ -1724,9 +1724,11 @@ Type: `flag`
### `Swarm.ForgeClient`
Configuration options for optional [p2p-forge] client that provides Kubo with DNS+TLS+WebSockets multiaddrs that allow for direct connections from JS running in web browsers.
AutoTLS enables publicly reachable Kubo nodes, i.e. nodes dialable from the public internet, to get a wildcard TLS certificate unique to their PeerID at `*.[PeerID].libp2p.direct` without needing to register and configure a domain name. This enables direct libp2p connections and direct retrieval of IPFS content from browsers using Secure WebSockets.
The default settings use instance at `libp2p.direct` and TLS certificates from Let's Encrypt.
Under the hood, the `libp2p.direct` acts as a an [ACME DNS-01 Challenge](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge) broker for getting wildcard TLS certificate for `*.[PeerID].libp2p.direct`.
By default, AutoTLS requests TLS certificates from Let's Encrypt and uses a `libp2p.direct` subdomain.
Origin and rationale for this project can be found in [community.letsencrypt.org discussion].
In short, [p2p-forge] provides a publicly diallable Kubo with a domain name for their PeerID (`peerid.libp2p.direct`),