From d3e3e36a6e663113e5ff4d2312a60b78cd1fbf4b Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Tue, 26 Jun 2018 22:24:15 +0200 Subject: [PATCH] Improve the documentation (#44) * Create network.md * Update configuration.md * Update network.md * Update network.md --- Documentation/configuration.md | 5 ++- Documentation/network.md | 58 ++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 Documentation/network.md diff --git a/Documentation/configuration.md b/Documentation/configuration.md index 7af004b42..b3a9eb0b7 100644 --- a/Documentation/configuration.md +++ b/Documentation/configuration.md @@ -13,7 +13,10 @@ hassos-xy.raucb - On `network` folder can hold any kind of NetworkManager connections files. - The folder `modules` is for modules-load configuration files. - `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. +- 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 diff --git a/Documentation/network.md b/Documentation/network.md new file mode 100644 index 000000000..1ce6cebe5 --- /dev/null +++ b/Documentation/network.md @@ -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