Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

admin: Add CADDY_ADMIN env var to override the default #5332

Merged
merged 2 commits into from
Feb 6, 2023
Merged

admin: Add CADDY_ADMIN env var to override the default #5332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5adf930
admin: Add `CADDY_ADMIN` env var to override the default
francislavoie Jan 25, 2023
c2008e1
Merge branch 'master' into admin-address-env-var
mholt Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion admin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ import (
"go.uber.org/zap/zapcore"
)

func init() {
// The hard-coded default `DefaultAdminListen` can be overidden
// by setting the `CADDY_ADMIN` environment variable.
// The environment variable may be used by packagers to change
// the default admin address to something more appropriate for
// that platform. See #5317 for discussion.
if env, exists := os.LookupEnv("CADDY_ADMIN"); exists {
DefaultAdminListen = env
}
}

// AdminConfig configures Caddy's API endpoint, which is used
// to manage Caddy while it is running.
type AdminConfig struct {
Expand All @@ -57,7 +68,9 @@ type AdminConfig struct {

// The address to which the admin endpoint's listener should
// bind itself. Can be any single network address that can be
// parsed by Caddy. Accepts placeholders. Default: localhost:2019
// parsed by Caddy. Accepts placeholders.
// Default: the value of the `CADDY_ADMIN` environment variable,
// or `localhost:2019` otherwise.
Listen string `json:"listen,omitempty"`

// If true, CORS headers will be emitted, and requests to the
Expand Down