Free and open-source software that starts workloads on demand and stops them after a period of inactivity.

Whether you don't want to overload your Raspberry Pi, or your QA environment is used only once a week and wastes resources by keeping workloads running, Sablier might be the solution you need.

• Installation
  • Use the Docker image
  • Use the binary distribution
  • Compile your binary from the sources
  • Use the Helm Chart
• Configuration
  • Configuration File
  • Environment Variables
  • Arguments
• Providers
  • Docker
  • Docker Swarm
  • Podman
  • Kubernetes
• Usage with Reverse Proxies
  • Apache APISIX
  • Caddy
  • Envoy
  • Istio
  • Nginx
  • Traefik
• Community
• Support
• Sponsor
  • DigitalOcean

You can install Sablier using one of the following methods:

• Use the Docker image
• Use the binary distribution
• Compile your binary from the sources
• Use the Helm Chart

• Docker Hub: sablierapp/sablier
• GitHub Container Registry: ghcr.io/sablierapp/sablier

Choose one of the Docker images and run it with a sample configuration file:

• sablier.yaml

docker run -d -p 10000:10000 -v sablier.yaml:/etc/sablier/sablier.yaml sablierapp/sablier:1.10.2

Grab the latest binary from the releases page and run it:

./sablier --help

git clone git@github.com:sablierapp/sablier.git
cd sablier
make
# Output will change depending on your distro
./sablier_draft_linux-amd64

Deploy Sablier to your Kubernetes cluster using the official Helm chart for production-ready deployments.

Add the Sablier Helm repository:

helm repo add sablierapp https://sablierapp.github.io/helm-charts
helm repo update

Install Sablier:

helm install sablier sablierapp/sablier

📚 Full Documentation | 💻 Chart Repository

There are three ways to configure Sablier:

1. In a configuration file
2. As environment variables
3. As command-line arguments

Configuration sources are evaluated in the order listed above.

If no value is provided for a given option, a default value is used.

At startup, Sablier searches for a configuration file named sablier.yml (or sablier.yaml) in:

• /etc/sablier/
• $XDG_CONFIG_HOME/
• $HOME/.config/
• . (the working directory)

You can override this using the configFile argument.

sablier --configFile=path/to/myconfigfile.yml

provider:
  # Provider to use to manage containers (docker, swarm, kubernetes)
  name: docker 
server:
  # The server port to use
  port: 10000 
  # The base path for the API
  base-path: /
storage:
  # File path to save the state (default stateless)
  file:
sessions:
  # The default session duration (default 5m)
  default-duration: 5m
  # The expiration checking interval. 
  # Higher duration gives less stress on CPU. 
  # If you only use sessions of 1h, setting this to 5m is a good trade-off.
  expiration-interval: 20s
logging:
  level: debug
strategy:
  dynamic:
    # Custom themes folder, will load all .html files recursively (default empty)
    custom-themes-path:
    # Show instances details by default in waiting UI
    show-details-by-default: false
    # Default theme used for dynamic strategy (default "hacker-terminal")
    default-theme: hacker-terminal
    # Default refresh frequency in the HTML page for dynamic strategy
    default-refresh-frequency: 5s
  blocking:
    # Default timeout used for blocking strategy (default 1m)
    default-timeout: 1m

Environment variables follow the same structure as the configuration file. For example:

strategy:
  dynamic:
    custom-themes-path: /my/path

becomes

STRATEGY_DYNAMIC_CUSTOM_THEMES_PATH=/my/path

To list all available arguments:

sablier --help

# or

docker run sablierapp/sablier:1.10.1 --help

Command-line arguments follow the same structure as the configuration file. For example:

strategy:
  dynamic:
    custom-themes-path: /my/path

becomes

sablier start --strategy.dynamic.custom-themes-path /my/path

Sablier integrates seamlessly with Docker Engine to manage container lifecycle based on demand.

Features:

• Start and stop containers automatically
• Scale containers based on HTTP traffic
• Works with Docker Compose deployments

📚 Full Documentation

Sablier supports Docker Swarm mode for managing services across a cluster of Docker engines.

Features:

• Scale Swarm services on demand
• Distributed scaling across multiple nodes
• Seamless integration with Docker Swarm orchestration

📚 Full Documentation

Sablier works with Podman, the daemonless container engine, providing the same dynamic scaling capabilities as Docker.

Features:

• Rootless container management
• Docker-compatible API integration
• Seamless migration from Docker

📚 Full Documentation

Sablier provides native Kubernetes support for managing deployments, scaling workloads dynamically.

Features:

• Scale Kubernetes deployments and statefulsets
• Works with any Kubernetes cluster
• Label-based workload selection

📚 Full Documentation

Sablier integrates with Apache APISIX through a Proxy-WASM plugin, enabling dynamic scaling for your services.

Quick Start:

1. Install the Sablier Proxy-WASM plugin
2. Configure APISIX routes with Sablier plugin settings
3. Define your scaling labels on target services

📚 Full Documentation | 💻 Plugin Repository

Sablier provides a native Caddy module for seamless integration with Caddy v2.

Quick Start:

1. Build Caddy with the Sablier module using xcaddy
2. Add Sablier directives to your Caddyfile
3. Configure dynamic scaling rules

📚 Full Documentation | 💻 Plugin Repository

Sablier integrates with Envoy Proxy through a Proxy-WASM plugin for high-performance dynamic scaling.

Quick Start:

1. Deploy the Sablier Proxy-WASM plugin
2. Configure Envoy HTTP filters
3. Set up scaling labels on your workloads

📚 Full Documentation | 💻 Plugin Repository

Sablier works with Istio service mesh using the Proxy-WASM plugin for intelligent traffic management.

Quick Start:

1. Install the Sablier Proxy-WASM plugin in your Istio mesh
2. Configure EnvoyFilter resources
3. Annotate your services with Sablier labels

📚 Full Documentation | 💻 Plugin Repository

Sablier integrates with Nginx through a WASM module, bringing dynamic scaling to your Nginx deployments.

Quick Start:

1. Build Nginx with WASM support
2. Load the Sablier Proxy-WASM plugin
3. Configure Nginx locations with Sablier directives

📚 Full Documentation | 💻 Plugin Repository

Sablier provides a powerful middleware plugin for Traefik, the cloud-native application proxy.

Quick Start:

1. Add the Sablier plugin to your Traefik static configuration
2. Create Sablier middleware in your dynamic configuration
3. Apply the middleware to your routes

📚 Full Documentation | 💻 Plugin Repository

Join our Discord server to discuss and get support!

This project is maintained by a single developer in their free time. If you find Sablier useful, here are some ways you can show your support:

⭐ Star the repository - It helps others discover the project and motivates continued development

🤝 Contribute - Pull requests are always welcome! Whether it's:

• Bug fixes
• New features
• Documentation improvements
• Test coverage

📚 Share your usage - We'd love to see how you're using Sablier! Consider:

• Opening a discussion to share your setup
• Contributing examples of your deployment configurations
• Writing a blog post or tutorial

💬 Engage with the community - Ask questions, report issues, or help others in discussions

Every contribution, no matter how small, makes a difference and is greatly appreciated! 🙏

For detailed support options, see SUPPORT.md.

If you find Sablier valuable and want to support its development, please consider sponsoring the project:

💖 Sponsor on GitHub - Your sponsorship helps keep this project maintained and actively developed

Your support helps:

• Keep the project maintained and up-to-date
• Dedicate more time to bug fixes and new features
• Improve documentation and examples
• Support the broader open-source ecosystem

Every contribution, no matter the size, makes a real difference. Thank you for considering! 🙏

This project is supported by: