mirror of https://github.com/coder/coder.git
1827 lines
72 KiB
Go
1827 lines
72 KiB
Go
package codersdk
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"flag"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"golang.org/x/mod/semver"
|
|
"golang.org/x/xerrors"
|
|
|
|
"github.com/coreos/go-oidc/v3/oidc"
|
|
|
|
"github.com/coder/coder/buildinfo"
|
|
"github.com/coder/coder/cli/clibase"
|
|
)
|
|
|
|
// Entitlement represents whether a feature is licensed.
|
|
type Entitlement string
|
|
|
|
const (
|
|
EntitlementEntitled Entitlement = "entitled"
|
|
EntitlementGracePeriod Entitlement = "grace_period"
|
|
EntitlementNotEntitled Entitlement = "not_entitled"
|
|
)
|
|
|
|
// FeatureName represents the internal name of a feature.
|
|
// To add a new feature, add it to this set of enums as well as the FeatureNames
|
|
// array below.
|
|
type FeatureName string
|
|
|
|
const (
|
|
FeatureUserLimit FeatureName = "user_limit"
|
|
FeatureAuditLog FeatureName = "audit_log"
|
|
FeatureBrowserOnly FeatureName = "browser_only"
|
|
FeatureSCIM FeatureName = "scim"
|
|
FeatureTemplateRBAC FeatureName = "template_rbac"
|
|
FeatureHighAvailability FeatureName = "high_availability"
|
|
FeatureMultipleGitAuth FeatureName = "multiple_git_auth"
|
|
FeatureExternalProvisionerDaemons FeatureName = "external_provisioner_daemons"
|
|
FeatureAppearance FeatureName = "appearance"
|
|
FeatureAdvancedTemplateScheduling FeatureName = "advanced_template_scheduling"
|
|
FeatureWorkspaceProxy FeatureName = "workspace_proxy"
|
|
)
|
|
|
|
// FeatureNames must be kept in-sync with the Feature enum above.
|
|
var FeatureNames = []FeatureName{
|
|
FeatureUserLimit,
|
|
FeatureAuditLog,
|
|
FeatureBrowserOnly,
|
|
FeatureSCIM,
|
|
FeatureTemplateRBAC,
|
|
FeatureHighAvailability,
|
|
FeatureMultipleGitAuth,
|
|
FeatureExternalProvisionerDaemons,
|
|
FeatureAppearance,
|
|
FeatureAdvancedTemplateScheduling,
|
|
FeatureWorkspaceProxy,
|
|
}
|
|
|
|
// Humanize returns the feature name in a human-readable format.
|
|
func (n FeatureName) Humanize() string {
|
|
switch n {
|
|
case FeatureTemplateRBAC:
|
|
return "Template RBAC"
|
|
case FeatureSCIM:
|
|
return "SCIM"
|
|
default:
|
|
return strings.Title(strings.ReplaceAll(string(n), "_", " "))
|
|
}
|
|
}
|
|
|
|
// AlwaysEnable returns if the feature is always enabled if entitled.
|
|
// Warning: We don't know if we need this functionality.
|
|
// This method may disappear at any time.
|
|
func (n FeatureName) AlwaysEnable() bool {
|
|
return map[FeatureName]bool{
|
|
FeatureMultipleGitAuth: true,
|
|
FeatureExternalProvisionerDaemons: true,
|
|
FeatureAppearance: true,
|
|
}[n]
|
|
}
|
|
|
|
type Feature struct {
|
|
Entitlement Entitlement `json:"entitlement"`
|
|
Enabled bool `json:"enabled"`
|
|
Limit *int64 `json:"limit,omitempty"`
|
|
Actual *int64 `json:"actual,omitempty"`
|
|
}
|
|
|
|
type Entitlements struct {
|
|
Features map[FeatureName]Feature `json:"features"`
|
|
Warnings []string `json:"warnings"`
|
|
Errors []string `json:"errors"`
|
|
HasLicense bool `json:"has_license"`
|
|
Trial bool `json:"trial"`
|
|
RequireTelemetry bool `json:"require_telemetry"`
|
|
}
|
|
|
|
func (c *Client) Entitlements(ctx context.Context) (Entitlements, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/entitlements", nil)
|
|
if err != nil {
|
|
return Entitlements{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
if res.StatusCode != http.StatusOK {
|
|
return Entitlements{}, ReadBodyAsError(res)
|
|
}
|
|
var ent Entitlements
|
|
return ent, json.NewDecoder(res.Body).Decode(&ent)
|
|
}
|
|
|
|
// DeploymentValues is the central configuration values the coder server.
|
|
type DeploymentValues struct {
|
|
Verbose clibase.Bool `json:"verbose,omitempty"`
|
|
AccessURL clibase.URL `json:"access_url,omitempty"`
|
|
WildcardAccessURL clibase.URL `json:"wildcard_access_url,omitempty"`
|
|
RedirectToAccessURL clibase.Bool `json:"redirect_to_access_url,omitempty"`
|
|
// HTTPAddress is a string because it may be set to zero to disable.
|
|
HTTPAddress clibase.String `json:"http_address,omitempty" typescript:",notnull"`
|
|
AutobuildPollInterval clibase.Duration `json:"autobuild_poll_interval,omitempty"`
|
|
DERP DERP `json:"derp,omitempty" typescript:",notnull"`
|
|
Prometheus PrometheusConfig `json:"prometheus,omitempty" typescript:",notnull"`
|
|
Pprof PprofConfig `json:"pprof,omitempty" typescript:",notnull"`
|
|
ProxyTrustedHeaders clibase.StringArray `json:"proxy_trusted_headers,omitempty" typescript:",notnull"`
|
|
ProxyTrustedOrigins clibase.StringArray `json:"proxy_trusted_origins,omitempty" typescript:",notnull"`
|
|
CacheDir clibase.String `json:"cache_directory,omitempty" typescript:",notnull"`
|
|
InMemoryDatabase clibase.Bool `json:"in_memory_database,omitempty" typescript:",notnull"`
|
|
PostgresURL clibase.String `json:"pg_connection_url,omitempty" typescript:",notnull"`
|
|
OAuth2 OAuth2Config `json:"oauth2,omitempty" typescript:",notnull"`
|
|
OIDC OIDCConfig `json:"oidc,omitempty" typescript:",notnull"`
|
|
Telemetry TelemetryConfig `json:"telemetry,omitempty" typescript:",notnull"`
|
|
TLS TLSConfig `json:"tls,omitempty" typescript:",notnull"`
|
|
Trace TraceConfig `json:"trace,omitempty" typescript:",notnull"`
|
|
SecureAuthCookie clibase.Bool `json:"secure_auth_cookie,omitempty" typescript:",notnull"`
|
|
StrictTransportSecurity clibase.Int64 `json:"strict_transport_security,omitempty" typescript:",notnull"`
|
|
StrictTransportSecurityOptions clibase.StringArray `json:"strict_transport_security_options,omitempty" typescript:",notnull"`
|
|
SSHKeygenAlgorithm clibase.String `json:"ssh_keygen_algorithm,omitempty" typescript:",notnull"`
|
|
MetricsCacheRefreshInterval clibase.Duration `json:"metrics_cache_refresh_interval,omitempty" typescript:",notnull"`
|
|
AgentStatRefreshInterval clibase.Duration `json:"agent_stat_refresh_interval,omitempty" typescript:",notnull"`
|
|
AgentFallbackTroubleshootingURL clibase.URL `json:"agent_fallback_troubleshooting_url,omitempty" typescript:",notnull"`
|
|
BrowserOnly clibase.Bool `json:"browser_only,omitempty" typescript:",notnull"`
|
|
SCIMAPIKey clibase.String `json:"scim_api_key,omitempty" typescript:",notnull"`
|
|
Provisioner ProvisionerConfig `json:"provisioner,omitempty" typescript:",notnull"`
|
|
RateLimit RateLimitConfig `json:"rate_limit,omitempty" typescript:",notnull"`
|
|
Experiments clibase.StringArray `json:"experiments,omitempty" typescript:",notnull"`
|
|
UpdateCheck clibase.Bool `json:"update_check,omitempty" typescript:",notnull"`
|
|
MaxTokenLifetime clibase.Duration `json:"max_token_lifetime,omitempty" typescript:",notnull"`
|
|
Swagger SwaggerConfig `json:"swagger,omitempty" typescript:",notnull"`
|
|
Logging LoggingConfig `json:"logging,omitempty" typescript:",notnull"`
|
|
Dangerous DangerousConfig `json:"dangerous,omitempty" typescript:",notnull"`
|
|
DisablePathApps clibase.Bool `json:"disable_path_apps,omitempty" typescript:",notnull"`
|
|
SessionDuration clibase.Duration `json:"max_session_expiry,omitempty" typescript:",notnull"`
|
|
DisableSessionExpiryRefresh clibase.Bool `json:"disable_session_expiry_refresh,omitempty" typescript:",notnull"`
|
|
DisablePasswordAuth clibase.Bool `json:"disable_password_auth,omitempty" typescript:",notnull"`
|
|
Support SupportConfig `json:"support,omitempty" typescript:",notnull"`
|
|
GitAuthProviders clibase.Struct[[]GitAuthConfig] `json:"git_auth,omitempty" typescript:",notnull"`
|
|
SSHConfig SSHConfig `json:"config_ssh,omitempty" typescript:",notnull"`
|
|
WgtunnelHost clibase.String `json:"wgtunnel_host,omitempty" typescript:",notnull"`
|
|
DisableOwnerWorkspaceExec clibase.Bool `json:"disable_owner_workspace_exec,omitempty" typescript:",notnull"`
|
|
|
|
Config clibase.YAMLConfigPath `json:"config,omitempty" typescript:",notnull"`
|
|
WriteConfig clibase.Bool `json:"write_config,omitempty" typescript:",notnull"`
|
|
|
|
// DEPRECATED: Use HTTPAddress or TLS.Address instead.
|
|
Address clibase.HostPort `json:"address,omitempty" typescript:",notnull"`
|
|
}
|
|
|
|
// SSHConfig is configuration the cli & vscode extension use for configuring
|
|
// ssh connections.
|
|
type SSHConfig struct {
|
|
// DeploymentName is the config-ssh Hostname prefix
|
|
DeploymentName clibase.String
|
|
// SSHConfigOptions are additional options to add to the ssh config file.
|
|
// This will override defaults.
|
|
SSHConfigOptions clibase.StringArray
|
|
}
|
|
|
|
func (c SSHConfig) ParseOptions() (map[string]string, error) {
|
|
m := make(map[string]string)
|
|
for _, opt := range c.SSHConfigOptions {
|
|
key, value, err := ParseSSHConfigOption(opt)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
m[key] = value
|
|
}
|
|
return m, nil
|
|
}
|
|
|
|
// ParseSSHConfigOption parses a single ssh config option into it's key/value pair.
|
|
func ParseSSHConfigOption(opt string) (key string, value string, err error) {
|
|
// An equal sign or whitespace is the separator between the key and value.
|
|
idx := strings.IndexFunc(opt, func(r rune) bool {
|
|
return r == ' ' || r == '='
|
|
})
|
|
if idx == -1 {
|
|
return "", "", xerrors.Errorf("invalid config-ssh option %q", opt)
|
|
}
|
|
return opt[:idx], opt[idx+1:], nil
|
|
}
|
|
|
|
type DERP struct {
|
|
Server DERPServerConfig `json:"server" typescript:",notnull"`
|
|
Config DERPConfig `json:"config" typescript:",notnull"`
|
|
}
|
|
|
|
type DERPServerConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
RegionID clibase.Int64 `json:"region_id" typescript:",notnull"`
|
|
RegionCode clibase.String `json:"region_code" typescript:",notnull"`
|
|
RegionName clibase.String `json:"region_name" typescript:",notnull"`
|
|
STUNAddresses clibase.StringArray `json:"stun_addresses" typescript:",notnull"`
|
|
RelayURL clibase.URL `json:"relay_url" typescript:",notnull"`
|
|
}
|
|
|
|
type DERPConfig struct {
|
|
URL clibase.String `json:"url" typescript:",notnull"`
|
|
Path clibase.String `json:"path" typescript:",notnull"`
|
|
}
|
|
|
|
type PrometheusConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
Address clibase.HostPort `json:"address" typescript:",notnull"`
|
|
CollectAgentStats clibase.Bool `json:"collect_agent_stats" typescript:",notnull"`
|
|
}
|
|
|
|
type PprofConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
Address clibase.HostPort `json:"address" typescript:",notnull"`
|
|
}
|
|
|
|
type OAuth2Config struct {
|
|
Github OAuth2GithubConfig `json:"github" typescript:",notnull"`
|
|
}
|
|
|
|
type OAuth2GithubConfig struct {
|
|
ClientID clibase.String `json:"client_id" typescript:",notnull"`
|
|
ClientSecret clibase.String `json:"client_secret" typescript:",notnull"`
|
|
AllowedOrgs clibase.StringArray `json:"allowed_orgs" typescript:",notnull"`
|
|
AllowedTeams clibase.StringArray `json:"allowed_teams" typescript:",notnull"`
|
|
AllowSignups clibase.Bool `json:"allow_signups" typescript:",notnull"`
|
|
AllowEveryone clibase.Bool `json:"allow_everyone" typescript:",notnull"`
|
|
EnterpriseBaseURL clibase.String `json:"enterprise_base_url" typescript:",notnull"`
|
|
}
|
|
|
|
type OIDCConfig struct {
|
|
AllowSignups clibase.Bool `json:"allow_signups" typescript:",notnull"`
|
|
ClientID clibase.String `json:"client_id" typescript:",notnull"`
|
|
ClientSecret clibase.String `json:"client_secret" typescript:",notnull"`
|
|
EmailDomain clibase.StringArray `json:"email_domain" typescript:",notnull"`
|
|
IssuerURL clibase.String `json:"issuer_url" typescript:",notnull"`
|
|
Scopes clibase.StringArray `json:"scopes" typescript:",notnull"`
|
|
IgnoreEmailVerified clibase.Bool `json:"ignore_email_verified" typescript:",notnull"`
|
|
UsernameField clibase.String `json:"username_field" typescript:",notnull"`
|
|
EmailField clibase.String `json:"email_field" typescript:",notnull"`
|
|
AuthURLParams clibase.Struct[map[string]string] `json:"auth_url_params" typescript:",notnull"`
|
|
IgnoreUserInfo clibase.Bool `json:"ignore_user_info" typescript:",notnull"`
|
|
GroupField clibase.String `json:"groups_field" typescript:",notnull"`
|
|
GroupMapping clibase.Struct[map[string]string] `json:"group_mapping" typescript:",notnull"`
|
|
SignInText clibase.String `json:"sign_in_text" typescript:",notnull"`
|
|
IconURL clibase.URL `json:"icon_url" typescript:",notnull"`
|
|
}
|
|
|
|
type TelemetryConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
Trace clibase.Bool `json:"trace" typescript:",notnull"`
|
|
URL clibase.URL `json:"url" typescript:",notnull"`
|
|
}
|
|
|
|
type TLSConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
Address clibase.HostPort `json:"address" typescript:",notnull"`
|
|
RedirectHTTP clibase.Bool `json:"redirect_http" typescript:",notnull"`
|
|
CertFiles clibase.StringArray `json:"cert_file" typescript:",notnull"`
|
|
ClientAuth clibase.String `json:"client_auth" typescript:",notnull"`
|
|
ClientCAFile clibase.String `json:"client_ca_file" typescript:",notnull"`
|
|
KeyFiles clibase.StringArray `json:"key_file" typescript:",notnull"`
|
|
MinVersion clibase.String `json:"min_version" typescript:",notnull"`
|
|
ClientCertFile clibase.String `json:"client_cert_file" typescript:",notnull"`
|
|
ClientKeyFile clibase.String `json:"client_key_file" typescript:",notnull"`
|
|
}
|
|
|
|
type TraceConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
HoneycombAPIKey clibase.String `json:"honeycomb_api_key" typescript:",notnull"`
|
|
CaptureLogs clibase.Bool `json:"capture_logs" typescript:",notnull"`
|
|
}
|
|
|
|
type GitAuthConfig struct {
|
|
ID string `json:"id"`
|
|
Type string `json:"type"`
|
|
ClientID string `json:"client_id"`
|
|
ClientSecret string `json:"-" yaml:"client_secret"`
|
|
AuthURL string `json:"auth_url"`
|
|
TokenURL string `json:"token_url"`
|
|
ValidateURL string `json:"validate_url"`
|
|
Regex string `json:"regex"`
|
|
NoRefresh bool `json:"no_refresh"`
|
|
Scopes []string `json:"scopes"`
|
|
}
|
|
|
|
type ProvisionerConfig struct {
|
|
Daemons clibase.Int64 `json:"daemons" typescript:",notnull"`
|
|
DaemonPollInterval clibase.Duration `json:"daemon_poll_interval" typescript:",notnull"`
|
|
DaemonPollJitter clibase.Duration `json:"daemon_poll_jitter" typescript:",notnull"`
|
|
ForceCancelInterval clibase.Duration `json:"force_cancel_interval" typescript:",notnull"`
|
|
}
|
|
|
|
type RateLimitConfig struct {
|
|
DisableAll clibase.Bool `json:"disable_all" typescript:",notnull"`
|
|
API clibase.Int64 `json:"api" typescript:",notnull"`
|
|
}
|
|
|
|
type SwaggerConfig struct {
|
|
Enable clibase.Bool `json:"enable" typescript:",notnull"`
|
|
}
|
|
|
|
type LoggingConfig struct {
|
|
Human clibase.String `json:"human" typescript:",notnull"`
|
|
JSON clibase.String `json:"json" typescript:",notnull"`
|
|
Stackdriver clibase.String `json:"stackdriver" typescript:",notnull"`
|
|
}
|
|
|
|
type DangerousConfig struct {
|
|
AllowPathAppSharing clibase.Bool `json:"allow_path_app_sharing" typescript:",notnull"`
|
|
AllowPathAppSiteOwnerAccess clibase.Bool `json:"allow_path_app_site_owner_access" typescript:",notnull"`
|
|
AllowAllCors clibase.Bool `json:"allow_all_cors" typescript:",notnull"`
|
|
}
|
|
|
|
const (
|
|
annotationEnterpriseKey = "enterprise"
|
|
annotationSecretKey = "secret"
|
|
// annotationExternalProxies is used to mark options that are used by workspace
|
|
// proxies. This is used to filter out options that are not relevant.
|
|
annotationExternalProxies = "external_workspace_proxies"
|
|
)
|
|
|
|
// IsWorkspaceProxies returns true if the cli option is used by workspace proxies.
|
|
func IsWorkspaceProxies(opt clibase.Option) bool {
|
|
// If it is a bool, use the bool value.
|
|
b, _ := strconv.ParseBool(opt.Annotations[annotationExternalProxies])
|
|
return b
|
|
}
|
|
|
|
func IsSecretDeploymentOption(opt clibase.Option) bool {
|
|
return opt.Annotations.IsSet(annotationSecretKey)
|
|
}
|
|
|
|
func DefaultCacheDir() string {
|
|
defaultCacheDir, err := os.UserCacheDir()
|
|
if err != nil {
|
|
defaultCacheDir = os.TempDir()
|
|
}
|
|
if dir := os.Getenv("CACHE_DIRECTORY"); dir != "" {
|
|
// For compatibility with systemd.
|
|
defaultCacheDir = dir
|
|
}
|
|
if dir := os.Getenv("CLIDOCGEN_CACHE_DIRECTORY"); dir != "" {
|
|
defaultCacheDir = dir
|
|
}
|
|
return filepath.Join(defaultCacheDir, "coder")
|
|
}
|
|
|
|
// DeploymentConfig contains both the deployment values and how they're set.
|
|
//
|
|
// @typescript-ignore DeploymentConfig
|
|
// apitypings doesn't know how to generate the OptionSet... yet.
|
|
type DeploymentConfig struct {
|
|
Values *DeploymentValues `json:"config,omitempty"`
|
|
Options clibase.OptionSet `json:"options,omitempty"`
|
|
}
|
|
|
|
func (c *DeploymentValues) Options() clibase.OptionSet {
|
|
// The deploymentGroup variables are used to organize the myriad server options.
|
|
var (
|
|
deploymentGroupNetworking = clibase.Group{
|
|
Name: "Networking",
|
|
YAML: "networking",
|
|
}
|
|
deploymentGroupNetworkingTLS = clibase.Group{
|
|
Parent: &deploymentGroupNetworking,
|
|
Name: "TLS",
|
|
Description: `Configure TLS / HTTPS for your Coder deployment. If you're running
|
|
Coder behind a TLS-terminating reverse proxy or are accessing Coder over a
|
|
secure link, you can safely ignore these settings.`,
|
|
YAML: "tls",
|
|
}
|
|
deploymentGroupNetworkingHTTP = clibase.Group{
|
|
Parent: &deploymentGroupNetworking,
|
|
Name: "HTTP",
|
|
YAML: "http",
|
|
}
|
|
deploymentGroupNetworkingDERP = clibase.Group{
|
|
Parent: &deploymentGroupNetworking,
|
|
Name: "DERP",
|
|
Description: `Most Coder deployments never have to think about DERP because all connections
|
|
between workspaces and users are peer-to-peer. However, when Coder cannot establish
|
|
a peer to peer connection, Coder uses a distributed relay network backed by
|
|
Tailscale and WireGuard.`,
|
|
YAML: "derp",
|
|
}
|
|
deploymentGroupIntrospection = clibase.Group{
|
|
Name: "Introspection",
|
|
Description: `Configure logging, tracing, and metrics exporting.`,
|
|
YAML: "introspection",
|
|
}
|
|
deploymentGroupIntrospectionPPROF = clibase.Group{
|
|
Parent: &deploymentGroupIntrospection,
|
|
Name: "pprof",
|
|
YAML: "pprof",
|
|
}
|
|
deploymentGroupIntrospectionPrometheus = clibase.Group{
|
|
Parent: &deploymentGroupIntrospection,
|
|
Name: "Prometheus",
|
|
YAML: "prometheus",
|
|
}
|
|
deploymentGroupIntrospectionTracing = clibase.Group{
|
|
Parent: &deploymentGroupIntrospection,
|
|
Name: "Tracing",
|
|
YAML: "tracing",
|
|
}
|
|
deploymentGroupIntrospectionLogging = clibase.Group{
|
|
Parent: &deploymentGroupIntrospection,
|
|
Name: "Logging",
|
|
YAML: "logging",
|
|
}
|
|
deploymentGroupOAuth2 = clibase.Group{
|
|
Name: "OAuth2",
|
|
Description: `Configure login and user-provisioning with GitHub via oAuth2.`,
|
|
YAML: "oauth2",
|
|
}
|
|
deploymentGroupOAuth2GitHub = clibase.Group{
|
|
Parent: &deploymentGroupOAuth2,
|
|
Name: "GitHub",
|
|
YAML: "github",
|
|
}
|
|
deploymentGroupOIDC = clibase.Group{
|
|
Name: "OIDC",
|
|
YAML: "oidc",
|
|
}
|
|
deploymentGroupTelemetry = clibase.Group{
|
|
Name: "Telemetry",
|
|
YAML: "telemetry",
|
|
Description: `Telemetry is critical to our ability to improve Coder. We strip all personal
|
|
information before sending data to our servers. Please only disable telemetry
|
|
when required by your organization's security policy.`,
|
|
}
|
|
deploymentGroupProvisioning = clibase.Group{
|
|
Name: "Provisioning",
|
|
Description: `Tune the behavior of the provisioner, which is responsible for creating, updating, and deleting workspace resources.`,
|
|
YAML: "provisioning",
|
|
}
|
|
deploymentGroupDangerous = clibase.Group{
|
|
Name: "⚠️ Dangerous",
|
|
YAML: "dangerous",
|
|
}
|
|
deploymentGroupClient = clibase.Group{
|
|
Name: "Client",
|
|
Description: "These options change the behavior of how clients interact with the Coder. " +
|
|
"Clients include the coder cli, vs code extension, and the web UI.",
|
|
YAML: "client",
|
|
}
|
|
deploymentGroupConfig = clibase.Group{
|
|
Name: "Config",
|
|
Description: `Use a YAML configuration file when your server launch become unwieldy.`,
|
|
}
|
|
)
|
|
|
|
httpAddress := clibase.Option{
|
|
Name: "HTTP Address",
|
|
Description: "HTTP bind address of the server. Unset to disable the HTTP endpoint.",
|
|
Flag: "http-address",
|
|
Env: "CODER_HTTP_ADDRESS",
|
|
Default: "127.0.0.1:3000",
|
|
Value: &c.HTTPAddress,
|
|
Group: &deploymentGroupNetworkingHTTP,
|
|
YAML: "httpAddress",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
}
|
|
tlsBindAddress := clibase.Option{
|
|
Name: "TLS Address",
|
|
Description: "HTTPS bind address of the server.",
|
|
Flag: "tls-address",
|
|
Env: "CODER_TLS_ADDRESS",
|
|
Default: "127.0.0.1:3443",
|
|
Value: &c.TLS.Address,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "address",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
}
|
|
redirectToAccessURL := clibase.Option{
|
|
Name: "Redirect to Access URL",
|
|
Description: "Specifies whether to redirect requests that do not match the access URL host.",
|
|
Flag: "redirect-to-access-url",
|
|
Env: "CODER_REDIRECT_TO_ACCESS_URL",
|
|
Value: &c.RedirectToAccessURL,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "redirectToAccessURL",
|
|
}
|
|
opts := clibase.OptionSet{
|
|
{
|
|
Name: "Access URL",
|
|
Description: `The URL that users will use to access the Coder deployment.`,
|
|
Value: &c.AccessURL,
|
|
Flag: "access-url",
|
|
Env: "CODER_ACCESS_URL",
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "accessURL",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Wildcard Access URL",
|
|
Description: "Specifies the wildcard hostname to use for workspace applications in the form \"*.example.com\".",
|
|
Flag: "wildcard-access-url",
|
|
Env: "CODER_WILDCARD_ACCESS_URL",
|
|
Value: &c.WildcardAccessURL,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "wildcardAccessURL",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
redirectToAccessURL,
|
|
{
|
|
Name: "Autobuild Poll Interval",
|
|
Description: "Interval to poll for scheduled workspace builds.",
|
|
Flag: "autobuild-poll-interval",
|
|
Env: "CODER_AUTOBUILD_POLL_INTERVAL",
|
|
Hidden: true,
|
|
Default: time.Minute.String(),
|
|
Value: &c.AutobuildPollInterval,
|
|
YAML: "autobuildPollInterval",
|
|
},
|
|
httpAddress,
|
|
tlsBindAddress,
|
|
{
|
|
Name: "Address",
|
|
Description: "Bind address of the server.",
|
|
Flag: "address",
|
|
FlagShorthand: "a",
|
|
Env: "CODER_ADDRESS",
|
|
Hidden: true,
|
|
Value: &c.Address,
|
|
UseInstead: clibase.OptionSet{
|
|
httpAddress,
|
|
tlsBindAddress,
|
|
},
|
|
Group: &deploymentGroupNetworking,
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// TLS settings
|
|
{
|
|
Name: "TLS Enable",
|
|
Description: "Whether TLS will be enabled.",
|
|
Flag: "tls-enable",
|
|
Env: "CODER_TLS_ENABLE",
|
|
Value: &c.TLS.Enable,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "enable",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Redirect HTTP to HTTPS",
|
|
Description: "Whether HTTP requests will be redirected to the access URL (if it's a https URL and TLS is enabled). Requests to local IP addresses are never redirected regardless of this setting.",
|
|
Flag: "tls-redirect-http-to-https",
|
|
Env: "CODER_TLS_REDIRECT_HTTP_TO_HTTPS",
|
|
Default: "true",
|
|
Hidden: true,
|
|
Value: &c.TLS.RedirectHTTP,
|
|
UseInstead: clibase.OptionSet{redirectToAccessURL},
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "redirectHTTP",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Certificate Files",
|
|
Description: "Path to each certificate for TLS. It requires a PEM-encoded file. To configure the listener to use a CA certificate, concatenate the primary certificate and the CA certificate together. The primary certificate should appear first in the combined file.",
|
|
Flag: "tls-cert-file",
|
|
Env: "CODER_TLS_CERT_FILE",
|
|
Value: &c.TLS.CertFiles,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "certFiles",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Client CA Files",
|
|
Description: "PEM-encoded Certificate Authority file used for checking the authenticity of client.",
|
|
Flag: "tls-client-ca-file",
|
|
Env: "CODER_TLS_CLIENT_CA_FILE",
|
|
Value: &c.TLS.ClientCAFile,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "clientCAFile",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Client Auth",
|
|
Description: "Policy the server will follow for TLS Client Authentication. Accepted values are \"none\", \"request\", \"require-any\", \"verify-if-given\", or \"require-and-verify\".",
|
|
Flag: "tls-client-auth",
|
|
Env: "CODER_TLS_CLIENT_AUTH",
|
|
Default: "none",
|
|
Value: &c.TLS.ClientAuth,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "clientAuth",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Key Files",
|
|
Description: "Paths to the private keys for each of the certificates. It requires a PEM-encoded file.",
|
|
Flag: "tls-key-file",
|
|
Env: "CODER_TLS_KEY_FILE",
|
|
Value: &c.TLS.KeyFiles,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "keyFiles",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Minimum Version",
|
|
Description: "Minimum supported version of TLS. Accepted values are \"tls10\", \"tls11\", \"tls12\" or \"tls13\".",
|
|
Flag: "tls-min-version",
|
|
Env: "CODER_TLS_MIN_VERSION",
|
|
Default: "tls12",
|
|
Value: &c.TLS.MinVersion,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "minVersion",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Client Cert File",
|
|
Description: "Path to certificate for client TLS authentication. It requires a PEM-encoded file.",
|
|
Flag: "tls-client-cert-file",
|
|
Env: "CODER_TLS_CLIENT_CERT_FILE",
|
|
Value: &c.TLS.ClientCertFile,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "clientCertFile",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "TLS Client Key File",
|
|
Description: "Path to key for client TLS authentication. It requires a PEM-encoded file.",
|
|
Flag: "tls-client-key-file",
|
|
Env: "CODER_TLS_CLIENT_KEY_FILE",
|
|
Value: &c.TLS.ClientKeyFile,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "clientKeyFile",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// Derp settings
|
|
{
|
|
Name: "DERP Server Enable",
|
|
Description: "Whether to enable or disable the embedded DERP relay server.",
|
|
Flag: "derp-server-enable",
|
|
Env: "CODER_DERP_SERVER_ENABLE",
|
|
Default: "true",
|
|
Value: &c.DERP.Server.Enable,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "enable",
|
|
},
|
|
{
|
|
Name: "DERP Server Region ID",
|
|
Description: "Region ID to use for the embedded DERP server.",
|
|
Flag: "derp-server-region-id",
|
|
Env: "CODER_DERP_SERVER_REGION_ID",
|
|
Default: "999",
|
|
Value: &c.DERP.Server.RegionID,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "regionID",
|
|
},
|
|
{
|
|
Name: "DERP Server Region Code",
|
|
Description: "Region code to use for the embedded DERP server.",
|
|
Flag: "derp-server-region-code",
|
|
Env: "CODER_DERP_SERVER_REGION_CODE",
|
|
Default: "coder",
|
|
Value: &c.DERP.Server.RegionCode,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "regionCode",
|
|
},
|
|
{
|
|
Name: "DERP Server Region Name",
|
|
Description: "Region name that for the embedded DERP server.",
|
|
Flag: "derp-server-region-name",
|
|
Env: "CODER_DERP_SERVER_REGION_NAME",
|
|
Default: "Coder Embedded Relay",
|
|
Value: &c.DERP.Server.RegionName,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "regionName",
|
|
},
|
|
{
|
|
Name: "DERP Server STUN Addresses",
|
|
Description: "Addresses for STUN servers to establish P2P connections. Use special value 'disable' to turn off STUN.",
|
|
Flag: "derp-server-stun-addresses",
|
|
Env: "CODER_DERP_SERVER_STUN_ADDRESSES",
|
|
Default: "stun.l.google.com:19302",
|
|
Value: &c.DERP.Server.STUNAddresses,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "stunAddresses",
|
|
},
|
|
{
|
|
Name: "DERP Server Relay URL",
|
|
Description: "An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.",
|
|
Flag: "derp-server-relay-url",
|
|
Env: "CODER_DERP_SERVER_RELAY_URL",
|
|
Annotations: clibase.Annotations{}.Mark(annotationEnterpriseKey, "true"),
|
|
Value: &c.DERP.Server.RelayURL,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "relayURL",
|
|
},
|
|
{
|
|
Name: "DERP Config URL",
|
|
Description: "URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
|
|
Flag: "derp-config-url",
|
|
Env: "CODER_DERP_CONFIG_URL",
|
|
Value: &c.DERP.Config.URL,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "url",
|
|
},
|
|
{
|
|
Name: "DERP Config Path",
|
|
Description: "Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
|
|
Flag: "derp-config-path",
|
|
Env: "CODER_DERP_CONFIG_PATH",
|
|
Value: &c.DERP.Config.Path,
|
|
Group: &deploymentGroupNetworkingDERP,
|
|
YAML: "configPath",
|
|
},
|
|
// TODO: support Git Auth settings.
|
|
// Prometheus settings
|
|
{
|
|
Name: "Prometheus Enable",
|
|
Description: "Serve prometheus metrics on the address defined by prometheus address.",
|
|
Flag: "prometheus-enable",
|
|
Env: "CODER_PROMETHEUS_ENABLE",
|
|
Value: &c.Prometheus.Enable,
|
|
Group: &deploymentGroupIntrospectionPrometheus,
|
|
YAML: "enable",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Prometheus Address",
|
|
Description: "The bind address to serve prometheus metrics.",
|
|
Flag: "prometheus-address",
|
|
Env: "CODER_PROMETHEUS_ADDRESS",
|
|
Default: "127.0.0.1:2112",
|
|
Value: &c.Prometheus.Address,
|
|
Group: &deploymentGroupIntrospectionPrometheus,
|
|
YAML: "address",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Prometheus Collect Agent Stats",
|
|
Description: "Collect agent stats (may increase charges for metrics storage).",
|
|
Flag: "prometheus-collect-agent-stats",
|
|
Env: "CODER_PROMETHEUS_COLLECT_AGENT_STATS",
|
|
Value: &c.Prometheus.CollectAgentStats,
|
|
Group: &deploymentGroupIntrospectionPrometheus,
|
|
YAML: "collect_agent_stats",
|
|
},
|
|
// Pprof settings
|
|
{
|
|
Name: "pprof Enable",
|
|
Description: "Serve pprof metrics on the address defined by pprof address.",
|
|
Flag: "pprof-enable",
|
|
Env: "CODER_PPROF_ENABLE",
|
|
Value: &c.Pprof.Enable,
|
|
Group: &deploymentGroupIntrospectionPPROF,
|
|
YAML: "enable",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "pprof Address",
|
|
Description: "The bind address to serve pprof.",
|
|
Flag: "pprof-address",
|
|
Env: "CODER_PPROF_ADDRESS",
|
|
Default: "127.0.0.1:6060",
|
|
Value: &c.Pprof.Address,
|
|
Group: &deploymentGroupIntrospectionPPROF,
|
|
YAML: "address",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// oAuth settings
|
|
{
|
|
Name: "OAuth2 GitHub Client ID",
|
|
Description: "Client ID for Login with GitHub.",
|
|
Flag: "oauth2-github-client-id",
|
|
Env: "CODER_OAUTH2_GITHUB_CLIENT_ID",
|
|
Value: &c.OAuth2.Github.ClientID,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "clientID",
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Client Secret",
|
|
Description: "Client secret for Login with GitHub.",
|
|
Flag: "oauth2-github-client-secret",
|
|
Env: "CODER_OAUTH2_GITHUB_CLIENT_SECRET",
|
|
Value: &c.OAuth2.Github.ClientSecret,
|
|
Annotations: clibase.Annotations{}.Mark(annotationSecretKey, "true"),
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Allowed Orgs",
|
|
Description: "Organizations the user must be a member of to Login with GitHub.",
|
|
Flag: "oauth2-github-allowed-orgs",
|
|
Env: "CODER_OAUTH2_GITHUB_ALLOWED_ORGS",
|
|
Value: &c.OAuth2.Github.AllowedOrgs,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "allowedOrgs",
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Allowed Teams",
|
|
Description: "Teams inside organizations the user must be a member of to Login with GitHub. Structured as: <organization-name>/<team-slug>.",
|
|
Flag: "oauth2-github-allowed-teams",
|
|
Env: "CODER_OAUTH2_GITHUB_ALLOWED_TEAMS",
|
|
Value: &c.OAuth2.Github.AllowedTeams,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "allowedTeams",
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Allow Signups",
|
|
Description: "Whether new users can sign up with GitHub.",
|
|
Flag: "oauth2-github-allow-signups",
|
|
Env: "CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS",
|
|
Value: &c.OAuth2.Github.AllowSignups,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "allowSignups",
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Allow Everyone",
|
|
Description: "Allow all logins, setting this option means allowed orgs and teams must be empty.",
|
|
Flag: "oauth2-github-allow-everyone",
|
|
Env: "CODER_OAUTH2_GITHUB_ALLOW_EVERYONE",
|
|
Value: &c.OAuth2.Github.AllowEveryone,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "allowEveryone",
|
|
},
|
|
{
|
|
Name: "OAuth2 GitHub Enterprise Base URL",
|
|
Description: "Base URL of a GitHub Enterprise deployment to use for Login with GitHub.",
|
|
Flag: "oauth2-github-enterprise-base-url",
|
|
Env: "CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL",
|
|
Value: &c.OAuth2.Github.EnterpriseBaseURL,
|
|
Group: &deploymentGroupOAuth2GitHub,
|
|
YAML: "enterpriseBaseURL",
|
|
},
|
|
// OIDC settings.
|
|
{
|
|
Name: "OIDC Allow Signups",
|
|
Description: "Whether new users can sign up with OIDC.",
|
|
Flag: "oidc-allow-signups",
|
|
Env: "CODER_OIDC_ALLOW_SIGNUPS",
|
|
Default: "true",
|
|
Value: &c.OIDC.AllowSignups,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "allowSignups",
|
|
},
|
|
{
|
|
Name: "OIDC Client ID",
|
|
Description: "Client ID to use for Login with OIDC.",
|
|
Flag: "oidc-client-id",
|
|
Env: "CODER_OIDC_CLIENT_ID",
|
|
Value: &c.OIDC.ClientID,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "clientID",
|
|
},
|
|
{
|
|
Name: "OIDC Client Secret",
|
|
Description: "Client secret to use for Login with OIDC.",
|
|
Flag: "oidc-client-secret",
|
|
Env: "CODER_OIDC_CLIENT_SECRET",
|
|
Annotations: clibase.Annotations{}.Mark(annotationSecretKey, "true"),
|
|
Value: &c.OIDC.ClientSecret,
|
|
Group: &deploymentGroupOIDC,
|
|
},
|
|
{
|
|
Name: "OIDC Email Domain",
|
|
Description: "Email domains that clients logging in with OIDC must match.",
|
|
Flag: "oidc-email-domain",
|
|
Env: "CODER_OIDC_EMAIL_DOMAIN",
|
|
Value: &c.OIDC.EmailDomain,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "emailDomain",
|
|
},
|
|
{
|
|
Name: "OIDC Issuer URL",
|
|
Description: "Issuer URL to use for Login with OIDC.",
|
|
Flag: "oidc-issuer-url",
|
|
Env: "CODER_OIDC_ISSUER_URL",
|
|
Value: &c.OIDC.IssuerURL,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "issuerURL",
|
|
},
|
|
{
|
|
Name: "OIDC Scopes",
|
|
Description: "Scopes to grant when authenticating with OIDC.",
|
|
Flag: "oidc-scopes",
|
|
Env: "CODER_OIDC_SCOPES",
|
|
Default: strings.Join([]string{oidc.ScopeOpenID, "profile", "email"}, ","),
|
|
Value: &c.OIDC.Scopes,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "scopes",
|
|
},
|
|
{
|
|
Name: "OIDC Ignore Email Verified",
|
|
Description: "Ignore the email_verified claim from the upstream provider.",
|
|
Flag: "oidc-ignore-email-verified",
|
|
Env: "CODER_OIDC_IGNORE_EMAIL_VERIFIED",
|
|
Value: &c.OIDC.IgnoreEmailVerified,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "ignoreEmailVerified",
|
|
},
|
|
{
|
|
Name: "OIDC Username Field",
|
|
Description: "OIDC claim field to use as the username.",
|
|
Flag: "oidc-username-field",
|
|
Env: "CODER_OIDC_USERNAME_FIELD",
|
|
Default: "preferred_username",
|
|
Value: &c.OIDC.UsernameField,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "usernameField",
|
|
},
|
|
{
|
|
Name: "OIDC Email Field",
|
|
Description: "OIDC claim field to use as the email.",
|
|
Flag: "oidc-email-field",
|
|
Env: "CODER_OIDC_EMAIL_FIELD",
|
|
Default: "email",
|
|
Value: &c.OIDC.EmailField,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "emailField",
|
|
},
|
|
{
|
|
Name: "OIDC Auth URL Parameters",
|
|
Description: "OIDC auth URL parameters to pass to the upstream provider.",
|
|
Flag: "oidc-auth-url-params",
|
|
Env: "CODER_OIDC_AUTH_URL_PARAMS",
|
|
Default: `{"access_type": "offline"}`,
|
|
Value: &c.OIDC.AuthURLParams,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "authURLParams",
|
|
},
|
|
{
|
|
Name: "OIDC Ignore UserInfo",
|
|
Description: "Ignore the userinfo endpoint and only use the ID token for user information.",
|
|
Flag: "oidc-ignore-userinfo",
|
|
Env: "CODER_OIDC_IGNORE_USERINFO",
|
|
Default: "false",
|
|
Value: &c.OIDC.IgnoreUserInfo,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "ignoreUserInfo",
|
|
},
|
|
{
|
|
Name: "OIDC Group Field",
|
|
Description: "Change the OIDC default 'groups' claim field. By default, will be 'groups' if present in the oidc scopes argument.",
|
|
Flag: "oidc-group-field",
|
|
Env: "CODER_OIDC_GROUP_FIELD",
|
|
// This value is intentionally blank. If this is empty, then OIDC group
|
|
// behavior is disabled. If 'oidc-scopes' contains 'groups', then the
|
|
// default value will be 'groups'. If the user wants to use a different claim
|
|
// such as 'memberOf', they can override the default 'groups' claim value
|
|
// that comes from the oidc scopes.
|
|
Default: "",
|
|
Value: &c.OIDC.GroupField,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "groupField",
|
|
},
|
|
{
|
|
Name: "OIDC Group Mapping",
|
|
Description: "A map of OIDC group IDs and the group in Coder it should map to. This is useful for when OIDC providers only return group IDs.",
|
|
Flag: "oidc-group-mapping",
|
|
Env: "CODER_OIDC_GROUP_MAPPING",
|
|
Default: "{}",
|
|
Value: &c.OIDC.GroupMapping,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "groupMapping",
|
|
},
|
|
{
|
|
Name: "OpenID Connect sign in text",
|
|
Description: "The text to show on the OpenID Connect sign in button.",
|
|
Flag: "oidc-sign-in-text",
|
|
Env: "CODER_OIDC_SIGN_IN_TEXT",
|
|
Default: "OpenID Connect",
|
|
Value: &c.OIDC.SignInText,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "signInText",
|
|
},
|
|
{
|
|
Name: "OpenID connect icon URL",
|
|
Description: "URL pointing to the icon to use on the OepnID Connect login button.",
|
|
Flag: "oidc-icon-url",
|
|
Env: "CODER_OIDC_ICON_URL",
|
|
Value: &c.OIDC.IconURL,
|
|
Group: &deploymentGroupOIDC,
|
|
YAML: "iconURL",
|
|
},
|
|
// Telemetry settings
|
|
{
|
|
Name: "Telemetry Enable",
|
|
Description: "Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.",
|
|
Flag: "telemetry",
|
|
Env: "CODER_TELEMETRY_ENABLE",
|
|
Default: strconv.FormatBool(flag.Lookup("test.v") == nil),
|
|
Value: &c.Telemetry.Enable,
|
|
Group: &deploymentGroupTelemetry,
|
|
YAML: "enable",
|
|
},
|
|
{
|
|
Name: "Telemetry Trace",
|
|
Description: "Whether Opentelemetry traces are sent to Coder. Coder collects anonymized application tracing to help improve our product. Disabling telemetry also disables this option.",
|
|
Flag: "telemetry-trace",
|
|
Env: "CODER_TELEMETRY_TRACE",
|
|
Default: strconv.FormatBool(flag.Lookup("test.v") == nil),
|
|
Value: &c.Telemetry.Trace,
|
|
Group: &deploymentGroupTelemetry,
|
|
YAML: "trace",
|
|
},
|
|
{
|
|
Name: "Telemetry URL",
|
|
Description: "URL to send telemetry.",
|
|
Flag: "telemetry-url",
|
|
Env: "CODER_TELEMETRY_URL",
|
|
Hidden: true,
|
|
Default: "https://telemetry.coder.com",
|
|
Value: &c.Telemetry.URL,
|
|
Group: &deploymentGroupTelemetry,
|
|
YAML: "url",
|
|
},
|
|
// Trace settings
|
|
{
|
|
Name: "Trace Enable",
|
|
Description: "Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.",
|
|
Flag: "trace",
|
|
Env: "CODER_TRACE_ENABLE",
|
|
Value: &c.Trace.Enable,
|
|
Group: &deploymentGroupIntrospectionTracing,
|
|
YAML: "enable",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Trace Honeycomb API Key",
|
|
Description: "Enables trace exporting to Honeycomb.io using the provided API Key.",
|
|
Flag: "trace-honeycomb-api-key",
|
|
Env: "CODER_TRACE_HONEYCOMB_API_KEY",
|
|
Annotations: clibase.Annotations{}.Mark(annotationSecretKey, "true").Mark(annotationExternalProxies, "true"),
|
|
Value: &c.Trace.HoneycombAPIKey,
|
|
Group: &deploymentGroupIntrospectionTracing,
|
|
},
|
|
{
|
|
Name: "Capture Logs in Traces",
|
|
Description: "Enables capturing of logs as events in traces. This is useful for debugging, but may result in a very large amount of events being sent to the tracing backend which may incur significant costs. If the verbose flag was supplied, debug-level logs will be included.",
|
|
Flag: "trace-logs",
|
|
Env: "CODER_TRACE_LOGS",
|
|
Value: &c.Trace.CaptureLogs,
|
|
Group: &deploymentGroupIntrospectionTracing,
|
|
YAML: "captureLogs",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// Provisioner settings
|
|
{
|
|
Name: "Provisioner Daemons",
|
|
Description: "Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this.",
|
|
Flag: "provisioner-daemons",
|
|
Env: "CODER_PROVISIONER_DAEMONS",
|
|
Default: "3",
|
|
Value: &c.Provisioner.Daemons,
|
|
Group: &deploymentGroupProvisioning,
|
|
YAML: "daemons",
|
|
},
|
|
{
|
|
Name: "Poll Interval",
|
|
Description: "Time to wait before polling for a new job.",
|
|
Flag: "provisioner-daemon-poll-interval",
|
|
Env: "CODER_PROVISIONER_DAEMON_POLL_INTERVAL",
|
|
Default: time.Second.String(),
|
|
Value: &c.Provisioner.DaemonPollInterval,
|
|
Group: &deploymentGroupProvisioning,
|
|
YAML: "daemonPollInterval",
|
|
},
|
|
{
|
|
Name: "Poll Jitter",
|
|
Description: "Random jitter added to the poll interval.",
|
|
Flag: "provisioner-daemon-poll-jitter",
|
|
Env: "CODER_PROVISIONER_DAEMON_POLL_JITTER",
|
|
Default: (100 * time.Millisecond).String(),
|
|
Value: &c.Provisioner.DaemonPollJitter,
|
|
Group: &deploymentGroupProvisioning,
|
|
YAML: "daemonPollJitter",
|
|
},
|
|
{
|
|
Name: "Force Cancel Interval",
|
|
Description: "Time to force cancel provisioning tasks that are stuck.",
|
|
Flag: "provisioner-force-cancel-interval",
|
|
Env: "CODER_PROVISIONER_FORCE_CANCEL_INTERVAL",
|
|
Default: (10 * time.Minute).String(),
|
|
Value: &c.Provisioner.ForceCancelInterval,
|
|
Group: &deploymentGroupProvisioning,
|
|
YAML: "forceCancelInterval",
|
|
},
|
|
// RateLimit settings
|
|
{
|
|
Name: "Disable All Rate Limits",
|
|
Description: "Disables all rate limits. This is not recommended in production.",
|
|
Flag: "dangerous-disable-rate-limits",
|
|
Env: "CODER_DANGEROUS_DISABLE_RATE_LIMITS",
|
|
|
|
Value: &c.RateLimit.DisableAll,
|
|
Hidden: true,
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "API Rate Limit",
|
|
Description: "Maximum number of requests per minute allowed to the API per user, or per IP address for unauthenticated users. Negative values mean no rate limit. Some API endpoints have separate strict rate limits regardless of this value to prevent denial-of-service or brute force attacks.",
|
|
// Change the env from the auto-generated CODER_RATE_LIMIT_API to the
|
|
// old value to avoid breaking existing deployments.
|
|
Env: "CODER_API_RATE_LIMIT",
|
|
Flag: "api-rate-limit",
|
|
Default: "512",
|
|
Value: &c.RateLimit.API,
|
|
Hidden: true,
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// Logging settings
|
|
{
|
|
Name: "Verbose",
|
|
Description: "Output debug-level logs.",
|
|
Flag: "verbose",
|
|
Env: "CODER_VERBOSE",
|
|
FlagShorthand: "v",
|
|
|
|
Value: &c.Verbose,
|
|
Group: &deploymentGroupIntrospectionLogging,
|
|
YAML: "verbose",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Human Log Location",
|
|
Description: "Output human-readable logs to a given file.",
|
|
Flag: "log-human",
|
|
Env: "CODER_LOGGING_HUMAN",
|
|
Default: "/dev/stderr",
|
|
Value: &c.Logging.Human,
|
|
Group: &deploymentGroupIntrospectionLogging,
|
|
YAML: "humanPath",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "JSON Log Location",
|
|
Description: "Output JSON logs to a given file.",
|
|
Flag: "log-json",
|
|
Env: "CODER_LOGGING_JSON",
|
|
Default: "",
|
|
Value: &c.Logging.JSON,
|
|
Group: &deploymentGroupIntrospectionLogging,
|
|
YAML: "jsonPath",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Stackdriver Log Location",
|
|
Description: "Output Stackdriver compatible logs to a given file.",
|
|
Flag: "log-stackdriver",
|
|
Env: "CODER_LOGGING_STACKDRIVER",
|
|
Default: "",
|
|
Value: &c.Logging.Stackdriver,
|
|
Group: &deploymentGroupIntrospectionLogging,
|
|
YAML: "stackdriverPath",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
// ☢️ Dangerous settings
|
|
{
|
|
Name: "DANGEROUS: Allow all CORs requests",
|
|
Description: "For security reasons, CORs requests are blocked. If external requests are required, setting this to true will set all cors headers as '*'. This should never be used in production.",
|
|
Flag: "dangerous-allow-cors-requests",
|
|
Env: "CODER_DANGEROUS_ALLOW_CORS_REQUESTS",
|
|
Hidden: true, // Hidden, should only be used by yarn dev server
|
|
Value: &c.Dangerous.AllowAllCors,
|
|
Group: &deploymentGroupDangerous,
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "DANGEROUS: Allow Path App Sharing",
|
|
Description: "Allow workspace apps that are not served from subdomains to be shared. Path-based app sharing is DISABLED by default for security purposes. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.",
|
|
Flag: "dangerous-allow-path-app-sharing",
|
|
Env: "CODER_DANGEROUS_ALLOW_PATH_APP_SHARING",
|
|
|
|
Value: &c.Dangerous.AllowPathAppSharing,
|
|
Group: &deploymentGroupDangerous,
|
|
},
|
|
{
|
|
Name: "DANGEROUS: Allow Site Owners to Access Path Apps",
|
|
Description: "Allow site-owners to access workspace apps from workspaces they do not own. Owners cannot access path-based apps they do not own by default. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.",
|
|
Flag: "dangerous-allow-path-app-site-owner-access",
|
|
Env: "CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS",
|
|
|
|
Value: &c.Dangerous.AllowPathAppSiteOwnerAccess,
|
|
Group: &deploymentGroupDangerous,
|
|
},
|
|
// Misc. settings
|
|
{
|
|
Name: "Experiments",
|
|
Description: "Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '*' to opt-in to all available experiments.",
|
|
Flag: "experiments",
|
|
Env: "CODER_EXPERIMENTS",
|
|
Value: &c.Experiments,
|
|
YAML: "experiments",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Update Check",
|
|
Description: "Periodically check for new releases of Coder and inform the owner. The check is performed once per day.",
|
|
Flag: "update-check",
|
|
Env: "CODER_UPDATE_CHECK",
|
|
Default: strconv.FormatBool(
|
|
flag.Lookup("test.v") == nil && !buildinfo.IsDev(),
|
|
),
|
|
Value: &c.UpdateCheck,
|
|
YAML: "updateCheck",
|
|
},
|
|
{
|
|
Name: "Max Token Lifetime",
|
|
Description: "The maximum lifetime duration users can specify when creating an API token.",
|
|
Flag: "max-token-lifetime",
|
|
Env: "CODER_MAX_TOKEN_LIFETIME",
|
|
// The default value is essentially "forever", so just use 100 years.
|
|
// We have to add in the 25 leap days for the frontend to show the
|
|
// "100 years" correctly.
|
|
Default: ((100 * 365 * time.Hour * 24) + (25 * time.Hour * 24)).String(),
|
|
Value: &c.MaxTokenLifetime,
|
|
Group: &deploymentGroupNetworkingHTTP,
|
|
YAML: "maxTokenLifetime",
|
|
},
|
|
{
|
|
Name: "Enable swagger endpoint",
|
|
Description: "Expose the swagger endpoint via /swagger.",
|
|
Flag: "swagger-enable",
|
|
Env: "CODER_SWAGGER_ENABLE",
|
|
|
|
Value: &c.Swagger.Enable,
|
|
YAML: "enableSwagger",
|
|
},
|
|
{
|
|
Name: "Proxy Trusted Headers",
|
|
Flag: "proxy-trusted-headers",
|
|
Env: "CODER_PROXY_TRUSTED_HEADERS",
|
|
Description: "Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For.",
|
|
Value: &c.ProxyTrustedHeaders,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "proxyTrustedHeaders",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Proxy Trusted Origins",
|
|
Flag: "proxy-trusted-origins",
|
|
Env: "CODER_PROXY_TRUSTED_ORIGINS",
|
|
Description: "Origin addresses to respect \"proxy-trusted-headers\". e.g. 192.168.1.0/24.",
|
|
Value: &c.ProxyTrustedOrigins,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "proxyTrustedOrigins",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Cache Directory",
|
|
Description: "The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.",
|
|
Flag: "cache-dir",
|
|
Env: "CODER_CACHE_DIRECTORY",
|
|
Default: DefaultCacheDir(),
|
|
Value: &c.CacheDir,
|
|
YAML: "cacheDir",
|
|
},
|
|
{
|
|
Name: "In Memory Database",
|
|
Description: "Controls whether data will be stored in an in-memory database.",
|
|
Flag: "in-memory",
|
|
Env: "CODER_IN_MEMORY",
|
|
Hidden: true,
|
|
Value: &c.InMemoryDatabase,
|
|
YAML: "inMemoryDatabase",
|
|
},
|
|
{
|
|
Name: "Postgres Connection URL",
|
|
Description: "URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root. Access the built-in database with \"coder server postgres-builtin-url\".",
|
|
Flag: "postgres-url",
|
|
Env: "CODER_PG_CONNECTION_URL",
|
|
Annotations: clibase.Annotations{}.Mark(annotationSecretKey, "true"),
|
|
Value: &c.PostgresURL,
|
|
},
|
|
{
|
|
Name: "Secure Auth Cookie",
|
|
Description: "Controls if the 'Secure' property is set on browser session cookies.",
|
|
Flag: "secure-auth-cookie",
|
|
Env: "CODER_SECURE_AUTH_COOKIE",
|
|
Value: &c.SecureAuthCookie,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "secureAuthCookie",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Strict-Transport-Security",
|
|
Description: "Controls if the 'Strict-Transport-Security' header is set on all static file responses. " +
|
|
"This header should only be set if the server is accessed via HTTPS. This value is the MaxAge in seconds of " +
|
|
"the header.",
|
|
Default: "0",
|
|
Flag: "strict-transport-security",
|
|
Env: "CODER_STRICT_TRANSPORT_SECURITY",
|
|
Value: &c.StrictTransportSecurity,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "strictTransportSecurity",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Strict-Transport-Security Options",
|
|
Description: "Two optional fields can be set in the Strict-Transport-Security header; 'includeSubDomains' and 'preload'. " +
|
|
"The 'strict-transport-security' flag must be set to a non-zero value for these options to be used.",
|
|
Flag: "strict-transport-security-options",
|
|
Env: "CODER_STRICT_TRANSPORT_SECURITY_OPTIONS",
|
|
Value: &c.StrictTransportSecurityOptions,
|
|
Group: &deploymentGroupNetworkingTLS,
|
|
YAML: "strictTransportSecurityOptions",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "SSH Keygen Algorithm",
|
|
Description: "The algorithm to use for generating ssh keys. Accepted values are \"ed25519\", \"ecdsa\", or \"rsa4096\".",
|
|
Flag: "ssh-keygen-algorithm",
|
|
Env: "CODER_SSH_KEYGEN_ALGORITHM",
|
|
Default: "ed25519",
|
|
Value: &c.SSHKeygenAlgorithm,
|
|
YAML: "sshKeygenAlgorithm",
|
|
},
|
|
{
|
|
Name: "Metrics Cache Refresh Interval",
|
|
Description: "How frequently metrics are refreshed.",
|
|
Flag: "metrics-cache-refresh-interval",
|
|
Env: "CODER_METRICS_CACHE_REFRESH_INTERVAL",
|
|
Hidden: true,
|
|
Default: time.Hour.String(),
|
|
Value: &c.MetricsCacheRefreshInterval,
|
|
},
|
|
{
|
|
Name: "Agent Stat Refresh Interval",
|
|
Description: "How frequently agent stats are recorded.",
|
|
Flag: "agent-stats-refresh-interval",
|
|
Env: "CODER_AGENT_STATS_REFRESH_INTERVAL",
|
|
Hidden: true,
|
|
Default: (30 * time.Second).String(),
|
|
Value: &c.AgentStatRefreshInterval,
|
|
},
|
|
{
|
|
Name: "Agent Fallback Troubleshooting URL",
|
|
Description: "URL to use for agent troubleshooting when not set in the template.",
|
|
Flag: "agent-fallback-troubleshooting-url",
|
|
Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
|
|
Hidden: true,
|
|
Default: "https://coder.com/docs/coder-oss/latest/templates#troubleshooting-templates",
|
|
Value: &c.AgentFallbackTroubleshootingURL,
|
|
YAML: "agentFallbackTroubleshootingURL",
|
|
},
|
|
{
|
|
Name: "Browser Only",
|
|
Description: "Whether Coder only allows connections to workspaces via the browser.",
|
|
Flag: "browser-only",
|
|
Env: "CODER_BROWSER_ONLY",
|
|
Annotations: clibase.Annotations{}.Mark(annotationEnterpriseKey, "true"),
|
|
Value: &c.BrowserOnly,
|
|
Group: &deploymentGroupNetworking,
|
|
YAML: "browserOnly",
|
|
},
|
|
{
|
|
Name: "SCIM API Key",
|
|
Description: "Enables SCIM and sets the authentication header for the built-in SCIM server. New users are automatically created with OIDC authentication.",
|
|
Flag: "scim-auth-header",
|
|
Env: "CODER_SCIM_AUTH_HEADER",
|
|
Annotations: clibase.Annotations{}.Mark(annotationEnterpriseKey, "true").Mark(annotationSecretKey, "true"),
|
|
Value: &c.SCIMAPIKey,
|
|
},
|
|
|
|
{
|
|
Name: "Disable Path Apps",
|
|
Description: "Disable workspace apps that are not served from subdomains. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. This is recommended for security purposes if a --wildcard-access-url is configured.",
|
|
Flag: "disable-path-apps",
|
|
Env: "CODER_DISABLE_PATH_APPS",
|
|
|
|
Value: &c.DisablePathApps,
|
|
YAML: "disablePathApps",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Disable Owner Workspace Access",
|
|
Description: "Remove the permission for the 'owner' role to have workspace execution on all workspaces. This prevents the 'owner' from ssh, apps, and terminal access based on the 'owner' role. They still have their user permissions to access their own workspaces.",
|
|
Flag: "disable-owner-workspace-access",
|
|
Env: "CODER_DISABLE_OWNER_WORKSPACE_ACCESS",
|
|
|
|
Value: &c.DisableOwnerWorkspaceExec,
|
|
YAML: "disableOwnerWorkspaceAccess",
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Session Duration",
|
|
Description: "The token expiry duration for browser sessions. Sessions may last longer if they are actively making requests, but this functionality can be disabled via --disable-session-expiry-refresh.",
|
|
Flag: "session-duration",
|
|
Env: "CODER_SESSION_DURATION",
|
|
Default: (24 * time.Hour).String(),
|
|
Value: &c.SessionDuration,
|
|
Group: &deploymentGroupNetworkingHTTP,
|
|
YAML: "sessionDuration",
|
|
},
|
|
{
|
|
Name: "Disable Session Expiry Refresh",
|
|
Description: "Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.",
|
|
Flag: "disable-session-expiry-refresh",
|
|
Env: "CODER_DISABLE_SESSION_EXPIRY_REFRESH",
|
|
|
|
Value: &c.DisableSessionExpiryRefresh,
|
|
Group: &deploymentGroupNetworkingHTTP,
|
|
YAML: "disableSessionExpiryRefresh",
|
|
},
|
|
{
|
|
Name: "Disable Password Authentication",
|
|
Description: "Disable password authentication. This is recommended for security purposes in production deployments that rely on an identity provider. Any user with the owner role will be able to sign in with their password regardless of this setting to avoid potential lock out. If you are locked out of your account, you can use the `coder server create-admin` command to create a new admin user directly in the database.",
|
|
Flag: "disable-password-auth",
|
|
Env: "CODER_DISABLE_PASSWORD_AUTH",
|
|
|
|
Value: &c.DisablePasswordAuth,
|
|
Group: &deploymentGroupNetworkingHTTP,
|
|
YAML: "disablePasswordAuth",
|
|
},
|
|
{
|
|
Name: "Config Path",
|
|
Description: `Specify a YAML file to load configuration from.`,
|
|
Flag: "config",
|
|
Env: "CODER_CONFIG_PATH",
|
|
FlagShorthand: "c",
|
|
Hidden: false,
|
|
Group: &deploymentGroupConfig,
|
|
Value: &c.Config,
|
|
},
|
|
{
|
|
Name: "SSH Host Prefix",
|
|
Description: "The SSH deployment prefix is used in the Host of the ssh config.",
|
|
Flag: "ssh-hostname-prefix",
|
|
Env: "CODER_SSH_HOSTNAME_PREFIX",
|
|
YAML: "sshHostnamePrefix",
|
|
Group: &deploymentGroupClient,
|
|
Value: &c.SSHConfig.DeploymentName,
|
|
Hidden: false,
|
|
Default: "coder.",
|
|
},
|
|
{
|
|
Name: "SSH Config Options",
|
|
Description: "These SSH config options will override the default SSH config options. " +
|
|
"Provide options in \"key=value\" or \"key value\" format separated by commas." +
|
|
"Using this incorrectly can break SSH to your deployment, use cautiously.",
|
|
Flag: "ssh-config-options",
|
|
Env: "CODER_SSH_CONFIG_OPTIONS",
|
|
YAML: "sshConfigOptions",
|
|
Group: &deploymentGroupClient,
|
|
Value: &c.SSHConfig.SSHConfigOptions,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
Name: "Write Config",
|
|
Description: `
|
|
Write out the current server config as YAML to stdout.`,
|
|
Flag: "write-config",
|
|
Group: &deploymentGroupConfig,
|
|
Hidden: false,
|
|
Value: &c.WriteConfig,
|
|
Annotations: clibase.Annotations{}.Mark(annotationExternalProxies, "true"),
|
|
},
|
|
{
|
|
Name: "Support Links",
|
|
Description: "Support links to display in the top right drop down menu.",
|
|
YAML: "supportLinks",
|
|
Value: &c.Support.Links,
|
|
// The support links are hidden until they are defined in the
|
|
// YAML.
|
|
Hidden: true,
|
|
},
|
|
{
|
|
// Env handling is done in cli.ReadGitAuthFromEnvironment
|
|
Name: "Git Auth Providers",
|
|
Description: "Git Authentication providers.",
|
|
// We need extra scrutiny to ensure this works, is documented, and
|
|
// tested before enabling.
|
|
// YAML: "gitAuthProviders",
|
|
Value: &c.GitAuthProviders,
|
|
Hidden: true,
|
|
},
|
|
{
|
|
Name: "Custom wgtunnel Host",
|
|
Description: `Hostname of HTTPS server that runs https://github.com/coder/wgtunnel. By default, this will pick the best available wgtunnel server hosted by Coder. e.g. "tunnel.example.com".`,
|
|
Flag: "wg-tunnel-host",
|
|
Env: "WGTUNNEL_HOST",
|
|
YAML: "wgtunnelHost",
|
|
Value: &c.WgtunnelHost,
|
|
Default: "", // empty string means pick best server
|
|
Hidden: true,
|
|
},
|
|
}
|
|
return opts
|
|
}
|
|
|
|
type SupportConfig struct {
|
|
Links clibase.Struct[[]LinkConfig] `json:"links" typescript:",notnull"`
|
|
}
|
|
|
|
type LinkConfig struct {
|
|
Name string `json:"name" yaml:"name"`
|
|
Target string `json:"target" yaml:"target"`
|
|
Icon string `json:"icon" yaml:"icon"`
|
|
}
|
|
|
|
// WithoutSecrets returns a copy of the config without secret values.
|
|
func (c *DeploymentValues) WithoutSecrets() (*DeploymentValues, error) {
|
|
var ff DeploymentValues
|
|
|
|
// Create copy via JSON.
|
|
byt, err := json.Marshal(c)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = json.Unmarshal(byt, &ff)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
for _, opt := range ff.Options() {
|
|
if !IsSecretDeploymentOption(opt) {
|
|
continue
|
|
}
|
|
|
|
// This only works with string values for now.
|
|
switch v := opt.Value.(type) {
|
|
case *clibase.String:
|
|
err := v.Set("")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
default:
|
|
return nil, xerrors.Errorf("unsupported type %T", v)
|
|
}
|
|
}
|
|
|
|
return &ff, nil
|
|
}
|
|
|
|
// DeploymentConfig returns the deployment config for the coder server.
|
|
func (c *Client) DeploymentConfig(ctx context.Context) (*DeploymentConfig, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/deployment/config", nil)
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("execute request: %w", err)
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return nil, ReadBodyAsError(res)
|
|
}
|
|
|
|
conf := &DeploymentValues{}
|
|
resp := &DeploymentConfig{
|
|
Values: conf,
|
|
Options: conf.Options(),
|
|
}
|
|
return resp, json.NewDecoder(res.Body).Decode(resp)
|
|
}
|
|
|
|
func (c *Client) DeploymentStats(ctx context.Context) (DeploymentStats, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/deployment/stats", nil)
|
|
if err != nil {
|
|
return DeploymentStats{}, xerrors.Errorf("execute request: %w", err)
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return DeploymentStats{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var df DeploymentStats
|
|
return df, json.NewDecoder(res.Body).Decode(&df)
|
|
}
|
|
|
|
type AppearanceConfig struct {
|
|
LogoURL string `json:"logo_url"`
|
|
ServiceBanner ServiceBannerConfig `json:"service_banner"`
|
|
SupportLinks []LinkConfig `json:"support_links,omitempty"`
|
|
}
|
|
|
|
type UpdateAppearanceConfig struct {
|
|
LogoURL string `json:"logo_url"`
|
|
ServiceBanner ServiceBannerConfig `json:"service_banner"`
|
|
}
|
|
|
|
type ServiceBannerConfig struct {
|
|
Enabled bool `json:"enabled"`
|
|
Message string `json:"message,omitempty"`
|
|
BackgroundColor string `json:"background_color,omitempty"`
|
|
}
|
|
|
|
// Appearance returns the configuration that modifies the visual
|
|
// display of the dashboard.
|
|
func (c *Client) Appearance(ctx context.Context) (AppearanceConfig, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/appearance", nil)
|
|
if err != nil {
|
|
return AppearanceConfig{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
if res.StatusCode != http.StatusOK {
|
|
return AppearanceConfig{}, ReadBodyAsError(res)
|
|
}
|
|
var cfg AppearanceConfig
|
|
return cfg, json.NewDecoder(res.Body).Decode(&cfg)
|
|
}
|
|
|
|
func (c *Client) UpdateAppearance(ctx context.Context, appearance UpdateAppearanceConfig) error {
|
|
res, err := c.Request(ctx, http.MethodPut, "/api/v2/appearance", appearance)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer res.Body.Close()
|
|
if res.StatusCode != http.StatusOK {
|
|
return ReadBodyAsError(res)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// BuildInfoResponse contains build information for this instance of Coder.
|
|
type BuildInfoResponse struct {
|
|
// ExternalURL references the current Coder version.
|
|
// For production builds, this will link directly to a release. For development builds, this will link to a commit.
|
|
ExternalURL string `json:"external_url"`
|
|
// Version returns the semantic version of the build.
|
|
Version string `json:"version"`
|
|
|
|
// DashboardURL is the URL to hit the deployment's dashboard.
|
|
// For external workspace proxies, this is the coderd they are connected
|
|
// to.
|
|
DashboardURL string `json:"dashboard_url"`
|
|
|
|
WorkspaceProxy bool `json:"workspace_proxy"`
|
|
}
|
|
|
|
type WorkspaceProxyBuildInfo struct {
|
|
// TODO: @emyrk what should we include here?
|
|
WorkspaceProxy bool `json:"workspace_proxy"`
|
|
// DashboardURL is the URL of the coderd this proxy is connected to.
|
|
DashboardURL string `json:"dashboard_url"`
|
|
}
|
|
|
|
// CanonicalVersion trims build information from the version.
|
|
// E.g. 'v0.7.4-devel+11573034' -> 'v0.7.4'.
|
|
func (b BuildInfoResponse) CanonicalVersion() string {
|
|
// We do a little hack here to massage the string into a form
|
|
// that works well with semver.
|
|
trimmed := strings.ReplaceAll(b.Version, "-devel+", "+devel-")
|
|
return semver.Canonical(trimmed)
|
|
}
|
|
|
|
// BuildInfo returns build information for this instance of Coder.
|
|
func (c *Client) BuildInfo(ctx context.Context) (BuildInfoResponse, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/buildinfo", nil)
|
|
if err != nil {
|
|
return BuildInfoResponse{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return BuildInfoResponse{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var buildInfo BuildInfoResponse
|
|
return buildInfo, json.NewDecoder(res.Body).Decode(&buildInfo)
|
|
}
|
|
|
|
type Experiment string
|
|
|
|
const (
|
|
// ExperimentMoons enabled the workspace proxy endpoints and CRUD. This
|
|
// feature is not yet complete in functionality.
|
|
ExperimentMoons Experiment = "moons"
|
|
|
|
// https://github.com/coder/coder/milestone/19
|
|
ExperimentWorkspaceActions Experiment = "workspace_actions"
|
|
|
|
// Add new experiments here!
|
|
// ExperimentExample Experiment = "example"
|
|
)
|
|
|
|
// ExperimentsAll should include all experiments that are safe for
|
|
// users to opt-in to via --experimental='*'.
|
|
// Experiments that are not ready for consumption by all users should
|
|
// not be included here and will be essentially hidden.
|
|
var ExperimentsAll = Experiments{}
|
|
|
|
// Experiments is a list of experiments that are enabled for the deployment.
|
|
// Multiple experiments may be enabled at the same time.
|
|
// Experiments are not safe for production use, and are not guaranteed to
|
|
// be backwards compatible. They may be removed or renamed at any time.
|
|
type Experiments []Experiment
|
|
|
|
func (e Experiments) Enabled(ex Experiment) bool {
|
|
for _, v := range e {
|
|
if v == ex {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (c *Client) Experiments(ctx context.Context) (Experiments, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/experiments", nil)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer res.Body.Close()
|
|
if res.StatusCode != http.StatusOK {
|
|
return nil, ReadBodyAsError(res)
|
|
}
|
|
var exp []Experiment
|
|
return exp, json.NewDecoder(res.Body).Decode(&exp)
|
|
}
|
|
|
|
type DeploymentDAUsResponse struct {
|
|
Entries []DAUEntry `json:"entries"`
|
|
}
|
|
|
|
func (c *Client) DeploymentDAUs(ctx context.Context) (*DeploymentDAUsResponse, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/insights/daus", nil)
|
|
if err != nil {
|
|
return nil, xerrors.Errorf("execute request: %w", err)
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return nil, ReadBodyAsError(res)
|
|
}
|
|
|
|
var resp DeploymentDAUsResponse
|
|
return &resp, json.NewDecoder(res.Body).Decode(&resp)
|
|
}
|
|
|
|
type AppHostResponse struct {
|
|
// Host is the externally accessible URL for the Coder instance.
|
|
Host string `json:"host"`
|
|
}
|
|
|
|
// AppHost returns the site-wide application wildcard hostname without the
|
|
// leading "*.", e.g. "apps.coder.com". Apps are accessible at:
|
|
// "<app-name>--<agent-name>--<workspace-name>--<username>.<app-host>", e.g.
|
|
// "my-app--agent--workspace--username.apps.coder.com".
|
|
//
|
|
// If the app host is not set, the response will contain an empty string.
|
|
func (c *Client) AppHost(ctx context.Context) (AppHostResponse, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/applications/host", nil)
|
|
if err != nil {
|
|
return AppHostResponse{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return AppHostResponse{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var host AppHostResponse
|
|
return host, json.NewDecoder(res.Body).Decode(&host)
|
|
}
|
|
|
|
type WorkspaceConnectionLatencyMS struct {
|
|
P50 float64
|
|
P95 float64
|
|
}
|
|
|
|
type WorkspaceDeploymentStats struct {
|
|
Pending int64 `json:"pending"`
|
|
Building int64 `json:"building"`
|
|
Running int64 `json:"running"`
|
|
Failed int64 `json:"failed"`
|
|
Stopped int64 `json:"stopped"`
|
|
|
|
ConnectionLatencyMS WorkspaceConnectionLatencyMS `json:"connection_latency_ms"`
|
|
RxBytes int64 `json:"rx_bytes"`
|
|
TxBytes int64 `json:"tx_bytes"`
|
|
}
|
|
|
|
type SessionCountDeploymentStats struct {
|
|
VSCode int64 `json:"vscode"`
|
|
SSH int64 `json:"ssh"`
|
|
JetBrains int64 `json:"jetbrains"`
|
|
ReconnectingPTY int64 `json:"reconnecting_pty"`
|
|
}
|
|
|
|
type DeploymentStats struct {
|
|
// AggregatedFrom is the time in which stats are aggregated from.
|
|
// This might be back in time a specific duration or interval.
|
|
AggregatedFrom time.Time `json:"aggregated_from" format:"date-time"`
|
|
// CollectedAt is the time in which stats are collected at.
|
|
CollectedAt time.Time `json:"collected_at" format:"date-time"`
|
|
// NextUpdateAt is the time when the next batch of stats will
|
|
// be updated.
|
|
NextUpdateAt time.Time `json:"next_update_at" format:"date-time"`
|
|
|
|
Workspaces WorkspaceDeploymentStats `json:"workspaces"`
|
|
SessionCount SessionCountDeploymentStats `json:"session_count"`
|
|
}
|
|
|
|
type SSHConfigResponse struct {
|
|
HostnamePrefix string `json:"hostname_prefix"`
|
|
SSHConfigOptions map[string]string `json:"ssh_config_options"`
|
|
}
|
|
|
|
// SSHConfiguration returns information about the SSH configuration for the
|
|
// Coder instance.
|
|
func (c *Client) SSHConfiguration(ctx context.Context) (SSHConfigResponse, error) {
|
|
res, err := c.Request(ctx, http.MethodGet, "/api/v2/deployment/ssh", nil)
|
|
if err != nil {
|
|
return SSHConfigResponse{}, err
|
|
}
|
|
defer res.Body.Close()
|
|
|
|
if res.StatusCode != http.StatusOK {
|
|
return SSHConfigResponse{}, ReadBodyAsError(res)
|
|
}
|
|
|
|
var sshConfig SSHConfigResponse
|
|
return sshConfig, json.NewDecoder(res.Body).Decode(&sshConfig)
|
|
}
|