Unix Server Tech Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== HBBS Config File ======

<WRAP center round alert 60%>
Warning: I just found another link (bottom link) which totally invalidates the sample config file I have here.
</WRAP>


<WRAP center round important 60%>
Note: this is mainly taken from AI, which pretty much sucks, so don't take this as gospel. Also, RustDesk has been known to change things. However, the documentation on the config file is missing now, so I'm making a best effort
</WRAP>

RustDesk Open Source Server can accept a config file name on invocation, allowing you to more easily manage the service. If hbbs is called as <code bash>hbbs -c /path/to/configfile</code>, it will appearantly read that file and configure itself on startup.

The following sample file is one taken from an AI question, as the documentation on this is sadly missing, as far as I can tell. I know that some of the options available are missing from this. I'm writing this 2025-09-29, and hope to figure some stuff out in the next few days.

<code toml hbbs.toml>
# hbbs.toml

[server]
ip = "0.0.0.0"  # IP address to listen on (0.0.0.0 for all interfaces)
port = 21112     # Port for the RustDesk server

[web]
enable = true    # Enable the web client
port = 8080      # Port for the web client

[log]
level = "info"   # Log level: "debug", "info", "warn", "error"
file = "/var/log/rustdesk/hbbs.log"  # Log file path

[database]
# Database configuration for storing session data
type = "sqlite"  # Database type: "sqlite", "mysql", etc.
path = "/var/lib/rustdesk/hbbs.db"  # Path to the database file

[security]
# Security settings
enable_tls = true  # Enable TLS for secure connections
tls_cert = "/etc/ssl/certs/rustdesk.crt"  # Path to the TLS certificate
tls_key = "/etc/ssl/private/rustdesk.key"  # Path to the TLS key

[auth]
# Authentication settings
enable_auth = true  # Enable authentication
username = "admin"  # Admin username
password = "your_password"  # Admin password (consider using a hashed password)

[network]
# Network settings
max_connections = 100  # Maximum number of concurrent connections
timeout = 300          # Timeout for idle connections in seconds
</code>

===== Links =====
  * [[https://deepwiki.com/rustdesk/rustdesk-server/4.2-encryption-and-key-management]]