Portainer Templates logo

Portainer Templates

RustDesk (container) RustDesk (container)

OtherTools

A remote desktop software, the open source TeamViewer alternative, works out of the box, no configuration required. You have full control of your data, with no concerns about security.

Image details

Pulls: 1.5M
Architecture: amd64, arm64, arm/v7, 386
Image size: 11 MB
Latest: 1.1.16
User: rustdesk
Created: Jul 01, 2022
Updated: 26 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
rustdesk/rustdesk-server-s6:latest
Ports
21115:21115/tcp21116:21116/tcp21116:21116/udp21117:21117/tcp21118:21118/tcp21119:21119/tcp
Volumes
/data : /portainer/Files/AppData/Config/rustdesk
Env vars
RELAY=rustdesk.example.com:21117ENCRYPTED_ONLY=1
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://rustdesk.com/
Official Docker Documentation: https://github.com/rustdesk/rustdesk-server


Youtube Video: Novaspirit Tech - Rust Desk Open Source Remote Desktop

Don't forget to open ports 21115 to 21119 in your router.

Standalone Install

Select an install method, to see config/commands for deploying RustDesk (container)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select RustDesk (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

Serve RustDesk (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying rustdesk-container.example.com to http://rustdesk:21115

Add this to your Caddyfile

rustdesk-container.example.com {
	reverse_proxy http://rustdesk:21115
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs rustdesk
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:21115 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :21115
  • Stop the other service, or pick a different host port. In 21115:21115 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:21115. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, rustdesk can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 21115

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/rustdesk

Image won't pull

Test the pull directly on the host: docker pull rustdesk/rustdesk-server-s6:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, 386
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect rustdesk --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

RustDesk (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything RustDesk (container) needs bundled into one download. This template pulls rustdesk/rustdesk-server-s6:latest, which Docker fetches once (about 11 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. RustDesk (container)'s comes from Docker Hub, published by rustdesk.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 1.1.16. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, 386, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 21115:21115 means it's reachable on port 21115 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 21115:21115
  • 21116:21116
  • 21116:21116 over UDP
  • 21117:21117
  • 21118:21118
  • 21119:21119

Volumes

A volume is where RustDesk (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data from /portainer/Files/AppData/Config/rustdesk on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. RustDesk (container) takes 2 of them, all with defaults you can leave alone or tweak:

  • RELAY, defaults to rustdesk.example.com:21117. Use your domain with the default 21117 port
  • ENCRYPTED_ONLY, defaults to 1. If set to "1" unencrypted connection will not be accepted

Restart policy

The restart policy here is unless-stopped, so Docker restarts RustDesk (container) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so RustDesk (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container rustdesk. That's what you'll spot in the containers list and use in commands like docker logs rustdesk.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set RustDesk (container) up. Add the template list to Portainer once, then deploying RustDesk (container) is a click rather than a wall of config.