12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

hub Sign in Sign up

Explore / linuxserver/rustdesk

linuxserver/rustdesk
By linuxserver • Updated 3 days ago

IMAGE

6 9.8K

Overview Tags

LINUXSERVER.IO BLOG DISCORD 6.6K ONLINE DISCOURSE 2.3K TOPICS

LINUXSERVER.IO FLEET LINUXSERVER.IO GITHUB SUPPORTERS 860

The LinuxServer.io⁠ team brings you another container release featuring:

regular and timely application updates

easy user mappings (PGID, PUID)

custom base image with s6 overlay

weekly base OS updates with common layers across the entire LinuxServer.io
ecosystem to minimise space usage, down time and bandwidth

regular security updates

Find us at:

Blog⁠ - all the things you can do with our containers including How-To guides,
opinions and much more!

https://hub.docker.com/r/linuxserver/rustdesk 1/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

Discord⁠ - realtime support / chat with the community and the team.

Discourse⁠ - post on our community forum.

Fleet⁠ - an online web interface which displays all of our maintained images.

GitHub⁠ - view the source for all of our repositories.

Open Collective⁠ - please consider helping us by either donating or contributing to our

budget

linuxserver/rustdesk⁠
S TA R S 15 RELEASE V1.3.3-LS25 LINUXSERVER.IO GITHUB PACKAGE

LINUXSERVER.IO GITLAB REGISTRY LINUXSERVER.IO QUAY.IO

PULLS 9.8K S TA R S 6 BUILD PASSING CI PASS

RustDesk⁠ is a full-featured open source remote control alternative for self-hosting and
security with minimal configuration.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from
docker here⁠ and our announcement here⁠ .

Simply pulling lscr.io/linuxserver/rustdesk:latest should retrieve the correct

image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag

x86-64 ✅ amd64-<version tag>

arm64 ✅ arm64v8-<version tag>

armhf ❌
Application Setup
https://hub.docker.com/r/linuxserver/rustdesk 2/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

The application can be accessed at:

http://yourhost:3000/⁠

https://yourhost:3001/⁠

Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can
use Docker with the --security-opt seccomp=unconfined setting to allow these
syscalls on hosts with older Kernels or libseccomp

Security

[!WARNING] Do not put this on the Internet if you do not know what you are
doing.

By default this container has no authentication and the optional environment variables
CUSTOM_USER and PASSWORD to enable basic http auth via the embedded NGINX server
should only be used to locally secure the container from unwanted access on a local network. If
exposing this to the Internet we recommend putting it behind a reverse proxy, such as SWAG⁠ ,
and ensuring a secure authentication solution is in place. From the web interface a terminal can
be launched and it is configured for passwordless sudo, so anyone with access to it can install
and run whatever they want along with probing your local network.

Options in all KasmVNC based GUI containers

This container is based on Docker Baseimage KasmVNC⁠ which means there are additional
environment variables and run configurations to enable or disable specific functionality.

Optional environment variables

Variable Description

Internal port the container listens on for http if it needs to be

CUSTOM_PORT
swapped from the default 3000.

Internal port the container listens on for https if it needs to be

CUSTOM_HTTPS_PORT
swapped from the default 3001.

CUSTOM_USER HTTP Basic auth username, abc is default.

HTTP Basic auth password, abc is default. If unset there will be no

PASSWORD
auth

Subfolder for the application if running a subfolder reverse proxy,

SUBFOLDER
need both slashes IE /subfolder/

The page title displayed on the web browser, default "KasmVNC

TITLE
Client".

https://hub.docker.com/r/linuxserver/rustdesk 3/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

Variable Description

This is the home directory (landing) for the file manager, default
FM_HOME
"/config".

If set to false a container with privilege will not automatically start

START_DOCKER
the DinD Docker setup.

If mounting in /dev/dri for DRI3 GPU Acceleration⁠ allows you to

DRINODE
specify the device to use IE /dev/dri/renderD128

DISABLE_IPV6 If set to true or any value this will disable IPv6

Set the Language for the container to run as IE fr_FR.UTF-

LC_ALL
8 ar_AE.UTF-8

If set the application will run without window borders in openbox

NO_DECOR
for use as a PWA.

NO_FULL Do not autmatically fullscreen applications when using openbox.

Optional run configurations

Variable Description

Will start a Docker in Docker (DinD)

setup inside the container to use
docker in an isolated environment.
For increased performance mount
--privileged the Docker directory inside the
container to the host IE -v
/home/user/docker-
data:/var/lib/docker .

Mount in the host level Docker

-v socket to either interact with it via
/var/run/docker.sock:/var/run/docker.sock CLI or use Docker enabled
applications.

Mount a GPU into the container, this

can be used in conjunction with the
DRINODE environment variable to
--device /dev/dri:/dev/dri leverage a host video card for GPU
accelerated applications. Only Open
Source drivers are supported IE
(Intel,AMDGPU,Radeon,ATI,Nouveau)

Language Support - Internationalization

The environment variable LC_ALL can be used to start this container in a different language
than English simply pass for example to launch the Desktop session in French
LC_ALL=fr_FR.UTF-8 . Some languages like Chinese, Japanese, or Korean will be missing
https://hub.docker.com/r/linuxserver/rustdesk 4/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

fonts needed to render properly known as cjk fonts, but others may exist and not be installed
inside the container depending on what underlying distribution you are running. We only ensure
fonts for Latin characters are present. Fonts can be installed with a mod on startup.

To install cjk fonts on startup as an example pass the environment variables (Alpine base):

-e DOCKER_MODS=linuxserver/mods:universal-package-install
-e INSTALL_PACKAGES=fonts-noto-cjk
-e LC_ALL=zh_CN.UTF-8

The web interface has the option for "IME Input Mode" in Settings which will allow non english
characters to be used from a non en_US keyboard on the client. Once enabled it will perform the
same as a local Linux installation set to your locale.

DRI3 GPU Acceleration

For accelerated apps or games, render devices can be mounted into the container and
leveraged by applications using:

--device /dev/dri:/dev/dri

This feature only supports Open Source GPU drivers:

Driver Description

Intel i965 and i915 drivers for Intel iGPU chipsets

AMD AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets

NVIDIA nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support

The DRINODE environment variable can be used to point to a specific GPU. Up to date
information can be found here⁠

Nvidia GPU Support

Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers

Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the
following run flags:

Variable Description

This can be filtered down but for most setups this will pass the one Nvidia
--gpus all
GPU on the system

--runtime
Specify the Nvidia runtime which mounts drivers and tools in from the host
nvidia

The compose syntax is slightly different for this as you will need to set nvidia as the default
runtime:

https://hub.docker.com/r/linuxserver/rustdesk 5/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

sudo nvidia-ctk runtime configure --runtime=docker --set-as-default

sudo service docker restart

And to assign the GPU in compose:

services:
rustdesk:
image: lscr.io/linuxserver/rustdesk:latest
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities: [compute,video,graphics,utility]

Application management

PRoot Apps

If you run system native installations of software IE sudo apt-get install filezilla
and then upgrade or destroy/re-create the container that software will be removed and the
container will be at a clean state. For some users that will be acceptable and they can update
their system packages as well using system native commands like apt-get upgrade . If
you want Docker to handle upgrading the container and retain your applications and settings we
have created proot-apps⁠ which allow portable applications to be installed to persistent
storage in the user's $HOME directory and they will work in a confined Docker environment out
of the box. These applications and their settings will persist upgrades of the base container and
can be mounted into different flavors of KasmVNC based containers on the fly. This can be
achieved from the command line with:

proot-apps install filezilla

PRoot Apps is included in all KasmVNC based containers, a list of linuxserver.io supported
applications is located HERE⁠ .

Native Apps

It is possible to install extra packages during container start using universal-package-install⁠ .

It might increase starting time significantly. PRoot is preferred.

environment:
- DOCKER_MODS=linuxserver/mods:universal-package-install
- INSTALL_PACKAGES=libfuse2|git|gdb

Usage

https://hub.docker.com/r/linuxserver/rustdesk 6/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

To help you get started creating a container from this image you can either use docker-
compose or the docker cli.

docker-compose (recommended, click here for more info⁠ )

---
services:
rustdesk:
image: lscr.io/linuxserver/rustdesk:latest
container_name: rustdesk
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/config:/config
ports:
- 3000:3000
- 3001:3001
restart: unless-stopped

docker cli (click here for more info⁠ )

docker run -d \
--name=rustdesk \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 3000:3000 \
-p 3001:3001 \
-v /path/to/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/rustdesk:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These
parameters are separated by a colon and indicate <external>:<internal> respectively.
For example, -p 8080:80 would expose port 80 from inside the container to be
accessible from the host's IP on port 8080 outside the container.

Parameter Function

-p 3000 RustDesk desktop gui.

https://hub.docker.com/r/linuxserver/rustdesk 7/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

Parameter Function

-p 3001 HTTPS Rustdesk desktop gui.

-e PUID=1000 for UserID - see below for explanation

-e PGID=1000 for GroupID - see below for explanation

-e TZ=Etc/UTC specify a timezone to use, see this list⁠ .

Users home directory in the container, stores local files

-v /config
and settings

For Docker Engine only, many modern gui apps need this
--security-opt
to function on older hosts as syscalls are unknown to
seccomp=unconfined
Docker.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__ .

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the
/run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services
started within the containers using the optional -e UMASK=022 setting. Keep in mind umask
is not chmod it subtracts from permissions based on it's value it does not add. Please read up
here⁠ before asking for support.

User / Group Identifiers

When using volumes ( -v flags), permissions issues can arise between the host OS and the
container, we avoid this issue by allowing you to specify the user PUID and group PGID .

Ensure any volume directories on the host are owned by the same user you specify and any
permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000 , to find yours use id your_user as

below:

id your_user

Example output:
https://hub.docker.com/r/linuxserver/rustdesk 8/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

RUSTDESK NO RESULT UNIVERSAL 12

We publish various Docker Mods⁠ to enable additional functionality within the containers. The
list of Mods available for this image (if any) as well as universal mods that can be applied to
any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:

docker exec -it rustdesk /bin/bash

To monitor the logs of the container in realtime:

docker logs -f rustdesk

Container version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' r

ustdesk

Image version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' l

scr.io/linuxserver/rustdesk:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation
to update the app inside. With some exceptions (noted in the relevant readme.md), we do not
recommend or support updating apps inside the container. Please consult the Application Setup
section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

https://hub.docker.com/r/linuxserver/rustdesk 9/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

Update images:

All images:

docker-compose pull

Single image:

docker-compose pull rustdesk

Update containers:

All containers:

docker-compose up -d

Single container:

docker-compose up -d rustdesk

You can also remove the old dangling images:

docker image prune

Via Docker Run

Update the image:

docker pull lscr.io/linuxserver/rustdesk:latest

Stop the running container:

docker stop rustdesk

Delete the container:

https://hub.docker.com/r/linuxserver/rustdesk 10/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

docker arm
Recreate newrustdesk
container with the same docker run parameters as instructed above (if
mapped correctly to a host folder, your /config folder and settings will be
preserved)

You can also remove the old dangling images:

docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

[!TIP] We recommend Diun⁠ for update notifications. Other tools that

automatically update containers unattended are not recommended or
supported.

Building locally

If you want to make local modifications to these images for development purposes or just to
customize the logic:

git clone https://github.com/linuxserver/docker-rustdesk.git

cd docker-rustdesk
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/rustdesk:latest .

The ARM variants can be built on x86_64 hardware and vice versa using
lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64 .

Versions

25.07.24: - Initial release.

Docker Pull Command

https://hub.docker.com/r/linuxserver/rustdesk 11/12
12/1/24, 10:48 AM linuxserver/rustdesk - Docker Image | Docker Hub

docker pull linuxserver/rustdesk Copy

Why Products Developers

Overview Product Overview Getting Started
What is a Container Play with Docker
Product Offerings Community
Docker Desktop Open Source
Docker Hub Documentation

Features
Container Runtime
Developer Tools
Docker App
Kubernetes

Company
About Us
Resources
Blog
Customers
Partners
Newsroom
Events and Webinars
Careers
Contact Us
System Status⁠

© 2024 Docker, Inc. All rights reserved. | Terms of Service | Subscription Service Agreement |
Privacy | Legal

https://hub.docker.com/r/linuxserver/rustdesk 12/12