From 46d6dba8594c97cf2d5cab3386bc7691bb0af8e7 Mon Sep 17 00:00:00 2001 From: cogneato Date: Mon, 2 Jul 2018 23:32:44 -0600 Subject: [PATCH] Update configuration.md (#50) * Update configuration.md Clearing up documentation, grammar fixes. * changed known_hosts to authorized_keys * Update configuration.md --- Documentation/configuration.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/Documentation/configuration.md b/Documentation/configuration.md index 488d9755e..4c2161479 100644 --- a/Documentation/configuration.md +++ b/Documentation/configuration.md @@ -2,21 +2,22 @@ ## Automatic -You can format a USB stick with FAT32/EXT4 and name it with `CONFIG`. The layout could be look like: +You can use a USB drive with HassOS to configure network options, ssh access to the host, and to install updates. +Format a USB stick with FAT32/EXT4/NTFS and name it `CONFIG`. Use the following directory structure within the USB drive: + ``` network/ modules/ authorized_keys hassos-xy.raucb -``` -- On `network` folder can hold any kind of NetworkManager connections files. -- The folder `modules` is for modules-load configuration files. -- `authorized_keys` file activate debug SSH access of port `22222`. -- For firmware updates you can but the `hassos-*.raucb` OTA update they should be install. +- The `network` folder can contain any kind of NetworkManager connection files. For more information see [Network][network.md]. +- The `modules` folder is for modules-load configuration files. +- The `authorized_keys` file activates debug SSH access on port `22222`. See [Debugging Hassio][debug-hassio]. +- The `hassos-*.raucb` file is a firmware OTA update which will be installed. These can be found on on the [release][hassos-release] page. -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. +You can put this USB stick into the device and it will be read on startup. You can also trigger this process later over the +API/UI or by calling `systemctl restart hassos-config` on the host. ## Local @@ -33,3 +34,6 @@ The kernel module folder `/etc/modules-load.d` is persistent and you can add you You can manual add, edit or remove connections configs from `/etc/NetworkManager/system-connections`. [systemd-modules]: https://www.freedesktop.org/software/systemd/man/modules-load.d.html +[network.md]: network.md +[hassos-release]: https://github.com/home-assistant/hassos/releases/ +[debug-hassio]: https://developers.home-assistant.io/docs/en/hassio_debugging.html