Idle-sleep

TL;DR

Set idle_timeout to automatically sleep idle containers and wake them on traffic. Saves resources for infrequently used services.

• Providers supported: Docker and Proxmox LXCs
• Protocols supported: HTTP, TCP, and UDP

How?

GoDoxy puts containers to sleep after inactivity and wakes them when traffic arrives.

Dependencies

Containers with depends_on are managed together:

• Sleep: Main container stops first, then dependencies
• Wake: Dependencies start first, then main container

WARNING

Do not set idle_timeout on dependencies.

Condition

Control when dependencies are ready:

• service_started (default) — dependency started
• service_healthy — dependency healthy (requires healthcheck)

Supports Docker Compose depends_on conditions (see Docker compose docs for more details):

# without conditions (implies `service_started`)
depends_on:
  - redis
  - postgres

# with conditions
depends_on:
  redis:
    condition: service_healthy
  postgres:
    condition: service_started

Specifying with labels is also supported, e.g.

labels:
  proxy.depends_on: |
    - redis:service_healthy
    - postgres:service_started

Full idle-sleep example snippet

services:
  app:
    image: example/app
    labels:
      proxy.idle_timeout: 1h30s
    depends_on:
      redis:
        condition: service_healthy
      postgres:
        condition: service_started

Configuration

Label	Description	Example	Default	Accepted values
idle_timeout	inactivity timeout before put it into sleep	1h30s	empty (disabled)	number[unit]...
wake_timeout	time to wait for target site to be ready		30s	number[unit]...
stop_method	method to stop after idle_timeout		stop	stop, pause, kill
stop_timeout	time to wait for stop command		10s	number[unit]...
stop_signal	signal sent to container for stop and kill methods		docker's default	SIGINT, SIGTERM, SIGHUP, SIGQUIT and those without SIG prefix
start_endpoint	allow waking only from specific endpoint	/start	empty (allow any)	relative URI
depends_on	container to wait and wake/stop together		depends_on field from docker compose file	alias or docker compose service[:condition]
no_loading_page	disable loading page when waking up from sleep		false	boolean

Docker

To enable idlesleep, add the following label(s) to your container:

# compose.yml
services:
  app:
    image: abcd
    ...
    labels:
      proxy.idle_timeout: 1h30s     # required
      proxy.wake_timeout: 30s       # optional
      proxy.stop_method: stop       # optional
      proxy.stop_timeout: 10s       # optional
      proxy.stop_signal: SIGINT     # optional
      proxy.start_endpoint: /start  # optional
      proxy.no_loading_page: true   # optional
    depends_on:
      redis:
        condition: service_healthy
      postgres:
        condition: service_healthy
  redis:
    ...
    healthcheck: # with docker healthcheck
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5
  postgres: # with GoDoxy healthcheck
    ...

Proxmox LXCs

To setup GoDoxy to manage proxmox LXCs. You need to do the following:

1. Add proxmox credentials to config.yml

   # config.yml
   providers:
     proxmox:
       - url: https://pve.domain.com:8006/api2/json
         token_id: root@pam!abcdef
         secret: aaaa-bbbb-cccc-dddd
         no_tls_verify: true

2. Create API Token on Proxmox

   

3. Allow required permissions

   

4. Add LXCs to route files

   Node Name:

   

   VMID:

   

   lxc-test:
     port: 3000
     idlewatcher:
       idle_timeout: 15s
       proxmox:
         node: pve
         vmid: 119
       depends_on:
         - lxc-db
   lxc-db: ...