Skip to content

Latest commit

 

History

History
211 lines (147 loc) · 4.1 KB

README.md

File metadata and controls

211 lines (147 loc) · 4.1 KB

FTL (Faster Than Light) Deployment

FTL is a lightweight deployment tool designed to simplify cloud deployments without the complexity of traditional CI/CD pipelines or container orchestration platforms. It provides automated, zero-downtime deployments through a single YAML configuration file.

For comprehensive documentation, visit https://ftl-deploy.org

Features

  • Zero-downtime deployments with automated health checks
  • Single YAML configuration with environment variable support
  • Built-in Nginx reverse proxy with automatic SSL/TLS certificate management
  • Docker-based deployment with layer-optimized transfers
  • Real-time log streaming and monitoring
  • Secure SSH tunneling for remote dependencies

Requirements

  • Docker installed locally for building images
  • SSH access to target deployment servers
  • Git for version control
  • Go 1.16+ (only if building from source)

Installation

Choose one of the following installation methods:

Via Homebrew (macOS and Linux)

brew tap yarlson/ftl
brew install ftl

Direct Download

curl -L https://github.com/yarlson/ftl/releases/latest/download/ftl_$(uname -s)_$(uname -m).tar.gz | tar xz
sudo mv ftl /usr/local/bin/

Build from Source

go install github.com/yarlson/ftl@latest

Verify Installation

After installing FTL, verify it's working correctly by checking the version:

ftl version

Configuration

Create an ftl.yaml file in your project root:

project:
  name: my-project
  domain: my-project.example.com
  email: [email protected]

server:
  host: my-project.example.com
  user: my-project
  ssh_key: ~/.ssh/id_rsa

services:
  - name: web
    path: ./src
    port: 80
    health_check:
      path: /
    routes:
      - path: /

dependencies:
  - "postgres:16" # Using short notation
  - name: redis # Using detailed definition
    image: redis:7
    volumes:
      - redis_data:/custom/redis/path
    env:
      - REDIS_PASSWORD=${REDIS_PASSWORD:-secret}

volumes:
  - redis_data

Environment Variables

  • Required variables: Use ${VAR_NAME}
  • Optional variables with defaults: Use ${VAR_NAME:-default_value}

Usage

Server Setup

ftl setup

Building Applications

FTL supports two deployment modes:

  1. Direct SSH Transfer (Default):
services:
  - name: web
    path: ./src # Path to directory containing Dockerfile
  1. Registry-based Deployment:
services:
  - name: web
    image: registry.example.com/my-app:latest
    path: ./src

Build command:

ftl build [--skip-push]

Deployment

ftl deploy

Log Management

# Stream all logs
ftl logs -f

# View specific service logs
ftl logs my-app -n 150

SSH Tunnels

# Create tunnels for all dependencies
ftl tunnels

Development

# Clone repository
git clone https://github.com/yarlson/ftl.git

# Install dependencies
cd ftl
go mod download

# Run tests
go test ./...

Example Projects

Visit our ftl-examples repository for complete implementation examples:

Troubleshooting

Common Issues

  1. Registry Authentication Failures

    • FTL currently supports only username/password authentication
    • Token-based authentication is not supported

  2. SSH Connection Issues

    • Verify SSH key permissions
    • Ensure server firewall allows connections
    • Check user permissions on target server

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Please ensure:

  • Code follows project style guidelines
  • All tests pass
  • Documentation is updated
  • Commit messages are clear and descriptive

Security

Report security vulnerabilities by opening an issue with the "security" label. We take all security reports seriously and will respond promptly.

License

This project is licensed under the MIT License - see the LICENSE file for details.