|
1 | 1 | --- |
2 | 2 | title: "What is iroh?" |
3 | 3 | --- |
| 4 | + |
| 5 | +iroh is a modular peer-to-peer networking stack written in Rust. It provides |
| 6 | +the building blocks to create decentralized applications that can communicate |
| 7 | +securely and efficiently over the internet. |
| 8 | + |
| 9 | +## Core features |
| 10 | +- **Peer-to-peer connectivity**: iroh enables direct connections between |
| 11 | + devices, allowing them to communicate without relying on centralized servers. |
| 12 | + It uses relay servers as a fallback when direct connections are not possible. |
| 13 | +- **Secure communication**: All connections established through iroh are |
| 14 | + authenticated and encrypted end-to-end using the QUIC protocol, ensuring data |
| 15 | + privacy and integrity. |
| 16 | +- **Modular protocols**: iroh is built around a system of composable protocols |
| 17 | + that can be mixed and matched to suit the needs of different applications. This |
| 18 | + allows developers to easily add functionality such as file sharing, messaging, |
| 19 | + and real-time collaboration. |
| 20 | + |
| 21 | +## Use cases |
| 22 | +- **Decentralized applications**: iroh provides the networking foundation for |
| 23 | + building decentralized applications that can operate without central servers. |
| 24 | +- **File sharing**: With protocols like iroh-blobs, iroh enables efficient |
| 25 | + peer-to-peer file sharing. |
| 26 | +- **Real-time collaboration**: iroh's support for flexible data protocols allows |
| 27 | +developers to build applications that support real-time collaborative editing |
| 28 | +and data synchronization. Any kind of CRDT or OT sync protocol can be integrated. |
| 29 | + |
| 30 | +## Getting started |
| 31 | +To get started with iroh, check out the [quickstart guide](/quickstart) or explore the |
| 32 | +[protocols documentation](/protocols) to see what protocols are available and |
| 33 | +how to use them in your applications. |
| 34 | + |
| 35 | +Read the [how it works documentation](/concepts) to understand the underlying |
| 36 | +principles and architecture of iroh. |
0 commit comments