improve readme setup instructions
This commit is contained in:
parent
c5e35d0ea6
commit
47acf83828
40
README.md
40
README.md
@ -6,8 +6,22 @@
|
|||||||
|
|
||||||
## 🐧 Configure Linux-running computer to be managed by Home Assistant.
|
## 🐧 Configure Linux-running computer to be managed by Home Assistant.
|
||||||
|
|
||||||
We need to allow your user to run specific sudo command without asking for password. To do this, we need to edit sudoers
|
### Enable the SSH server
|
||||||
file. To do this, run the following command ``visudo`` in a terminal and append the following the to end of the file :
|
|
||||||
|
Make sure to have a working SSH-server on your computer. I have only tested this integration with OpenSSH but YMMV.
|
||||||
|
|
||||||
|
On most system it can be enabled with the following commands :
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo systemctl enable --now sshd
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configure sudoers
|
||||||
|
|
||||||
|
We need to allow your user account to run specific sudo command without asking for the password so HomeAssistant can run
|
||||||
|
them.
|
||||||
|
To do this, we need to edit sudoers file, run the following command ``visudo`` in a terminal and append the following
|
||||||
|
the to end of the file :
|
||||||
|
|
||||||
```
|
```
|
||||||
# Allow your user user to execute shutdown, init, systemctl, pm-suspend, awk, grub-reboot, and grub2-reboot without a password
|
# Allow your user user to execute shutdown, init, systemctl, pm-suspend, awk, grub-reboot, and grub2-reboot without a password
|
||||||
@ -20,11 +34,25 @@ username ALL=(ALL) NOPASSWD: /sbin/shutdown, /sbin/init, /usr/bin/systemctl, /us
|
|||||||
|
|
||||||
## 🪟 Configure Windows-running computer to be managed by Home Assistant.
|
## 🪟 Configure Windows-running computer to be managed by Home Assistant.
|
||||||
|
|
||||||
First go to "Optional Features" in Windows 10/11, look for "OpenSSH Server" and install it.
|
To install the OpenSSH components:
|
||||||
Then open "Services", find "OpenSSH Server", open "Properties" and set the service to start "Automatically", you can
|
|
||||||
also manually start the service for the first time.
|
|
||||||
|
|
||||||
*Note : It might be necessary to allow port 22 (ssh) in the Windows firewall.*
|
1. Open Settings, select Apps, then select Optional Features.
|
||||||
|
2. Scan the list to see if the OpenSSH is already installed. If not, at the top of the page, select Add a feature,
|
||||||
|
then:
|
||||||
|
Find OpenSSH Client, then select Install (optional)
|
||||||
|
Find OpenSSH Server, then select Install
|
||||||
|
3. Once setup completes, return to Apps and Optional Features and confirm OpenSSH is listed.
|
||||||
|
4. Open the Services desktop app. (Select Start, type services.msc in the search box, and then select the Service app or
|
||||||
|
press ENTER.)
|
||||||
|
5. In the details pane, double-click OpenSSH SSH Server.
|
||||||
|
6. On the General tab, from the Startup type drop-down menu, select Automatic.
|
||||||
|
7. To start the service, select Start.
|
||||||
|
|
||||||
|
*Instructions
|
||||||
|
from [Microsoft](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse)*
|
||||||
|
|
||||||
|
*Note : It might be necessary to allow port 22 (ssh) in the Windows firewall altough it should be done automatically if
|
||||||
|
following the instructions from above.*
|
||||||
|
|
||||||
## 🖧 Configure dual-boot (Windows/Linux) computer to be managed by Home Assistant.
|
## 🖧 Configure dual-boot (Windows/Linux) computer to be managed by Home Assistant.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user