wiki.hemera.network/README.md
2023-09-07 13:57:52 -04:00

17 lines
No EOL
1.1 KiB
Markdown

# Documentation for Hemera Network and Hemera Link
Hemera Network is a private network based on Netmaker to allow users to connect to a subnet behind a NAT.
Devices act either as coordination nodes, hosts, or clients.
- Coordination nodes are available via a public IP and have ports open to the outside world. They handle connecting devices that are behind a NAT.
- Hosts are nodes that are behind a firewall that can act as gateways for their subnet or act as standalone machines that are accessible by other devices on the network.
- Clients are stock wireguard devices and need a coordination node to proxy all data, when connected via wireguard your data enters through a coordination node and exits through a host that has signed up to be an exit node for a given network.
Based on Hugo and the ["Stack"](https://github.com/CaiJimmy/hugo-theme-stack) theme from CaiJimmy on Github.
```
git clone https://git.myco.systems/kleionode/wiki.hemera.network.git
git submodule update --init --recursive
```
**When committing changes add "wiki-hemera/public" to gitignore and generate hugo files on the website host itself.****