Skip to content

Commit 9142973

Browse files
committed
Add FAQ page
1 parent 515ee0f commit 9142973

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/faq.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# FAQ
2+
3+
## Do I Need To Configure IANA IPs?
4+
5+
No, IANA IPs are optional!
6+
7+
IANA IPs are just useful so that other Mycoria routers can connect to your router via the Internet. This also enables other routers to automatically optimize the network by connecting directly to your router if there is a lot of demand.
8+
9+
10+
11+
## How Can I Use Mycoria Privately?
12+
13+
If you're not interested in connecting to other parties within Mycoria, you can keep your device to themselves by adding them as `friends:` and setting `isolate: true`, as well as adding `friends: true` to all your defined services.
14+
15+
Config excerpt:
16+
17+
``` yaml
18+
router:
19+
isolate: true
20+
21+
services:
22+
- name: ping
23+
url: 'icmp6:'
24+
friends: true
25+
26+
friends:
27+
- name: alice
28+
ip: fd1f:2cd5:6feb:7aa7:d674:1b3c:c82c:dfc
29+
```
30+
31+
This way, you can still use the global Mycoria network for routing, connectivity and relaying your own traffic, but you do not send any traffic to any other Mycoria routers, and do not allow any other routers to access your defined services.
32+
33+
See the [configuration reference](/configure) for more details.
34+
35+
36+
37+
## Can I Run a Separate Mycoria Network?
38+
39+
If you do not want to connect to any other Mycoria router whatsoever, you can do so by creating your own universe:
40+
41+
``` yaml
42+
router:
43+
universe: my private network
44+
universeSecret: correct horse battery stable
45+
```
46+
47+
See the [configuration reference](/configure) for more details.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ nav:
1515
- Quick Start: quick-start.md
1616
- Install: install.md
1717
- Configure: configure.md
18+
- FAQ: faq.md
1819
- About: about.md
1920

2021
theme:

0 commit comments

Comments
 (0)