Configuration

Configuration Files

This section provides details about the necessary configuration files for running the Rustdesk server.

s3config.toml

The s3config.toml file is used to store the configuration for an S3 compatible bucket. This is where the customized Rustdesk clients are stored to avoid publishing them on a public website.

• Creating the File: If you don't have an S3 bucket, you still need a valid s3config.toml file in your working directory. This file will be automatically created upon the first launch of the hbbs server.
• Editing the File: If you are using S3 storage, you will need to edit this file with your specific configuration details.

oauth2.toml

The oauth2.toml file is used for third-party OAuth compatible provider authentication for Rustdesk users. Currently, only Github and Dex are supported.

• Creating the File: If you don't use third-party authentication, simply provide an empty oauth2.toml file.
• Editing the File: If you are using Github or Dex for authentication, you will need to edit this file with your specific configuration details.

Generating a Keypair

A keypair is needed for encryption; you can provide it, as explained before, but you need a way to create one.

You can use this command to generate a keypair:

rustdesk-utils genkeypair

If you don't have (or don't want) the rustdesk-utils tool installed on your system, you can invoke the same command with docker:

docker run --rm --entrypoint /usr/bin/rustdesk-utils  sctg/sctgdesk-server-server:latest genkeypair

The output will be something like this:

Public Key:  8BLLhtzUBU/XKAH4mep3p+IX4DSApe7qbAwNH9nv4yA=
Secret Key:  egAVd44u33ZEUIDTtksGcHeVeAwywarEdHmf99KM5ajwEsuG3NQFT9coAfiZ6nen4hfgNICl7upsDA0f2e/jIA==

Environment Variables

Explanation of the environment variables available for configuring hbbs and hbbr binaries.
Provides details on how to set these variables and their impact on the server's behavior.