mirror of
https://github.com/UNITRONIX/BetterDesk.git
synced 2026-09-10 09:35:39 +00:00
b14a8cf162
Add a full automated build pipeline, interactive build scripts, documentation and development utilities. - Add GitHub Actions workflow (.github/workflows/build.yml) to build BetterDesk (hbbs/hbbr) for Linux x64, Linux ARM64 and Windows x64, upload artifacts, optionally create a release and update repository binaries. - Add interactive build scripts for Windows and Unix (build-betterdesk.ps1, build-betterdesk.sh) supporting download, patch application, cross-build and checksum generation. - Add build and status docs (docs/BUILD_GUIDE.md, docs/STATUS_TRACKING_v3.md) and update project README/instructions (.github/copilot-instructions.md) with new items and updated timestamp. - Add development utilities under dev_modules/ (multiple database/patch/test helpers) and move test_generator.py into dev_modules/test_generator.py. - Update .gitignore to exclude archive/ folder. - Modify hbbs-patch-v2 sources (database.rs, http_api.rs, main.rs, peer.rs and add rendezvous_server.rs) and remove legacy fixed files; update web UI backend and static files (web/app.py, web/static/*, web/templates/index.html). These changes set up CI/CD for multi-platform builds, provide local build tooling, expand docs for v3 status tracking and ID-change features, and add developer test/patch utilities.
2.2 KiB
2.2 KiB
Development Modules
This directory contains development and testing utilities for BetterDesk Console.
Contents
Testing Scripts
- test_ban_api.sh - Test script for ban/unban API endpoints
- test_change_id.py - Test ID change API endpoint (requires HBBS_API_KEY environment variable)
- test_id_change.sh - Test ID change via Web Console API (requires ADMIN_PASS environment variable)
- test_generator.py - Test script for RustDesk Client Generator
Diagnostic Tools
- check_database.py - Database inspection and validation tool
- check_and_fix_database.sh - Database Schema Checker & Fixer ⭐
- Use this if you have login problems!
- diagnose_offline_status.sh - Diagnose offline status issues ⭐
- Use this if devices show as offline incorrectly!
- fix_peer_columns.sh - Quick Fix for Device Errors ⭐
- Use this if you get 500 errors when editing devices!
- fix_systemd_services.sh - Fix Systemd Services for API Binaries ⭐
- Use this if RustDesk services still use original binaries!
- fix_database.py - Fix database.rs imports and change_id function
Patching Tools
- patch_rendezvous.py - Patch rendezvous_server.rs to call touch_peer on RegisterPeer
- patch_id_change.py - Patch rendezvous_server.rs for ID change via old_id field
- patch_peer_remove.py - Patch peer.rs to add remove function
- patch_database_simple.py - Add change_id function to database.rs
Development Scripts
- update.ps1 - PowerShell update script (Windows development environment)
Usage
These tools are for development and testing only. They are not required for production deployment.
Requirements
- Python 3.8+ (for check_database.py)
- Bash (for test_ban_api.sh)
- curl (for API testing)
Notes
- These scripts assume a local or test RustDesk server installation
- Always test on non-production systems first
- See main README.md for production deployment
Contributing
When adding new development tools:
- Document usage in this README
- Add appropriate shebang and error handling
- Include comments explaining functionality
- Test on clean environment before committing