Skip to content

Commit

Permalink
docs: reference libp2p websockets transport
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Jan 8, 2025
1 parent d1f58e9 commit 8490502
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Let us know if you find any issue or if you want to contribute and add a new tut
## Examples and Tutorials

- [The libp2p 'host'](./libp2p-host)
- [The libp2p 'host' with AutoTLS](./autotls)
- [The libp2p 'host' with Secure WebSockets and AutoTLS](./autotls)
- [Building an http proxy with libp2p](./http-proxy)
- [An echo host](./echo)
- [Routed echo host](./routed-echo/)
Expand Down
4 changes: 2 additions & 2 deletions examples/autotls/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# libp2p host with AutoTLS
# libp2p host with Secure WebSockets and AutoTLS

This example builds on the [libp2p host example](../libp2p-host) example and demonstrates how to use [AutoTLS](https://blog.ipfs.tech/2024-shipyard-improving-ipfs-on-the-web/#autotls-with-libp2p-direct) to automatically generate a wildcard Let's Encrypt TLS certificate unique to the libp2p host (`*.<PeerID>.libp2p.direct`), enabling browsers to directly connect to the libp2p host.
This example builds on the [libp2p host example](../libp2p-host) example and demonstrates how to use [AutoTLS](https://blog.ipfs.tech/2024-shipyard-improving-ipfs-on-the-web/#autotls-with-libp2p-direct) to automatically generate a wildcard Let's Encrypt TLS certificate unique to the libp2p host (`*.<PeerID>.libp2p.direct`), and use it with [libp2p WebSockets transport over TCP](https://github.com/libp2p/specs/blob/master/websockets/README.md) enabling browsers to directly connect to the libp2p host.

For this example to work, you need to have a public IP address and be publicly reachable. AutoTLS is guarded by connectivity check, and will not ask for a certificate unless your libp2p node emits `event.EvtLocalReachabilityChanged` with `network.ReachabilityPublic`.

Expand Down

0 comments on commit 8490502

Please sign in to comment.