Improve the documentation (#44)

* Create network.md

* Update configuration.md

* Update network.md

* Update network.md
This commit is contained in:
Pascal Vizeli 2018-06-26 22:24:15 +02:00 committed by GitHub
parent af23b6199e
commit d3e3e36a6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 62 additions and 1 deletions

View File

@ -15,6 +15,9 @@ hassos-xy.raucb
- `known_hosts` file activate debug SSH access of port `22222`.
- For firmware updates you can but the `hassos-*.raucb` OTA update they should be install.
You can put this USB stick into device and they will be read on startup. You can also trigger this process later over the
API/UI or call `systemctl restart hassos-config` on host.
## Local
### Bootargs

58
Documentation/network.md Normal file
View File

@ -0,0 +1,58 @@
# Network
HassOS use NetworkManager to control the host network. You can setup the network configuartion in future over the API/UI.
Actual we support only manual configuration with NetworkManager connection files. Without a configuration, we run default as
DHCP device.
## Configuration Examples
You can look also into [Official Manual][keyfile] or there are a lot of examples accross internet.
### LAN
```ini
[connection]
id=hassos-network
type=ethernet
[ipv4]
method=auto
[ipv6]
addr-gen-mode=stable-privacy
method=auto
```
### Wireless WPA/PSK
```ini
[connection]
id=hassos-network
type=wifi
[wifi]
mode=infrastructure
ssid=MY_SSID
[wifi-security]
auth-alg=open
key-mgmt=wpa-psk
psk=MY_WLAN_SECRED_KEY
[ipv4]
method=auto
[ipv6]
addr-gen-mode=stable-privacy
method=auto
```
### Static IP
Replace follow configs:
```ini
[ipv4]
method=manual
address1=192.168.1.111/24,192.168.1.1
dns=8.8.8.8;8.8.4.4;
```
[keyfile]: https://developer.gnome.org/NetworkManager/stable/nm-settings.html