Files
BetterDesk/docs/GITHUB_RELEASE_GUIDE.md
T
UNITRONIX ffeb8fc6fe Add Docker detection and update repo references
Added DOCKER_SUPPORT.md with guidance for Docker users. Updated install-improved.sh to detect running RustDesk Docker containers and warn users, providing Docker management instructions and an option to continue. Changed all documentation and scripts to reference the new repository name 'Rustdesk-FreeConsole' instead of 'BetterDesk-Console'.
2026-01-12 03:55:23 +01:00

7.9 KiB

Projekt Gotowy do Publikacji na GitHub

Data weryfikacji: 10 stycznia 2026
Status: READY TO RELEASE


📦 Nowa Wersja

v1.3.0-secure

Poprzednia wersja: v1.2.0-v8
Nowa wersja: v1.3.0-secure

Dlaczego taka nazwa:

  • 1.3.0 - Semantic versioning (minor update z breaking change)
  • -secure - Wyraźnie wskazuje na fokus bezpieczeństwa
  • Jasny komunikat dla użytkowników o charakterze wydania

Alternatywne nazwy (do wyboru):

  • v1.3.0-secure POLECANA - najlepsza dla tego release
  • v1.3.0-localhost - alternatywa skupiona na funkcjonalności
  • v1.3.0 - tradycyjna bez suffixu

🎯 Główne Zmiany

Bezpieczeństwo API

Port: 21114 → 21120

  • Unika konfliktu z RustDesk Pro
  • Jasno wskazuje na localhost-only service

Binding: 0.0.0.0 → 127.0.0.1

  • API dostępne TYLKO z localhost
  • Zero ekspozycji sieciowej
  • Connection refused z sieci (bezpieczne)

Nowe parametry:

  • --api-port 21120 - konfiguracja przez CLI
  • SSH tunnel support dla zdalnego dostępu

Weryfikacja Bezpieczeństwa

Kompletna ✓

  • Brak IP 192.168.0.110 w README.md (0 wystąpień)
  • Brak haseł/kluczy w dokumentacji (0 wystąpień)
  • Username "UNITRONIX" tylko w URL GitHub (6 wystąpień - OK)
  • Baza danych NIE w repozytorium (tylko kod obsługi)
  • Pliki .gitignore poprawnie skonfigurowane (*.db, *.sqlite3)
  • Prywatne dane całkowicie wyczyszczone

Archiwalne pliki (bezpieczne)

Znalezione wystąpienia IP/username tylko w:

  • SECURITY_CLEANUP_REPORT.md - dokumentacja procesu czyszczenia
  • RELEASE_READY.md - instrukcje weryfikacji
  • archive/ - folder archiwalny

Wszystkie są dokumentacją bezpieczeństwa, nie faktycznymi danymi.


📦 Zawartość Release

Binaria (23.67 MB total)

Linux (x86_64):

  • hbbs-v8-api - 9.59 MB (SHA256: 7B09A6C0...)
  • hbbr-v8-api - 4.73 MB (SHA256: DF1B3FD3...)
  • Data: 10.01.2026 10:25 UTC
  • Zawiera: localhost-only binding, port 21120

Windows (x64):

  • hbbs-v8-api.exe - 6.58 MB (SHA256: EE1AB9C3...)
  • hbbr-v8-api.exe - 2.76 MB (SHA256: 37F452AE...)
  • Data: 10.01.2026 04:42 UTC
  • Kompatybilne z nową konfiguracją

Lokalizacja: hbbs-patch/bin-with-api/

Dokumentacja

Zaktualizowane:

  • VERSION → 1.3.0-secure
  • CHANGELOG.md → nowy wpis z v1.3.0-secure
  • README.md → badge wersji + security badge
  • hbbs-patch/bin-with-api/CHECKSUMS.md → sumy SHA256
  • RELEASE_NOTES_v1.3.0.md → kompletne release notes

Istniejące (bez zmian):

  • README.md - 656 linii (zaktualizowany port 21120)
  • CHANGELOG.md - 397 linii (z nowym entry)
  • PORT_SECURITY.md - 337 linii
  • CONTRIBUTING.md - dokumentacja dla contributors
  • LICENSE - MIT License

🚀 Kroki Publikacji

1. Przegląd Końcowy (opcjonalny)

# Sprawdź stan Git
git status

# Przejrzyj zmiany
git diff

# Zweryfikuj binaria
sha256sum hbbs-patch/bin-with-api/hbbs-v8-api

2. Commit Zmian

# Dodaj wszystkie pliki
git add .

# Commit z opisem
git commit -m "Release v1.3.0-secure: Localhost-only API binding

Major Changes:
- Changed API port from 21114 to 21120
- API now binds to localhost (127.0.0.1) only
- Added --api-port CLI parameter
- Updated all documentation
- Added CHECKSUMS.md for binary verification

Security:
- Zero network exposure for API
- Connection refused from external networks
- No private data in documentation
- SSH tunnel support for remote access

Binaries:
- Updated Linux binaries (10.01.2026 10:25)
- Windows binaries compatible (retained from v1.2.0-v8)
- Total size: 23.67 MB
- SHA256 checksums included

Documentation:
- Updated README with security badges
- New RELEASE_NOTES_v1.3.0.md
- Complete PORT_SECURITY.md guide
- Migration instructions from v1.2.0-v8"

3. Utwórz Tag

# Utwórz annotated tag
git tag -a v1.3.0-secure -m "Release v1.3.0-secure

Localhost-Only API Binding

This release focuses on security enhancement:
- API port changed from 21114 to 21120
- API binds exclusively to localhost (127.0.0.1)
- Zero network exposure
- SSH tunnel support for remote access

Full release notes: RELEASE_NOTES_v1.3.0.md
"

# Weryfikuj tag
git tag -l -n9 v1.3.0-secure

4. Push do GitHub

# Push commits
git push origin main

# Push tags
git push origin --tags

# Lub wszystko razem
git push origin main --tags

5. Utwórz GitHub Release

Na stronie GitHub:

  1. Idź do: ReleasesCreate a new release

  2. Tag version: v1.3.0-secure

  3. Release title: v1.3.0-secure - Localhost-Only API Binding

  4. Description: (skopiuj z RELEASE_NOTES_v1.3.0.md)

## 🔒 Security Enhancement Release

### What's New

**API Port:** 21114 → 21120  
**API Binding:** 0.0.0.0 → 127.0.0.1 (localhost only)

This release eliminates network exposure of the HTTP API.

### Key Features

✅ Zero network exposure - API accessible only from localhost  
✅ SSH tunnel support for remote access  
✅ No port forwarding needed for 21120  
✅ Updated binaries with security code  
✅ Complete documentation with migration guide

### Installation

**Linux:**
```bash
git clone https://github.com/UNITRONIX/Rustdesk-FreeConsole.git
cd Rustdesk-FreeConsole
sudo ./install-improved.sh

Windows:

git clone https://github.com/UNITRONIX/Rustdesk-FreeConsole.git
cd Rustdesk-FreeConsole
.\install-improved.ps1  # Run as Administrator

Upgrade from v1.2.0-v8

Automatic:

cd Rustdesk-FreeConsole
git pull
sudo ./install-improved.sh

Full Documentation


5. **Attach Binaries** (opcjonalnie):
   - Można dodać binaria jako assets
   - Lub pozostawić w repozytorium (już są w bin-with-api/)

6. **Publish release**

---

## 📊 Statystyki Projektu

### Pliki

📁 BetterDeskConsole/ ├── 📄 README.md (656 linii) ├── 📄 CHANGELOG.md (397 linii) ├── 📄 VERSION (1.3.0-secure) ├── 📄 LICENSE (MIT) ├── 📄 CONTRIBUTING.md ├── 📄 PORT_SECURITY.md (337 linii) ├── 📄 RELEASE_NOTES_v1.3.0.md (nowy) ├── 📁 hbbs-patch/ │ ├── 📁 bin-with-api/ (4 binaria, 23.67 MB) │ │ └── CHECKSUMS.md (nowy) │ ├── 📁 src/ (kod źródłowy Rust) │ └── 📄 README.md, build.sh, deploy-v8.sh ├── 📁 web/ │ ├── app.py (konsola Flask) │ ├── 📁 templates/ (HTML) │ └── 📁 static/ (CSS, JS, Material Icons) ├── 📁 docs/ (dokumentacja) ├── 📁 migrations/ (skrypty migracji bazy) └── 📁 dev_modules/ (narzędzia deweloperskie)


### Rozmiar

- **Binaria:** 23.67 MB
- **Całość projektu:** ~30-35 MB (z dokumentacją)
- **Web assets:** Offline-ready (Material Icons included)

---

## 🎉 Co Dalej

### Po Publikacji

1. **Ogłoszenie:**
   - Dodaj post na GitHub Discussions
   - Powiadom użytkowników o bezpieczeństwie

2. **Monitorowanie:**
   - Sprawdzaj GitHub Issues
   - Odpowiadaj na pytania o migrację

3. **Social Media** (opcjonalnie):
   - Tweet o security update
   - Post na Reddit r/rustdesk

### Przyszłe Wersje

**v1.4.0** (sugestie):
- API authentication (JWT tokens)
- Rate limiting dla API
- HTTPS dla web console
- Audit logging

---

## 📞 Kontakt

**Issues:** https://github.com/UNITRONIX/Rustdesk-FreeConsole/issues  
**Discussions:** https://github.com/UNITRONIX/Rustdesk-FreeConsole/discussions

---

## ✅ Checklist Finalna

- [x] VERSION zaktualizowany
- [x] CHANGELOG zaktualizowany
- [x] README zaktualizowany (badges)
- [x] CHECKSUMS.md utworzony
- [x] RELEASE_NOTES_v1.3.0.md utworzony
- [x] Binaria zweryfikowane (SHA256)
- [x] Bezpieczeństwo sprawdzone (no private data)
- [x] Dokumentacja kompletna
- [x] Git ready (clean state)

**🎉 PROJEKT GOTOWY DO PUBLIKACJI! 🎉**