Skip to content

Commit 7565ebd

Browse files
committed
start filling out deployment section
1 parent b050485 commit 7565ebd

File tree

4 files changed

+60
-6
lines changed

4 files changed

+60
-6
lines changed

deployment/iroh-doctor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "iroh doctor"
2+
title: "Troubleshooting"
33
---
44

55
[iroh doctor](https://github.com/n0-computer/iroh-doctor) is a command-line tool that helps you diagnose network connectivity issues with your iroh setup.

deployment/managing-relays.mdx

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
---
2-
title: "Managing Relays"
2+
title: "Custom Relays"
33
---
44

5-
Placeholder: Deploying and running relays at scale, configuration and tips.
5+
By default, iroh will use public shared relays to facilitate connections over
6+
DNS. These relays handle both forwarding traffic when direct peer-to-peer
7+
connections are not possible as well as facilitate holepunching for direct
8+
connections. These relays are managed and maintained by the n0des team, and are
9+
shared by a global public network of developers.
10+
11+
By default, all iroh endpoints will use the public cloud relays unless you
12+
purchase a managed relay or deploy your own self-hosted relay.
13+
14+
## Self-Hosted and Managed Relays
15+
16+
If you require more control over your relay infrastructure, you can choose to
17+
[self-host your own relay](https://github.com/n0-computer/iroh/tree/main/iroh-relay) or [upgrade to a managed relay service](https://n0des.iroh.computer). This allows you
18+
to have full control over the relay servers, including their configuration,
19+
security settings, and access controls.
20+
21+
[Sign up for a free trial of n0des](https://n0des.iroh.computer) to get access
22+
to purchase a managed relay with uptime SLAs.

deployment/security-privacy.mdx

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,41 @@
22
title: "Security & Privacy"
33
---
44

5-
Placeholder: Security considerations, threat model, and privacy guidance.
5+
iroh is designed with security and privacy as core principles. This document
6+
outlines the key security and privacy features of iroh, as well as best
7+
practices for deploying and using iroh in a secure manner.
8+
9+
## End-to-End Encryption
10+
11+
All data transmitted between iroh endpoints is protected with end-to-end
12+
encryption. This means that data is encrypted on the sender's device and can only
13+
be decrypted by the intended recipient. Even relay servers that facilitate
14+
connections between endpoints cannot read the data being transmitted.
15+
16+
End-to-end encryption is achieved using modern cryptographic algorithms and protocols,
17+
ensuring that data remains confidential and secure during transit. By defaul;t,
18+
iroh uses Ed25519 keys for endpoint identities and encryption. If you require
19+
different cryptographic algorithms, you can configure iroh to use them during
20+
endpoint creation.
21+
22+
[Contact us for assistance](https://n0.computer/) with custom cryptographic configurations.
23+
24+
## Public Relays
25+
26+
All traffic sent through the public relays is end-to-end encrypted. The relays
27+
are not able to read any of the traffic that they forward or help connect.
28+
However, the relays are able to see metadata about connections, such as source
29+
and destination IP addresses, connection times, and the amount of data
30+
transferred.
31+
32+
We recommend that you do not use the public relays for sensitive or confidential
33+
data. If you need more control over your relay infrastructure, we recommend that
34+
you upgrade to a managed relay or self-host your own relay.
35+
36+
We monitor the public relays for abuse and malicious activity. If we detect
37+
abuse, we reserve the right to block offending IP addresses or users from
38+
accessing the public relays.
39+
40+
To learn more about deploying and managing your own relays, see the
41+
[n0des](//managing-relays) documentation.
42+

protocols/automerge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ eventually converging to the same state on every replica.
1010

1111
## Example
1212

13-
This example highlights how to integrate [automerge's sync protocol] with
14-
[iroh's peer-to-peer connectivity].
13+
This example highlights how to integrate [automerge's sync protocol](https://automerge.org/docs/hello/) with
14+
[iroh's peer-to-peer connectivity](/concepts/discovery).
1515

1616

1717
```bash

0 commit comments

Comments
 (0)