🔒 Docker SFTP/SSH Gateway for Kubernetes

Secure SSH/SFTP gateway providing direct access to Kubernetes pods using GitHub authentication and permissions.

✨ Features

• 🔐 GitHub-based authentication using SSH keys
• 🚀 Direct SSH/SFTP access to Kubernetes pods
• 👥 Role-based access control tied to GitHub permissions
• 📊 Container state management via Firebase
• 🔄 Real-time state synchronization
• 🧹 Automatic cleanup of terminated containers
• 🔍 Detailed access logging

🚀 Quick Start

Prerequisites

1. Access to a Kubernetes cluster with kubectl configured
2. GitHub token with repo access permissions

Local Development

Run with Docker for local testing:

# Get cluster credentials
KUBE_ENDPOINT=$(kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}')
KUBE_TOKEN=$(kubectl get secret $(kubectl get sa default -n default -o jsonpath='{.secrets[0].name}') \
  -o jsonpath='{.data.token}' | base64 -d)

# Run container
docker run -d \
  --name sftp-gateway \
  -p 2222:22 \
  -e KUBERNETES_CLUSTER_ENDPOINT=$KUBE_ENDPOINT \
  -e KUBERNETES_CLUSTER_USER_TOKEN=$KUBE_TOKEN \
  -e ACCESS_TOKEN=$GITHUB_TOKEN \
  udx/docker-sftp

For production deployment, see Deployment Guide.

See Environment Variables for auth setup and Deployment Guide for production deployment.

2. Connect to Pods

# Interactive shell
ssh pod-myapp@sftp.company.com

# Transfer files
scp file pod-myapp@sftp.company.com:/path/

See Client Guide for SSH config and advanced usage.

📚 Documentation

Core Concepts

• Architecture - System design and components
• API Reference - HTTP API endpoints

Setup & Configuration

• Deployment Guide - Deployment options and setup
• Environment Variables - Configuration reference
• User Management - Access control

Help

• Client Guide - Usage examples
• Troubleshooting - Common issues

🤝 Contributing

• Bug Reports & Features: Use GitHub Issues
• Security Reports: Email security@udx.io
• Pull Requests: Fork and submit PRs

📄 License

Proprietary software. All rights reserved.