Portainer Templates logo

Portainer Templates

Rust Desk (stack) Rust Desk (stack)

Remote Control

Rust Desk is an Open source virtual or remote desktop infrastructure for everyone!

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

hbbs

Configuration

Image
rustdesk/rustdesk-server:latest
Command
hbbs -r rustdesk.example.com:21117
Ports
21115:2111521116:2111621116:21116/udp21118:21118
Volumes
/root : /portainer/Files/AppData/Config/rustdesk/data
Restart
unless-stopped

Image details

Pulls: 23.4M
User: rustdesk
Created: May 03, 2021
Updated: 26 days ago
Status: active

hbbr

Configuration

Image
rustdesk/rustdesk-server:latest
Command
hbbr
Ports
21117:2111721119:21119
Volumes
/root : /portainer/Files/AppData/Config/hbbr/data
Restart
unless-stopped

Image details

Pulls: 23.4M
User: rustdesk
Created: May 03, 2021
Updated: 26 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Rust Desk (stack)

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 Rust Desk (stack), fill in any config options, and hit Deploy

Template Import URL

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

The compose file this template deploys, straight from its repo:

networks:
  rustdesk-net:
    external: false

services:
  hbbs:
    container_name: hbbs
    ports:
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21118:21118
    image: rustdesk/rustdesk-server:latest
    command: hbbs -r rustdesk.example.com:21117
    volumes:
      - /portainer/Files/AppData/Config/rustdesk/data:/root
    networks:
      - rustdesk-net
    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    ports:
      - 21117:21117
      - 21119:21119
    image: rustdesk/rustdesk-server:latest
    command: hbbr
    volumes:
      - /portainer/Files/AppData/Config/hbbr/data:/root
    networks:
      - rustdesk-net
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/rustdesk.yml up -d

More install options in our documentation.

Serve Rust Desk (stack) 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 rust-desk-stack.example.com to http://hbbs:21115

Add this to your Caddyfile

rust-desk-stack.example.com {
	reverse_proxy http://hbbs: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 <container>
  • 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, Rust Desk 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/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull rustdesk/rustdesk-server: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.

  • 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 <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

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

A Compose stack

Rust Desk (stack) is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • hbbs runs rustdesk/rustdesk-server:latest, starts after hbbr
  • hbbr runs rustdesk/rustdesk-server:latest

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
  • 21118:21118
  • 21117:21117
  • 21119:21119

Volumes

A volume is where Rust Desk (stack) 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:

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

Restart policy

The restart policy here is unless-stopped, so Docker restarts Rust Desk (stack) 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

Portainer puts these services on one shared private network, so they can find each other by name (like hbbs) while only the ports above are open to you.

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 Rust Desk (stack) up. Add the template list to Portainer once, then deploying Rust Desk (stack) is a click rather than a wall of config.