Caddy Sablier Plugin

Start your containers on demand, shut them down automatically when there's no activity using Caddy.

• Installation
• Usage
• Configuration
  • Minimal configuration
• Other Plugins
• Community
• Support

See the official module page.

Installation

This plugin does not come with a pre-built version of Caddy (see #10).

You must build a custom version of Caddy with this plugin. See building from source for more information.

Dockerfile Example:

FROM caddy:2.10.2-builder AS builder

RUN xcaddy build \
    --with github.com/sablierapp/sablier-caddy-plugin@v1.0.2 # x-release-please-version

FROM caddy:2.10.2

COPY --from=builder /usr/bin/caddy /usr/bin/caddy

Usage

See the docker example on how to use the plugin.

Configuration

You can have the following configuration:

:80 {
	route /my/route {
    sablier [<sablierURL>=http://sablier:10000] {
			[names container1,container2,...]
			[group mygroup]
			[session_duration 30m]
			dynamic {
				[display_name This is my display name]
				[show_details yes|true|on]
				[theme hacker-terminal]
				[refresh_frequency 2s]
			}
			blocking {
				[timeout 1m]
			}
		}
    reverse_proxy myservice:port
  }
}

Minimal configuration

Almost all options are optional and you can setup very simple rules to use the server default values.

:80 {
	route /my/route {
    sablier {
			group mygroup
			dynamic
		}
    reverse_proxy myservice:port
  }
}

Other Plugins

• sablier-traefik-plugin
• sablier-proxywasm-plugin

Community

Join our Discord server to discuss and get support!

Support

See SUPPORT.md