docs: add UI screenshots and logging section

This commit is contained in:
Ed Nielsen 2026-03-18 21:00:38 +01:00
parent 2a0053dee5
commit bd9f96f3a9
4 changed files with 111 additions and 66 deletions

View file

@ -1,4 +1,4 @@
# 🖥️ Update Manager - Version: 0.3.0
# 🖥️ Update Manager
Simple CLI tool to check and manage updates across multiple Ubuntu systems over SSH.
@ -26,10 +26,10 @@ Built for Lanx environments lightweight, fast and no unnecessary dependencie
## Features
* Check updates on multiple hosts
* Run checks remotely over SSH
* Run updates remotely over SSH
* Interactive CLI menu (dialog-based UI)
* Centralized logging
* Simple config files
* Built-in logging (file + terminal)
* Dialog-based UI menu
* No agents required
* Works with existing SSH setup
@ -37,12 +37,20 @@ Built for Lanx environments lightweight, fast and no unnecessary dependencie
## Update Manager UI
### Main menu
<p align="center">
<img src="update-manager-ui.png" width="50%" alt="Update Manager CLI UI">
<img src="docs/images/menu-main.png" width="50%" alt="Main menu">
</p>
### Log menu
<p align="center">
<img src="docs/images/menu-logs.png" width="50%" alt="Log menu">
</p>
<p align="center">
<em>Lightweight • Terminal-based • Works over SSH</em>
<em>Lightweight • No dependencies • Works over SSH</em>
</p>
---
@ -54,7 +62,7 @@ git clone https://github.com/YOUR-USER/update-manager.git
cd update-manager
sudo apt update
sudo apt install -y dialog openssh-client
sudo apt install dialog openssh-client
sudo mkdir -p /opt/update-manager
sudo cp update-manager.sh update-manager-ui.sh dialogrc /opt/update-manager/
@ -62,8 +70,8 @@ sudo cp update-manager.sh update-manager-ui.sh dialogrc /opt/update-manager/
sudo chmod +x /opt/update-manager/update-manager.sh
sudo chmod +x /opt/update-manager/update-manager-ui.sh
sudo ln -sf /opt/update-manager/update-manager.sh /usr/local/bin/update-manager
sudo ln -sf /opt/update-manager/update-manager-ui.sh /usr/local/bin/update-manager-ui
sudo ln -s /opt/update-manager/update-manager.sh /usr/local/bin/update-manager
sudo ln -s /opt/update-manager/update-manager-ui.sh /usr/local/bin/update-manager-ui
```
---
@ -134,6 +142,12 @@ server3 192.168.1.30 user
## Usage
### Check updates
```bash
update-manager check
```
### Start UI
```bash
@ -142,42 +156,25 @@ update-manager-ui
---
### Check updates (CLI)
```bash
update-manager check
```
---
## Logging
The tool logs both to terminal and file.
### Primary location
Log file location:
```bash
/opt/update-manager/log/update-manager.log
```
### Fallback location
View log:
```bash
~/update-manager/log/update-manager.log
less /opt/update-manager/log/update-manager.log
```
### Notes
Follow log:
* Log directory is created automatically
* Log file is created automatically
* Output is written to both terminal and file
* Log levels:
* INFO
* WARN
* ERROR
Logs can be viewed directly from the UI.
```bash
tail -f /opt/update-manager/log/update-manager.log
```
---
@ -189,8 +186,8 @@ Logs can be viewed directly from the UI.
├── update-manager-ui.sh
├── update-manager.conf
├── hosts.conf
── log/
└── update-manager.log
── log/
└── update-manager.log
```
---
@ -199,6 +196,7 @@ Logs can be viewed directly from the UI.
* Uses SSH to connect to each host
* Runs `apt` commands remotely
* Logs results locally
* No agents or services needed
* Designed for simple and efficient operations
@ -209,7 +207,6 @@ Logs can be viewed directly from the UI.
* SSH access to all hosts
* SSH keys recommended (no password prompts)
* Ubuntu/Debian-based systems
* `dialog` (for UI)
---
@ -218,7 +215,6 @@ Logs can be viewed directly from the UI.
* 🔔 Notifications (ntfy / push alerts)
* 🌐 Web interface
* 📧 Email reporting
* 📜 Advanced logging / audit trail
* 📊 Basic monitoring (status, last check, pending updates)
* 🧩 Plugin system (extensible modules)
* 🔐 Security & compliance checks