Portainer Templates logo

Portainer Templates

Teleport Teleport

Stack

Tools

Teleport allows engineers and security professionals to unify access for SSH servers, Kubernetes clusters, web applications, and databases across all environments.

Configuration

Type
Compose
Platform
linux
Restart
always
Source
Repo

Template by xneo1·Source

Services

one

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one.yaml
Ports
3080:30803023:30233025:3025
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/one/data/one/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/one/mnt/shared/certs : certs
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

one-node

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one-node.yaml
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/one-node/data/one-node/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/one-node
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

one-sshd

Configuration

Image
teleport:latest
Command
/usr/bin/start-sshd.sh
Volumes
/etc/pam.d/ssh : /portainer/Files/AppData/teleport/one-sshd/pam.d/ssh/etc/ssh/sshd_config : /portainer/Files/AppData/Config/teleport/one-sshd/mnt/shared/certs : certs
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

one-proxy

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one-proxy.yaml
Ports
4080:30804023:3023
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/one-proxy/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/one-proxy
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

two-auth

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-auth.yaml --insecure
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/two/auth/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/two
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

two-proxy

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-proxy.yaml
Ports
5080:50805023:5023
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/two-proxy/data/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/two-proxy
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

two-node

Configuration

Image
teleport:latest
Command
${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-node.yaml
Volumes
/var/lib/teleport : /portainer/Files/AppData/teleport/two-node/data/root/go/src/github.com/gravitational/teleport : /portainer/Files/AppData/Config/teleport/two-node
Env vars
DEBUG=1CONTAINERHOME=/root/go/src/github.com/gravitational/teleport

Standalone Install

Select an install method, to see config/commands for deploying Teleport

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 Teleport, 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:

services:
  #
  # one is a single-node Teleport cluster called "one" (runs all 3 roles: proxy, auth and node)
  #
  one:
    image: teleport:latest
    container_name: one
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one.yaml
    mem_limit: 300m
    memswap_limit: 0
    ports:
      - "3080:3080"
      - "3023:3023"
      - "3025:3025"
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    volumes:
      - /portainer/Files/AppData/teleport/one/data/one:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/one:/root/go/src/github.com/gravitational/teleport
      - certs:/mnt/shared/certs
    networks:
      teleport:
        ipv4_address: 172.10.1.1
        aliases:
          - one-lb

  #
  # one-node is a single-node Teleport cluster called "one" (runs all 3 roles: proxy, auth and node)
  #
  one-node:
    image: teleport:latest
    container_name: one-node
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one-node.yaml
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    mem_limit: 300m
    volumes:
      - /portainer/Files/AppData/teleport/one-node/data/one-node:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/one-node:/root/go/src/github.com/gravitational/teleport
    networks:
      teleport:
        ipv4_address: 172.10.1.20

  #
  # one-sshd is a single-node Teleport cluster called "one" (runs all 3 roles: proxy, auth and node)
  #
  one-sshd:
    image: teleport:latest
    container_name: one-sshd
    command: /usr/bin/start-sshd.sh
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    mem_limit: 300m
    volumes:
      - /portainer/Files/AppData/teleport/one-sshd/pam.d/ssh:/etc/pam.d/ssh
      - /portainer/Files/AppData/Config/teleport/one-sshd:/etc/ssh/sshd_config
      - certs:/mnt/shared/certs
    networks:
      teleport:
        ipv4_address: 172.10.1.21

  #
  # one-proxy is a second xproxy of the first cluster
  #
  one-proxy:
    image: teleport:latest
    container_name: one-proxy
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/one-proxy.yaml
    mem_limit: 300m
    ports:
      - "4080:3080"
      - "4023:3023"
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    volumes:
      - /portainer/Files/AppData/teleport/one-proxy:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/one-proxy:/root/go/src/github.com/gravitational/teleport
    networks:
      teleport:
        ipv4_address: 172.10.1.10
        aliases:
          - one-lb

  #
  # two-auth is a auth server of the second cluster
  #
  two-auth:
    mem_limit: 300m
    image: teleport:latest
    container_name: two-auth
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-auth.yaml --insecure
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    volumes:
      - /portainer/Files/AppData/teleport/two/auth:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/two:/root/go/src/github.com/gravitational/teleport
    networks:
      teleport:
        ipv4_address: 172.10.1.2

  #
  # two-proxy is a proxy service for the second cluster
  #
  two-proxy:
    mem_limit: 300m
    image: teleport:latest
    container_name: two-proxy
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-proxy.yaml
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    ports:
      - "5080:5080"
      - "5023:5023"
    volumes:
      - /portainer/Files/AppData/teleport/two-proxy/data:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/two-proxy:/root/go/src/github.com/gravitational/teleport
    networks:
      teleport:
        ipv4_address: 172.10.1.3

  #
  # two-node is a node service for the second cluster
  #
  two-node:
    mem_limit: 300m
    image: teleport:latest
    container_name: two-node
    command: ${CONTAINERHOME}/build/teleport start -d -c ${CONTAINERHOME}/docker/two-node.yaml
    environment:
      DEBUG: 1
      CONTAINERHOME: /root/go/src/github.com/gravitational/teleport
    #env_file: ./teleportenv.file
    volumes:
      - /portainer/Files/AppData/teleport/two-node/data:/var/lib/teleport
      - /portainer/Files/AppData/Config/teleport/two-node:/root/go/src/github.com/gravitational/teleport
    networks:
      teleport:
        ipv4_address: 172.10.1.4

networks:
  teleport:
    driver: bridge
    ipam:
      driver: default
      config:
      - subnet: 172.10.1.0/16
        ip_range: 172.10.1.0/24
        gateway: 172.10.1.254

volumes:
  certs:

Or deploy it directly from the source:

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

More install options in our documentation.

Serve Teleport 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 teleport.example.com to http://one:3080

Add this to your Caddyfile

teleport.example.com {
	reverse_proxy http://one:3080
}

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:3080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3080
  • Stop the other service, or pick a different host port. In 3080:3080 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:3080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, teleport can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3080

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/teleport/one/data/one (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull teleport: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 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 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

Teleport is a Compose stack, a set of containers (7 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 7 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • one runs teleport:latest
  • one-node runs teleport:latest
  • one-sshd runs teleport:latest
  • one-proxy runs teleport:latest
  • two-auth runs teleport:latest
  • two-proxy runs teleport:latest
  • two-node runs teleport:latest

Ports

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

  • 3080:3080
  • 3023:3023
  • 3025:3025
  • 4080:3080
  • 4023:3023
  • 5080:5080
  • 5023:5023

Volumes

A volume is where Teleport 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:

  • /var/lib/teleport from /portainer/Files/AppData/teleport/one/data/one on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/one on the host
  • /mnt/shared/certs kept in the certs volume Docker manages
  • /var/lib/teleport from /portainer/Files/AppData/teleport/one-node/data/one-node on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/one-node on the host
  • /etc/pam.d/ssh from /portainer/Files/AppData/teleport/one-sshd/pam.d/ssh on the host
  • /etc/ssh/sshd_config from /portainer/Files/AppData/Config/teleport/one-sshd on the host
  • /var/lib/teleport from /portainer/Files/AppData/teleport/one-proxy on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/one-proxy on the host
  • /var/lib/teleport from /portainer/Files/AppData/teleport/two/auth on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/two on the host
  • /var/lib/teleport from /portainer/Files/AppData/teleport/two-proxy/data on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/two-proxy on the host
  • /var/lib/teleport from /portainer/Files/AppData/teleport/two-node/data on the host
  • /root/go/src/github.com/gravitational/teleport from /portainer/Files/AppData/Config/teleport/two-node on the host

Environment variables

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

  • DEBUG, defaults to 1
  • CONTAINERHOME, defaults to /root/go/src/github.com/gravitational/teleport

Restart policy

The restart policy here is always, so Docker brings Teleport 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

Portainer puts these services on one shared private network, so they can find each other by name (like one) 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 Teleport up. Add the template list to Portainer once, then deploying Teleport is a click rather than a wall of config.