kaan/rdgen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme, setup

Browse Source
This commit is contained in:
Bryan Gerlach
2024-11-05 16:09:05 -06:00
parent 8c50a7f8da
commit 83a639a47c
2 changed files with 49 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -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.
setup.md
+46 -21
View File
@@ -1,51 +1,76 @@
## To fully host the client generator yourself, you will need to following: ## To fully host the client generator yourself, you will need to following:
### 1) A Github account with a fork of this repo <ol>
### 2) A Github fine-grained access token with permissions for your rdgen repository <li>A Github account with a fork of this repo </li>
a) login to your github account <li>A Github fine-grained access token with permissions for your rdgen repository
b) click on your profile picture at the top right, click Settings <ul>
c) at the bottom of the left panel, click Developer Settings <li>login to your github account </li>
d) click Personal access tokens <li>click on your profile picture at the top right, click Settings </li>
e) click Fine-grained tokens <li>at the bottom of the left panel, click Developer Settings </li>
f) click Generate new token <li>click Personal access tokens </li>
g) give a token name, change expiration to whatever you want <li>click Fine-grained tokens </li>
h) under Repository acces, select Only select repositories, then pick your rdgen repo <li>click Generate new token </li>
i) give Read and Write access to actions and workflows <li>give a token name, change expiration to whatever you want </li>
### 3) On the server running the client generator: <li>under Repository acces, select Only select repositories, then pick your rdgen repo </li>
a) environment variables: <li>give Read and Write access to actions and workflows </li>
GHUSER="your github username" </ul>
GHBEARER="your fine-graned access token" </li>
b) github secrets (setup on your github account for your rdgen repo): <li>Setup environment variables / secrets:
GENURL="example.com:8083" | this is the domain and port that your are running rdgen on, needs to be accesible on the internet <ul>
c) optional github secrets (for signing the code): <li>environment variables on the server running rdgen:
WINDOWS_PFX_BASE64 <ul>
WINDOWS_PFX_PASSWORD <li>GHUSER="your github username" </li>
WINDOWS_PFX_SHA1_THUMBPRINT <li>GHBEARER="your fine-graned access token" </li>
</ul></li>
<li>github secrets (setup on your github account for your rdgen repo):
<oul>
<li>GENURL="example.com:8083" </li>
*this is the domain and port that your are running rdgen on, needs to be accesible on the internet
</ul></li>
<li>optional github secrets (for signing the code):
<ul>
<li>WINDOWS_PFX_BASE64 </li>
<li>WINDOWS_PFX_PASSWORD </li>
<li>WINDOWS_PFX_SHA1_THUMBPRINT</li>
</ul></li>
</ul>
</li>
</ol>
## To run rdgen on your server: ## To run rdgen on your server:
### open to the directory you want to install rdgen (change /opt to wherever you want) ### open to the directory you want to install rdgen (change /opt to wherever you want)
> cd /opt > cd /opt
### clone your rdgen repo, change bryangerlach to your github username ### clone your rdgen repo, change bryangerlach to your github username
> git clone https://github.com/bryangerlach/rdgen.git > git clone https://github.com/bryangerlach/rdgen.git
### open the rdgen directory ### open the rdgen directory
> cd rdgen > cd rdgen
### setup a python virtual environment called rdgen ### setup a python virtual environment called rdgen
> python -m venv rdgen > python -m venv rdgen
### activate the python virtual environment ### activate the python virtual environment
> source rdgen/bin/activate > source rdgen/bin/activate
### install the python dependencies ### install the python dependencies
> pip install -r requirements.txt > pip install -r requirements.txt
### setup the database ### setup the database
> python manage.py migrate > python manage.py migrate
### run the server, change 8000 with whatever you want ### run the server, change 8000 with whatever you want
> python manage.py runserver 0.0.0.0:8000 > python manage.py runserver 0.0.0.0:8000
### open your web browser to yourdomain:8000 ### open your web browser to yourdomain:8000
### use nginx, caddy, traefik, etc. for ssl reverse proxy