1
0
forked from shaytan/rdgen

update setup.md

This commit is contained in:
Bryan Gerlach
2024-11-05 15:34:19 -06:00
parent 2cd7f24fcf
commit 8c50a7f8da

View File

@@ -1,54 +1,51 @@
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 ### 1) A Github account with a fork of this repo
2) A Github fine-grained access token with permissions for your rdgen repository ### 2) A Github fine-grained access token with permissions for your rdgen repository
a) login to your github account a) login to your github account
b) click on your profile picture at the top right, click Settings b) click on your profile picture at the top right, click Settings
c) at the bottom of the left panel, click Developer Settings c) at the bottom of the left panel, click Developer Settings
d) click Personal access tokens d) click Personal access tokens
e) click Fine-grained tokens e) click Fine-grained tokens
f) click Generate new token f) click Generate new token
g) give a token name, change expiration to whatever you want g) give a token name, change expiration to whatever you want
h) under Repository acces, select Only select repositories, then pick your rdgen repo h) under Repository acces, select Only select repositories, then pick your rdgen repo
i) give Read and Write access to actions and workflows i) give Read and Write access to actions and workflows
3) On the server running the client generator: ### 3) On the server running the client generator:
a) environment variables: a) environment variables:
GHUSER="your github username" GHUSER="your github username"
GHBEARER="your fine-graned access token" GHBEARER="your fine-graned access token"
b) github secrets (setup on your github account for your rdgen repo): 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 GENURL="example.com:8083" | this is the domain and port that your are running rdgen on, needs to be accesible on the internet
GEN_FTP_SERVER="ftp.example.com" | you need an ftp server for the github actions to upload to c) optional github secrets (for signing the code):
GEN_FTP_USER="username" | username for your ftp server where the exe/deb/rpm/apk files will be uploaded WINDOWS_PFX_BASE64
GEN_FTP_PASSWORD="password" | password for your ftp user WINDOWS_PFX_PASSWORD
c) optional github secrets (for signing the code): WINDOWS_PFX_SHA1_THUMBPRINT
WINDOWS_PFX_BASE64
WINDOWS_PFX_PASSWORD
WINDOWS_PFX_SHA1_THUMBPRINT
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