Rport
Stack
RPort is free remote access and remote management, now acquired by RealVNC
Configuration
TypeComposelinuxiotech17/rport:latest3000:30004822:482210000:808020000-20100:20000-20100alwaysStandalone Install
Select an install method, to see config/commands for deploying Rport
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Rport, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
services:
rport-server:
container_name: rport
image: iotech17/rport:latest
restart: always
privileged: true
ports:
- 3000:3000
- 4822:4822
- 10000:8080
- 20000-20100:20000-20100
volumes:
- type: bind
source: /portainer/Files/AppData/Config/rport/rportd.conf
target: /etc/rport/rportd.conf:ro
- type: bind
source: /portainer/Files/AppData/Config/rport/rport.key
target: /var/lib/rport/rport.key:ro
- type: bind
source: /portainer/Files/AppData/Config/rport/rport.crt
target: /var/lib/rport/rport.crt:ro
- type: bind
source: /portainer/Files/AppData/Config/rport/data
target: /var/lib/rport/
Or deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/rport.yml up -dMore install options in our documentation.
Serve Rport 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 rport.example.com to http://rport-server:3000
Add this to your Caddyfile
rport.example.com {
reverse_proxy http://rport-server:3000
}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:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3000 - Stop the other service, or pick a different host port. In
3000:3000only 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:3000. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, rport-server can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3000
Image won't pull
Test the pull directly on the host: docker pull iotech17/rport: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 loginto 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 always 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
noso 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.
- Bug within the app: Open an issue within rport-server's repo
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Rport is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.
The app image
An image is the app packed up ready to go, everything Rport needs bundled into one download. This template pulls iotech17/rport:latest, which Docker fetches once and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Rport's comes from Docker Hub, published by iotech17.
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. Pin a specific tag if you would rather stay on one version.
Ports
A port is the door the app answers on. A mapping like 3000:3000 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:
3000:3000, likely the web interface4822:482210000:8080, likely the web interface20000-20100:20000-20100
No stored data
This template doesn't mount any storage, so whatever Rport writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.
Restart policy
The restart policy here is always, so Docker brings Rport back up after a crash and again when the server reboots. Good for anything you want running around the clock. 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 Rport 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 rport-server. That's what you'll spot in the containers list and use in commands like docker logs rport-server.
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 Rport up. Add the template list to Portainer once, then deploying Rport is a click rather than a wall of config.