Added logging for updates. Updated documentation.

This commit is contained in:
Storm Dragon
2025-10-11 13:17:01 -04:00
parent 3a74cb5cdc
commit 6509c5575f
2 changed files with 162 additions and 7 deletions
+98
View File
@@ -0,0 +1,98 @@
# System Updates
## Overview
The Stormux Gaming Image includes a system update feature that keeps your system current with the latest packages and configuration files. Updates are performed through the main menu system and require minimal user interaction.
## How to Update
1. Open the Game Launcher (automatically starts on boot)
2. Navigate to the "System" menu (from initial load of the image, press left once)
3. Select "System Update"
4. Enter your username and password when prompted (only required when credentials change on the server username is always patron)
5. The update process will run automatically
6. Review the update summary when complete
7. Press Enter to return to the menu
## What Gets Updated
The system update performs two main operations:
### 1. Package Updates
- Updates all installed system packages using pacman
- Includes kernel updates, applications, and libraries
- Runs non-interactively with automatic confirmations
### 2. Configuration File Sync
- Downloads the latest custom image files and deploys them
- Updates system configuration files
- Refreshes user utilities and applications
- Updates documentation and resources
- Preserves user data and settings
## Update Logs
All update operations are logged for troubleshooting and review:
**Log Location**: `~/Logs/system-updates.log`
The log file contains:
- Timestamp for each update session
- Complete output from package updates
- Git operations (clone, checkout, LFS pull)
- File copy operations
- Error messages if any operations fail
- Success/failure summary
## Understanding the Summary
At the end of each update, you'll see one of two messages:
### Successful Update
```
SUCCESS: All update operations completed successfully.
```
### Failed Update
```
ERRORS DETECTED: 2 error(s) occurred during update:
- Package update failed
- Git clone failed
```
If errors are detected, review the log file for detailed information about what went wrong.
## Common Issues
### Authentication Required
If the server credentials have changed, you'll be prompted for your username and password. This is normal and only happens when credentials are updated on the server.
### Network Issues
Updates require an internet connection. If git clone or package updates fail, verify your network connection and try again.
### Insufficient Disk Space
Package updates require free disk space. If updates fail, check available space.
## Update Frequency
## Safety Features
- Updates are logged for troubleshooting
- User files and settings are preserved
- File ownership is automatically corrected
- Screen reader remains active throughout the process
- Summary shows if any operations failed
## Getting Help
If you experience persistent update issues:
1. Review the log file at `~/Logs/system-updates.log`
2. Contact Stormux with your log file (email address storm_dragon@stormux.org)
## Notes
- The script runs with root privileges to update system files
- Your personal data in ~/Music, ~/Roms, and other user directories is never modified
- Configuration files like .w3m and .irssi are excluded from updates to preserve your settings
- Updates can take several minutes depending on internet speed and the number of packages