docs: rewrite README with structured overview and quick start guide
Replaces the minimal project description with a comprehensive README including a component overview table, quick start instructions, common Ansible operations, and links to detailed documentation. Aligns with Red Panda Approval™ standards.
This commit is contained in:
38
docs/xrdp.md
Normal file
38
docs/xrdp.md
Normal file
@@ -0,0 +1,38 @@
|
||||
Purpose
|
||||
This script automates the installation and configuration of xRDP (X Remote Desktop Protocol) on Ubuntu-based systems, providing a complete remote desktop solution with enhanced user experience.
|
||||
|
||||
Key Features
|
||||
Multi-Distribution Support:
|
||||
Ubuntu 22.04, 24.04, 24.10, 25.04
|
||||
Linux Mint, Pop!OS, Zorin OS, Elementary OS
|
||||
Debian support (best effort)
|
||||
LMDE (Linux Mint Debian Edition)
|
||||
|
||||
Installation Modes:
|
||||
Standard installation (from repositories)
|
||||
Custom installation (compile from source)
|
||||
Removal/cleanup option
|
||||
|
||||
Advanced Capabilities:
|
||||
Sound redirection - Compiles audio modules for remote audio playback
|
||||
H.264 encoding/decoding support (latest version)
|
||||
Desktop environment detection - Handles GNOME, KDE, Budgie, etc.
|
||||
Sound server detection - Works with both PulseAudio and PipeWire
|
||||
Custom login screen - Branded xRDP login with custom colors/backgrounds
|
||||
|
||||
Smart Features:
|
||||
SSH session detection - Warns when installing over SSH
|
||||
Version compatibility checks - Prevents incompatible installations
|
||||
Conflict resolution - Disables conflicting GNOME remote desktop services
|
||||
Permission fixes - Handles SSL certificates and user groups
|
||||
Polkit rules - Enables proper shutdown/reboot from remote sessions
|
||||
|
||||
What Makes It Special
|
||||
Extensive OS/version support with graceful handling of EOL versions
|
||||
Intelligent detection of desktop environments and sound systems
|
||||
Post-installation optimization for better remote desktop experience
|
||||
Comprehensive error handling and user feedback
|
||||
Modular design with separate functions for different tasks
|
||||
Active maintenance - regularly updated with new Ubuntu releases
|
||||
|
||||
The script essentially transforms a basic Ubuntu system into a fully-functional remote desktop server with professional-grade features, handling all the complex configuration that would normally require manual intervention.
|
||||
Reference in New Issue
Block a user