teleport Installation Guide Installation Guide

teleport is a free and open-source access plane. Gravitational Teleport provides zero trust access

Hardware Requirements:

CPU: 2+ cores

RAM: 4GB minimum

Storage: 10GB for audit

Network: HTTPS/SSH

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 3023 (default teleport port)

Various services

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install teleport
sudo dnf install -y teleport

# Enable and start service
sudo systemctl enable --now teleport

# Configure firewall
sudo firewall-cmd --permanent --add-port=3023/tcp
sudo firewall-cmd --reload

# Verify installation
teleport --version

bash

# Update package index
sudo apt update

# Install teleport
sudo apt install -y teleport

# Enable and start service
sudo systemctl enable --now teleport

# Configure firewall
sudo ufw allow 3023

# Verify installation
teleport --version

bash

# Install teleport
sudo pacman -S teleport

# Enable and start service
sudo systemctl enable --now teleport

# Verify installation
teleport --version

bash

# Install teleport
apk add --no-cache teleport

# Enable and start service
rc-update add teleport default
rc-service teleport start

# Verify installation
teleport --version

bash

# Install teleport
sudo zypper install -y teleport

# Enable and start service
sudo systemctl enable --now teleport

# Configure firewall
sudo firewall-cmd --permanent --add-port=3023/tcp
sudo firewall-cmd --reload

# Verify installation
teleport --version

bash

# Using Homebrew
brew install teleport

# Start service
brew services start teleport

# Verify installation
teleport --version

bash

# Using pkg
pkg install teleport

# Enable in rc.conf
echo 'teleport_enable="YES"' >> /etc/rc.conf

# Start service
service teleport start

# Verify installation
teleport --version

bash

# Using Chocolatey
choco install teleport

# Or using Scoop
scoop install teleport

# Verify installation
teleport --version

bash

# Create configuration directory
sudo mkdir -p /etc/teleport

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
teleport --version

bash

# Enable service
sudo systemctl enable teleport

# Start service
sudo systemctl start teleport

# Stop service
sudo systemctl stop teleport

# Restart service
sudo systemctl restart teleport

# Check status
sudo systemctl status teleport

# View logs
sudo journalctl -u teleport -f

bash

# Enable service
rc-update add teleport default

# Start service
rc-service teleport start

# Stop service
rc-service teleport stop

# Restart service
rc-service teleport restart

# Check status
rc-service teleport status

bash

# Enable in /etc/rc.conf
echo 'teleport_enable="YES"' >> /etc/rc.conf

# Start service
service teleport start

# Stop service
service teleport stop

# Restart service
service teleport restart

# Check status
service teleport status

bash

# Using Homebrew services
brew services start teleport
brew services stop teleport
brew services restart teleport

# Check status
brew services list | grep teleport

powershell

# Start service
net start teleport

# Stop service
net stop teleport

# Using PowerShell
Start-Service teleport
Stop-Service teleport
Restart-Service teleport

# Check status
Get-Service teleport

See the official documentation for advanced configuration options.

nginx

upstream teleport_backend {
    server 127.0.0.1:3023;
}

server {
    listen 80;
    server_name teleport.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name teleport.example.com;

    ssl_certificate /etc/ssl/certs/teleport.example.com.crt;
    ssl_certificate_key /etc/ssl/private/teleport.example.com.key;

    location / {
        proxy_pass http://teleport_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName teleport.example.com
    Redirect permanent / https://teleport.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName teleport.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/teleport.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/teleport.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:3023/
    ProxyPassReverse / http://127.0.0.1:3023/
</VirtualHost>

haproxy

frontend teleport_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/teleport.pem
    redirect scheme https if !{ ssl_fc }
    default_backend teleport_backend

backend teleport_backend
    balance roundrobin
    server teleport1 127.0.0.1:3023 check

bash

# Set appropriate permissions
sudo chown -R teleport:teleport /etc/teleport
sudo chmod 750 /etc/teleport

# Configure firewall
sudo firewall-cmd --permanent --add-port=3023/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status teleport

# View logs
sudo journalctl -u teleport -f

# Monitor resource usage
top -p $(pgrep teleport)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/teleport"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/teleport-backup-$DATE.tar.gz" /etc/teleport /var/lib/teleport

echo "Backup completed: $BACKUP_DIR/teleport-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop teleport

# Restore from backup
tar -xzf /backup/teleport/teleport-backup-*.tar.gz -C /

# Start service
sudo systemctl start teleport

1. Service won't start:

bash

# Check logs
sudo journalctl -u teleport -n 100
sudo tail -f /var/log/teleport/teleport.log

# Check configuration
teleport --version

# Check permissions
ls -la /etc/teleport

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 3023

# Test connectivity
telnet localhost 3023

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep teleport)

# Check disk I/O
iotop -p $(pgrep teleport)

# Check connections
ss -an | grep 3023

yaml

version: '3.8'
services:
  teleport:
    image: teleport:latest
    ports:
      - "3023:3023"
    volumes:
      - ./config:/etc/teleport
      - ./data:/var/lib/teleport
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update teleport

# Debian/Ubuntu
sudo apt update && sudo apt upgrade teleport

# Arch Linux
sudo pacman -Syu teleport

# Alpine Linux
apk update && apk upgrade teleport

# openSUSE
sudo zypper update teleport

# FreeBSD
pkg update && pkg upgrade teleport

# Always backup before updates
tar -czf /backup/teleport-pre-update-$(date +%Y%m%d).tar.gz /etc/teleport

# Restart after updates
sudo systemctl restart teleport

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/teleport

# Clean old logs
find /var/log/teleport -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/teleport

Official Documentation: https://docs.teleport.org/

GitHub Repository: https://github.com/teleport/teleport

Community Forum: https://forum.teleport.org/

Best Practices Guide: https://docs.teleport.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Remote access Guides

guacamole Installation Guide

kasm Installation Guide

meshcentral Installation Guide