From 83a639a47c26a2a9888aacf0fe2c45a373f4b828 Mon Sep 17 00:00:00 2001 From: Bryan Gerlach Date: Tue, 5 Nov 2024 16:09:05 -0600 Subject: [PATCH] update readme, setup --- README.md | 6 ++--- setup.md | 67 ++++++++++++++++++++++++++++++++++++++----------------- 2 files changed, 49 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d5cdaa1..edf533b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -RDGEN is a RustDesk client generator to use with your self-hosted rustdesk server. +## RDGEN is 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) +## 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. +## 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. diff --git a/setup.md b/setup.md index ae539ad..71d60ce 100644 --- a/setup.md +++ b/setup.md @@ -1,51 +1,76 @@ ## To fully host the client generator yourself, you will need to following: -### 1) A Github account with a fork of this repo -### 2) A Github fine-grained access token with permissions for your rdgen repository - a) login to your github account - b) click on your profile picture at the top right, click Settings - c) at the bottom of the left panel, click Developer Settings - d) click Personal access tokens - e) click Fine-grained tokens - f) click Generate new token - g) give a token name, change expiration to whatever you want - h) under Repository acces, select Only select repositories, then pick your rdgen repo - i) give Read and Write access to actions and workflows -### 3) On the server running the client generator: - a) environment variables: - GHUSER="your github username" - GHBEARER="your fine-graned access token" - b) github secrets (setup on your github account for your rdgen repo): - GENURL="example.com:8083" | this is the domain and port that your are running rdgen on, needs to be accesible on the internet - c) optional github secrets (for signing the code): - WINDOWS_PFX_BASE64 - WINDOWS_PFX_PASSWORD - WINDOWS_PFX_SHA1_THUMBPRINT +
    +
  1. A Github account with a fork of this repo
    2. +
  2. A Github fine-grained access token with permissions for your rdgen repository +
      +
    • login to your github account
      • +
    • click on your profile picture at the top right, click Settings
      • +
    • at the bottom of the left panel, click Developer Settings
      • +
    • click Personal access tokens
      • +
    • click Fine-grained tokens
      • +
    • click Generate new token
      • +
    • give a token name, change expiration to whatever you want
      • +
    • under Repository acces, select Only select repositories, then pick your rdgen repo
      • +
    • give Read and Write access to actions and workflows
      • +
    +
    3. +
  3. Setup environment variables / secrets: +
      +
    • environment variables on the server running rdgen: +
        +
      • GHUSER="your github username"
        • +
      • GHBEARER="your fine-graned access token"
        • +
      • +
    • github secrets (setup on your github account for your rdgen repo): + +
    • GENURL="example.com:8083"
      • + *this is the domain and port that your are running rdgen on, needs to be accesible on the internet +
    4. +
  4. optional github secrets (for signing the code): +
      +
    • WINDOWS_PFX_BASE64
      • +
    • WINDOWS_PFX_PASSWORD
      • +
    • WINDOWS_PFX_SHA1_THUMBPRINT
      • +
    5. + + +
## To run rdgen on your server: ### open to the directory you want to install rdgen (change /opt to wherever you want) + > cd /opt ### clone your rdgen repo, change bryangerlach to your github username + > git clone https://github.com/bryangerlach/rdgen.git ### open the rdgen directory + > cd rdgen ### setup a python virtual environment called rdgen + > python -m venv rdgen ### activate the python virtual environment + > source rdgen/bin/activate ### install the python dependencies + > pip install -r requirements.txt ### setup the database + > python manage.py migrate ### run the server, change 8000 with whatever you want + > python manage.py runserver 0.0.0.0:8000 ### open your web browser to yourdomain:8000 + +### use nginx, caddy, traefik, etc. for ssl reverse proxy