mirror of
https://github.com/UNITRONIX/BetterDesk.git
synced 2026-10-26 06:19:53 +00:00
856002d389
Allow the split console to read and write the P2P, relay, NAT, and initiator policy through the Go server's shared database API. Apply validated changes atomically at runtime, keep native systemd and compose paths unchanged, and cover the flow with regression tests and Docker image checks. Refs #432 Thanks: INSOLVE (Honorary); Marco Jakobs (@jacotec); MyNameisStitch (@MyNameisStitch); Redspin (@playerumpknow)
Documentation
User guides live in the GitHub Wiki (source: wiki/, sync with scripts/sync-wiki.ps1 / scripts/sync-wiki.sh).
Root entry points: README, PRIVACY.md, CHANGELOG.md.
For operators
Start on the wiki: Home → Installation → Client setup → TLS as needed.
Longer runbooks in this tree:
| Topic | Doc |
|---|---|
| Installation detail | setup/INSTALLATION_V1.4.0.md |
| Updates | setup/UPDATE_GUIDE.md |
| HTTPS (panel) | setup/HTTPS_SETUP.md |
| Reverse proxy | setup/REVERSE_PROXY.md |
| Synology | setup/SYNOLOGY_INSTALLATION.md |
| Client mass deploy | setup/RUSTDESK_CLIENT_DEPLOYMENT.md |
| Docker | docker/DOCKER_QUICKSTART.md, docker/DOCKER_SUPPORT.md, docker/DOCKER_TROUBLESHOOTING.md |
| Troubleshooting | troubleshooting/TROUBLESHOOTING_EN.md, troubleshooting/KEY_TROUBLESHOOTING.md |
For developers / integrators
| Topic | Doc |
|---|---|
| Contributing | development/CONTRIBUTING.md |
| Translations | development/CONTRIBUTING_TRANSLATIONS.md |
| Build from source | setup/BUILD_GUIDE.md |
| Project layout | architecture/PROJECT_STRUCTURE.md |
| CDAP | cdap/, architecture/CDAP_PROTOCOL.md |
| SDKs | sdk/ |
| Threat model / encryption | security/THREAT_MODEL.md, security/ENCRYPTION_SPEC.md |
| Port notes | architecture/PORT_SECURITY.md |
Wiki mirrors for common topics: API, CDAP, SDK.
Maintainers
Branching, update flow, installer contracts: important/README.md.
Dated audits, roadmaps, and one-off plans are historical — see archive/ when present, or treat root-level AUDIT_* / *_ROADMAP_* / *_PLAN_* files as non-user docs (do not link them from the wiki Home).
Changelog
Use the root CHANGELOG.md only. The old development/CHANGELOG.md file is a stub redirect.