diff --git a/README.md b/README.md index 6aee1af..2b3f777 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Built for Lanx environments – lightweight, fast and no unnecessary dependencie * [Features](#features) * [Update Manager UI](#update-manager-ui) * [Quick Install](#quick-install) +* [SSH Setup](#ssh-setup-required) * [Configuration](#configuration) * [Usage](#usage) * [File Structure](#file-structure) @@ -58,6 +59,42 @@ sudo ln -s /opt/update-manager/update-manager.sh /usr/local/bin/update-manager --- +## SSH Setup (Required) + +Update Manager uses SSH to connect to your hosts. + +You must have SSH key-based authentication set up (no password prompts). + +### Generate SSH key (if not already done) + +```bash +ssh-keygen -t ed25519 +``` + +--- + +### Copy key to hosts + +```bash +ssh-copy-id user@192.168.1.10 +ssh-copy-id user@192.168.1.20 +ssh-copy-id user@192.168.1.30 +``` + +--- + +### Test connection + +```bash +ssh user@192.168.1.10 +``` + +You should be able to connect **without entering a password**. + +> ⚠️ If SSH is not configured, the tool will fail or hang during execution. + +--- + ## Configuration ### Copy config files @@ -132,14 +169,14 @@ update-manager update ## Future ideas -- Notifications (ntfy / push alerts) -- Web interface -- Email reporting -- Logging and audit trail -- Basic monitoring (status, last check, pending updates) -- Plugin system (extensible modules) -- Security & compliance checks -- AI integration (Lanx AI) +* 🔔 Notifications (ntfy / push alerts) +* 🌐 Web interface +* 📧 Email reporting +* 📜 Logging and audit trail +* 📊 Basic monitoring (status, last check, pending updates) +* 🧩 Plugin system (extensible modules) +* 🔐 Security & compliance checks +* 🤖 AI integration (Lanx AI) --- @@ -148,4 +185,3 @@ update-manager update This project is licensed under the GNU GPL v3 License. See the LICENSE file for full details. -