Initial commit: rdgen with GitHub/Gitea dual build backend

2026-09-29 19:56:02 +08:00
commit a3686a49d4
103 changed files with 20007 additions and 0 deletions
@@ -0,0 +1,31 @@
+# RDGen, a RustDesk client generator to use with your self-hosted RustDesk server
+
+The client generator is currently hosted [here](https://rdgen.crayoneater.org).
+If you would like to host the generator yourself, see [here](setup.md)
+
+## Features
+
+- Embed server and key into client
+- Custom app name
+- Custom icon/logo
+- Set default settings for the client
+- Support for rustdesk advanced settings (https://rustdesk.com/docs/en/self-host/client-configuration/advanced-settings/)
+
+## Generate RustDesk clients from command line instead of using a web browser
+
+Save your configuration from the rdgen web interface, or generate your own, then use that json file with [@AlekseyLapunov's rdgen-cli](https://github.com/AlekseyLapunov/rdgen-cli) to build from the command line on Windows, Linux, or MacOS like this: `python rdgen-cli -f my_config.json --set-version 1.4.5 --set-platform windows -s https://rdgen.crayoneater.org`
+
+## Build platforms
+
+Client builds run on **GitHub Actions** by default (cloud-hosted Windows/macOS/Linux runners).
+A self-hosted **Gitea Actions** backend is also supported for intranet deployments where
+builders and artifact uploads must stay off the public internet; you can switch between
+the two in **Dashboard → 构建平台配置** (or `BUILD_PLATFORM=github|gitea`). Gitea requires
+Gitea 1.27+ and your own registered `act_runner` machines. Full setup: [setup.md](setup.md).
+
+## Notes
+
+- Icons should be square (256x256 recommended)
+- Avoid special characters or non-English characters in app name and file name
+- Build time is currently 30 - 45 minutes
+