extern/doc.rustdesk.com
1
0
Fork 1
mirror of https://github.com/rustdesk/doc.rustdesk.com.git synced 2025-01-14 18:29:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #122 from botanicvelious/patch-1

Browse Source 
Add documentation on using env variables
This commit is contained in:
RustDesk 2023-01-18 16:34:31 +08:00 committed by GitHub
commit 47aab57101
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 78 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
content/dev/build/all/_index.en.md Normal file
View File

@ -0,0 +1,46 @@
---
title: Build all using Github Actions
weight: 22
---
{{% notice note %}}
This build uses github actions, you will need a github account, also building can be slow, however this requires no development enviroment.
{{% /notice %}}
## Make a Fork
Goto https://github.com/rustdesk/rustdesk/fork and click "create fork"
## Set your enviroment variables (Optional)
{{% notice note %}}
You only need to do this if you want to change the default server and public key.
{{% /notice %}}
On your fork you just created goto settings -> Secrets and Variables -> Actions
Click New repository Secret for the name put RENDEZVOUS_SERVER for the secret put your servers name/ip address.
Click Add Secret
Click New repository Secret for the name put RS_PUB_KEY for the secret put your servers public key.
Click Add Secret
## Enable workflows
On your fork you just created goto actions and enable workflows.
Once workflows are enabled you can click "Flutter Nightly Build" on the left then click "Run workflow" on the right to build the rustdesk clients for all of the supported platforms.
## Enable upload permissions for workflows
On your fork you just created goto settings -> Actions -> General
Scroll down and under Workflow permissions enable "Read and Write permissions.
## Download your built packages
After the workflow is done running you can download the packages it built.
Goto the main page of your fork, on the right click releases. The packages you just built will show up under nightly.

32
content/self-host/hardcode-settings/_index.en.md Normal file
View File

@ -0,0 +1,32 @@
---
title: Hardcoding Custom Settings
weight: 10
---
## Custom Server
{{% notice note %}}
To hardcode custom server settings into your executables you must [build](/docs/en/dev/build/) the client youself.
{{% /notice %}}
{{% notice note %}}
**If you set eaither of these values without setting the other your executable will not work!**
{{% /notice %}}
You can set the following enviroment variables on your os and rustdesk will use those variables when compiling your client rather than the default rustdesk.com servers.
If you do not know how to set an enviroment variable on your system you should be able to find documentation for your os online that will explain this.
#### RENDEZVOUS_SERVER
This variable should be set to your server url.
This should be a string such as
```
rustdesk.my-domain.com
```
#### RS_PUB_KEY
This variable will be your public key, more information on the key is aviable [Here](/docs/en/self-host/install/#key)
This should be a string such as
```
OeVuKk5nlHiXp+APNn0Y3pC1Iwpwn44JGqrQCsWqmBw=
```