ephemerd/config.example.toml at main · ephpm/ephemerd · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
[github]
# Authentication: personal access token OR GitHub App credentials.
# Use one approach — if app_id is set, it takes priority over token.
# token = "ghp_your_token_here"

# GitHub App authentication (recommended):
# app_id = 123456
# installation_id = 789012
# private_key_path = "/path/to/app.pem"

# Organization or user that owns the repos
owner = "your-org"

# Repos to register runners for (optional).
# If omitted, registers org-level runners available to all repos in the org.
# repos = ["repo1", "repo2"]

[webhook]
# By default, ephemerd polls the GitHub API every 10s for new jobs.
# No inbound ports or tunnels required.

# To use localtunnel for instant webhook delivery:
# tunnel = "localtunnel"
# tunnel_url = "http://tunnels.example.com"   # self-hosted server (recommended)

# To use ngrok instead (requires free account):
# tunnel = "ngrok"
# ngrok_authtoken = "your_ngrok_token"   # or set NGROK_AUTHTOKEN env var

# To use direct TLS instead of a tunnel (VPS with a public IP):
# tunnel = "none"
# tls_cert = "/etc/ephemerd/tls.crt"
# tls_key = "/etc/ephemerd/tls.key"
# secret = "your_webhook_secret"   # must be stable when not using a tunnel
# port = 8080

[network]
# Container subnet. Ephemerd auto-picks a free subnet if this conflicts with
# an existing network (e.g. Podman, Docker). You don't need to change this.
# subnet = "10.88.0.0/16"

# Bridge MTU. Auto-detected from the host's default interface.
# Override if containers have connectivity issues on unusual networks.
# mtu = 1500

[runner]

# Max concurrent jobs
max_concurrent = 4

# Default container image for jobs that don't specify `container:` in the workflow.
# Leave blank to auto-detect:
#   Linux  → ghcr.io/actions/actions-runner:latest
#   Windows → mcr.microsoft.com/windows/servercore:ltsc20XX (matched to host OS)
# default_image = ""

# Extra labels applied to all runners (in addition to self-hosted, os, arch)
extra_labels = []

# Max time a job can run before forced teardown
job_timeout = "2h"

# Time to wait for running jobs during graceful shutdown
shutdown_timeout = "5m"

[vm.linux]
# Enable a Linux VM for running Linux jobs on Windows/macOS hosts.
# On Windows: creates a WSL2 distro with an embedded ephemerd binary.
# The distro is destroyed on shutdown. Requires WSL2 to be installed.
# enabled = false
# cpus = 2
# memory_mb = 2048

[metrics]
# Enable Prometheus metrics endpoint. Disabled by default.
# enabled = true
# port = 9090
# path = "/metrics"

# Optional TLS for the metrics endpoint
# tls_cert = "/etc/ephemerd/metrics.crt"
# tls_key = "/etc/ephemerd/metrics.key"

[log]
# Log level: debug, info, warn, error
level = "info"

# Log format: text or json
format = "text"

# How long to keep job log files before automatic cleanup.
# Supports Go durations (e.g. "168h") and a "d" shorthand (e.g. "7d").
# log_retention = "7d"