diff --git a/README.md b/README.md index ef55fee..e2ccc0a 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,17 @@ The client generator is currently hosted [here](https://rdgen.crayoneater.org). If you would like to host the generator yourself, see [here](setup.md) -This client generator is currently integrated into my rustdesk [api -server](https://github.com/bryangerlach/rustdesk-api-server), which is a fork -of [rustdesk-api-server](https://github.com/kingmo888/rustdesk-api-server). If -you are running my api server, then you will still need to fork RDGen and go -through the setup process, but you won't need to actually run the rdgen server. +## 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/) + +## 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 + diff --git a/setup.md b/setup.md index bc7adb7..675520e 100644 --- a/setup.md +++ b/setup.md @@ -33,6 +33,16 @@ 5. Now just run ```docker compose up -d``` +## Use your own Windows code signing token + +1. You will need a USB signing token plugged into a Windows computer +2. On the computer with the USB signing token, you need to make sure it is set up correctly to sign using signtool.exe +3. Run a small [signing api](https://github.com/bryangerlach/signing_api) server on the computer with the USB token connected. Follow the setup instructions for this server. +4. Now for your rdgen repo, add github secrets for + - SIGN_BASE_URL (the accesible over the internet URL for the signing api server) + - SIGN_API_KEY (the api key you have set on your signing api server) + + ## Host manually: 1. A Github account with a fork of this repo