CRXN/docs
1
0
Fork 0
mirror of http://deavmi.assigned.network/git/CRXN/docs synced 2025-02-16 12:56:54 +00:00
Code Releases Activity

add some docs improvments

Browse Source 
Signed-off-by: Marek Küthe <m.k@mk16.de>
This commit is contained in:
Marek Küthe 2023-01-04 18:21:22 +01:00
parent b66d10be53
commit 64a3e719ec
No known key found for this signature in database
GPG Key ID: 7E869146699108C7
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/tunneling/fastd.md
View File

@ -44,9 +44,9 @@ forward no;
# Setup a peer to allow incoming connections from or initiate a connection too
peer "<peerName>"
{
remote <type> "<ip>" port <port>;
remote <type> "<hostname>" port <port>;
key "<peer's public key>";
interface "$INTERFACE";
interface "%n";
}
```
@ -86,10 +86,10 @@ Now we need to fill in the peer details of the node you are connecting to:
1. `"<peerName>"`
* Sets the interface name of the connection with the peer to crxn`<peerName>`
2. `<type>`
* Set this to either `ipv4` or `ipv6` depending of the address being used to connect to the remote peer
3. `"<ip>"`
* Set this to either `ipv4` or `ipv6` depending of the address being used to connect to the remote peer. This parameter is optional and can be omitted.
3. `"<hostname>"`
* Set this to the remote peer's fastd address
4. `"port`
4. `"<port>`
* Set this to the remote peer's fastd port
5. `"<peer's public key>"`
* Set this to your peer's public key
@ -99,6 +99,14 @@ Now we need to fill in the peer details of the node you are connecting to:
The last thing to configure now is to rise the interface up when fastd starts (as it normally doesn't rise it for you), all occurences of `<interfaceName>` here should match the one in the `interface <interfaceName>;` declaration as shown earlier.
### Modes
Fastd can provide a tunnel with `multitap` mode on layer 2 or a tunnel with `tun` mode on layer 3. Note that the fatsd has 20 bytes less overhead when using tun.
### A peer is not publicly reachable
### Starting and maintaining the daemon
You can then start the daemon as follows: