Version 3.1.0 - The complete automated installation toolkit for XOVI extension framework and AppLoader on reMarkable devices.
- Bug Fix: Completely replaced broken
install-xovi-for-rmwith manual XOVI setup - 100% Offline Installation: No on-device downloads required - works on isolated devices
- DNS-Independent: Eliminates DNS resolution failures that caused installation failures
- Bulletproof Setup: Manual XOVI directory structure creation with all required scripts
- Enhanced Progress: Real-time hashtable rebuild progress output
- USB Ethernet Safe: Proper handling of USB gadget drivers during installation
- WiFi Setup Guidance: Comprehensive WiFi backup connection setup before installation
- Installation Safety: Smart WiFi backup + USB ethernet stability for bulletproof installs
- User Education: Clear step-by-step guidance for optimal installation experience
- Improved User Flow: WiFi setup instructions integrated into all installation options
- USB Ethernet Fix: Automatic repair service for missing USB ethernet adapters
- Enhanced Connection Handling: Improved retry logic with forced credential re-entry
- Streamlined Installation: Removed WiFi blocking functionality for better user experience
- Menu Improvements: Added ethernet fix option and better status checking
- Stability Improvements: Non-blocking status checks prevent menu hanging
- Full reMarkable 1 Support: Now supports both rM1 and rM2 devices
- Smart Stage Detection: Automatically detects interrupted installations and offers seamless continuation
- Uninstall Without Backup: Added safe removal option when backups aren't available
- Enhanced Error Handling: Improved menu stability and crash prevention
- Automatic Timing: Built-in 30-second wait after Stage 1 for optimal device reboot
- Future Ready: rMPP (reMarkable Paper Pro) support coming soon
| Device | Status | Architecture |
|---|---|---|
| reMarkable 1 | Fully Supported | armv6l |
| reMarkable 2 | Fully Supported | armv7l |
| reMarkable Paper Pro (rMPP) | Coming Soon | - |
- XOVI Extension Framework: Complete installation with automatic dependency management
- AppLoader: Powerful application launcher for reMarkable devices
- Staged Installation: Smart two-stage process handles hashtable rebuilds seamlessly
- Auto-Detection: Automatically detects device type and architecture
- Automatic Backups: Creates complete system backups before any modifications
- Restore Functionality: Easy one-click restore from any backup
- Safe Uninstall: Clean removal with or without existing backups
- Progress Tracking: Smart stage detection prevents duplicate operations
- Interactive Menus: Intuitive command-line interface
- WiFi Setup Guidance: Step-by-step WiFi backup configuration before installation
- Installation Safety: Smart dual-connection setup (WiFi backup + USB primary)
- Real-time Progress: Live status updates throughout installation
- Error Recovery: Robust error handling and recovery options
- Command-line Options: Full automation support for advanced users
- reMarkable device (rM1 or rM2) with SSH enabled
- Linux, macOS, or WSL environment
bash,ssh,scpinstalledexpect(optional, for fully automatic hashtable rebuild)
-
Download the installer:
git clone https://github.com/wowitsjack/remarkable-xovi-installer.git cd remarkable-xovi-installer chmod +x remarkable-xovi-installer.sh -
Run the installer:
./remarkable-xovi-installer.sh
-
Follow the interactive prompts or use command-line options for automation
./remarkable-xovi-installer.sh -i YOUR_REMARKABLE_IP --force| Option | Description |
|---|---|
-h, --help |
Show help information |
-i, --ip IP |
Set reMarkable IP address |
-p, --password PASS |
Set SSH password (not recommended) |
--backup-menu |
Launch backup/restore menu directly |
--backup-only |
Create backup and exit |
--restore BACKUP |
Restore specific backup |
--force |
Skip confirmation prompts |
--stage1 |
Run only Stage 1 installation |
--stage2 |
Run only Stage 2 installation |
--continue |
Continue interrupted installation |
- WiFi Backup Configuration: Connect to home WiFi as emergency backup
- Connection Confirmation: Verify WiFi connectivity works properly
- WiFi Disable: Disable WiFi for stable USB ethernet installation
- Safety Explanation: Clear guidance on why this setup ensures stability
- System validation and device detection
- Automatic backup creation
- XOVI framework installation
- AppLoader deployment
- Hashtable rebuild (requires device restart)
- Post-reboot validation
- Extension activation
- Final system checks
- Installation completion
The installer automatically creates backups before any system modifications:
- Location:
/opt/backup/on reMarkable device - Contents: Complete systemd units, binaries, and configurations
- Restore: One-click restoration through backup menu
- Safety: Multiple backup retention for maximum safety
- Create New Backup - Generate fresh system backup
- Restore from Backup - Select and restore any previous backup
- List All Backups - View all available backups with timestamps
- Delete Old Backups - Clean up storage space
- Uninstall without Backup - Complete removal (use with caution)
- Offline Operation: v3.1.0+ works completely offline - no internet required on device
- WiFi Setup: Follow pre-installation WiFi setup for backup connectivity
- Dual Connection: WiFi provides backup access, USB ethernet provides installation stability
- Device Restart Required: Stage 1 requires a device restart for hashtable rebuild
- SSH Access: Ensure SSH is enabled on your reMarkable device
- Backup Safety: Always maintain backups before system modifications
- Network Reliability: Manual XOVI setup eliminates network-dependent installation failures
Connection Problems:
# Check SSH connectivity
ssh root@YOUR_REMARKABLE_IP
# Verify device is responsive
ping YOUR_REMARKABLE_IP
# If USB ethernet not working, use WiFi temporarily
ssh root@YOUR_WIFI_IPWiFi Setup Issues:
- Follow the pre-installation WiFi guidance carefully
- Ensure WiFi connection is confirmed before disabling
- Keep WiFi credentials handy in case USB fails during installation
Permission Issues:
# Ensure script is executable
chmod +x remarkable-xovi-installer.shInstallation Stuck:
- Use
--continueoption to resume interrupted installations - Check backup menu for restoration options
- Verify device has sufficient storage space
- Check the troubleshooting steps above
- Review the installation logs
- Try the backup/restore functionality
- Open an issue on GitHub with full error details
We welcome contributions! Please:
- Fork the repository
- Create a feature branch
- Test thoroughly on both rM1 and rM2
- Submit a pull request with detailed description
This project is licensed under the MIT License - see the LICENSE file for details.
- XOVI extension framework developers
- AppLoader project contributors
- reMarkable community for testing and feedback
- Everyone who helped make rM1 support possible