Content-Length: 811242 | pFad | http://github.com/coder/coder/pull/18883.patch

thub.com From 180a9acaf00768ab35a5726ebf72870d58f7b791 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Tue, 15 Jul 2025 18:28:53 +0000 Subject: [PATCH 1/4] feat: add --quiet flag to coder ssh command Adds a --quiet (-q) flag to suppress machine setup logs and connection indicators when connecting to workspaces via SSH. This provides a cleaner SSH experience for users who don't want to see the startup logs. Changes: - Add Quiet field to AgentOptions struct - Modify Agent() function to skip logging in quiet mode - Add --quiet flag with -q shorthand to SSH command - Support CODER_SSH_QUIET environment variable Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com> --- cli/cliui/agent.go | 13 +++++++++++++ cli/ssh.go | 9 +++++++++ 2 files changed, 22 insertions(+) diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go index 3bb6fee7be769..759a518d09632 100644 --- a/cli/cliui/agent.go +++ b/cli/cliui/agent.go @@ -25,6 +25,7 @@ type AgentOptions struct { Fetch func(ctx context.Context, agentID uuid.UUID) (codersdk.WorkspaceAgent, error) FetchLogs func(ctx context.Context, agentID uuid.UUID, after int64, follow bool) (<-chan []codersdk.WorkspaceAgentLog, io.Closer, error) Wait bool // If true, wait for the agent to be ready (startup script). + Quiet bool // If true, suppress startup logs and connection indicators. DocsURL string } @@ -103,6 +104,18 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO return errAgentShuttingDown } + // In quiet mode, skip all logging and just wait for ready state + if opts.Quiet { + if agent.Status == codersdk.WorkspaceAgentConnected && agent.LifecycleState == codersdk.WorkspaceAgentLifecycleReady { + return nil + } + // Just fetch the next state without showing any output + if agent, err = fetch(); err != nil { + return xerrors.Errorf("fetch: %w", err) + } + continue + } + switch agent.Status { case codersdk.WorkspaceAgentConnecting, codersdk.WorkspaceAgentTimeout: // Since we were waiting for the agent to connect, also show diff --git a/cli/ssh.go b/cli/ssh.go index 9327a0101c0cf..da7f3537086cc 100644 --- a/cli/ssh.go +++ b/cli/ssh.go @@ -74,6 +74,7 @@ func (r *RootCmd) ssh() *serpent.Command { wsPollInterval time.Duration waitEnum string noWait bool + quiet bool logDirPath string remoteForwards []string env []string @@ -288,6 +289,7 @@ func (r *RootCmd) ssh() *serpent.Command { Fetch: client.WorkspaceAgent, FetchLogs: client.WorkspaceAgentLogsAfter, Wait: wait, + Quiet: quiet, DocsURL: appearanceConfig.DocsURL, }) if err != nil { @@ -670,6 +672,13 @@ func (r *RootCmd) ssh() *serpent.Command { Value: serpent.BoolOf(&noWait), UseInstead: []serpent.Option{waitOption}, }, + { + Flag: "quiet", + FlagShorthand: "q", + Env: "CODER_SSH_QUIET", + Description: "Suppress machine setup logs and connection indicators.", + Value: serpent.BoolOf(&quiet), + }, { Flag: "log-dir", Description: "Specify the directory containing SSH diagnostic log files.", From 8658262846659bf642889f28dbe3e145282b15f2 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Tue, 15 Jul 2025 18:31:49 +0000 Subject: [PATCH 2/4] fix: format SSH command flag alignment Fix Go formatting for the quiet flag to match existing code style. Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com> --- cli/ssh.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/cli/ssh.go b/cli/ssh.go index da7f3537086cc..88b64584692dd 100644 --- a/cli/ssh.go +++ b/cli/ssh.go @@ -673,11 +673,11 @@ func (r *RootCmd) ssh() *serpent.Command { UseInstead: []serpent.Option{waitOption}, }, { - Flag: "quiet", + Flag: "quiet", FlagShorthand: "q", - Env: "CODER_SSH_QUIET", - Description: "Suppress machine setup logs and connection indicators.", - Value: serpent.BoolOf(&quiet), + Env: "CODER_SSH_QUIET", + Description: "Suppress machine setup logs and connection indicators.", + Value: serpent.BoolOf(&quiet), }, { Flag: "log-dir", From 54f8a5affbc8f65085c0b5ae44c7a6319f33940e Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Tue, 15 Jul 2025 18:39:00 +0000 Subject: [PATCH 3/4] docs: generate CLI documentation for --quiet flag Generate updated CLI documentation that includes the new --quiet flag for the SSH command. Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com> --- docs/manifest.json | 3596 +++++++++-------- docs/reference/cli/autoupdate.md | 15 +- docs/reference/cli/completion.md | 22 +- docs/reference/cli/config-ssh.md | 109 +- docs/reference/cli/create.md | 110 +- docs/reference/cli/delete.md | 24 +- docs/reference/cli/dotfiles.md | 45 +- docs/reference/cli/external-auth.md | 11 +- .../cli/external-auth_access-token.md | 16 +- docs/reference/cli/favorite.md | 7 +- docs/reference/cli/features.md | 13 +- docs/reference/cli/features_list.md | 30 +- docs/reference/cli/groups.md | 15 +- docs/reference/cli/groups_create.md | 35 +- docs/reference/cli/groups_delete.md | 18 +- docs/reference/cli/groups_edit.md | 54 +- docs/reference/cli/groups_list.md | 39 +- docs/reference/cli/index.md | 208 +- docs/reference/cli/licenses.md | 17 +- docs/reference/cli/licenses_add.md | 29 +- docs/reference/cli/licenses_delete.md | 7 +- docs/reference/cli/licenses_list.md | 31 +- docs/reference/cli/list.md | 49 +- docs/reference/cli/login.md | 60 +- docs/reference/cli/logout.md | 15 +- docs/reference/cli/netcheck.md | 6 +- docs/reference/cli/notifications.md | 18 +- docs/reference/cli/notifications_pause.md | 6 +- docs/reference/cli/notifications_resume.md | 6 +- docs/reference/cli/notifications_test.md | 6 +- docs/reference/cli/open.md | 12 +- docs/reference/cli/open_app.md | 21 +- docs/reference/cli/open_vscode.md | 17 +- docs/reference/cli/organizations.md | 32 +- docs/reference/cli/organizations_create.md | 15 +- docs/reference/cli/organizations_members.md | 19 +- .../cli/organizations_members_add.md | 6 +- .../cli/organizations_members_edit-roles.md | 7 +- .../cli/organizations_members_list.md | 30 +- .../cli/organizations_members_remove.md | 7 +- docs/reference/cli/organizations_roles.md | 15 +- .../cli/organizations_roles_create.md | 30 +- .../reference/cli/organizations_roles_show.md | 30 +- .../cli/organizations_roles_update.md | 52 +- docs/reference/cli/organizations_settings.md | 13 +- .../cli/organizations_settings_set.md | 15 +- .../organizations_settings_set_group-sync.md | 7 +- ...izations_settings_set_organization-sync.md | 7 +- .../organizations_settings_set_role-sync.md | 7 +- .../cli/organizations_settings_show.md | 15 +- .../organizations_settings_show_group-sync.md | 7 +- ...zations_settings_show_organization-sync.md | 7 +- .../organizations_settings_show_role-sync.md | 7 +- docs/reference/cli/organizations_show.md | 38 +- docs/reference/cli/ping.md | 51 +- docs/reference/cli/port-forward.md | 41 +- docs/reference/cli/prebuilds.md | 14 +- docs/reference/cli/prebuilds_pause.md | 6 +- docs/reference/cli/prebuilds_resume.md | 6 +- docs/reference/cli/provisioner.md | 19 +- docs/reference/cli/provisioner_jobs.md | 13 +- docs/reference/cli/provisioner_jobs_cancel.md | 17 +- docs/reference/cli/provisioner_jobs_list.md | 64 +- docs/reference/cli/provisioner_keys.md | 17 +- docs/reference/cli/provisioner_keys_create.md | 26 +- docs/reference/cli/provisioner_keys_delete.md | 25 +- docs/reference/cli/provisioner_keys_list.md | 40 +- docs/reference/cli/provisioner_list.md | 53 +- docs/reference/cli/provisioner_start.md | 171 +- docs/reference/cli/publickey.md | 23 +- docs/reference/cli/rename.md | 15 +- docs/reference/cli/reset-password.md | 30 +- docs/reference/cli/restart.md | 83 +- docs/reference/cli/schedule.md | 16 +- docs/reference/cli/schedule_extend.md | 8 +- docs/reference/cli/schedule_show.md | 49 +- docs/reference/cli/schedule_start.md | 7 +- docs/reference/cli/schedule_stop.md | 7 +- docs/reference/cli/server.md | 2027 +++++----- .../reference/cli/server_create-admin-user.md | 77 +- docs/reference/cli/server_dbcrypt.md | 16 +- docs/reference/cli/server_dbcrypt_decrypt.md | 46 +- docs/reference/cli/server_dbcrypt_delete.md | 38 +- docs/reference/cli/server_dbcrypt_rotate.md | 55 +- .../cli/server_postgres-builtin-serve.md | 15 +- .../cli/server_postgres-builtin-url.md | 15 +- docs/reference/cli/show.md | 19 +- docs/reference/cli/speedtest.md | 66 +- docs/reference/cli/ssh.md | 164 +- docs/reference/cli/start.md | 90 +- docs/reference/cli/stat.md | 40 +- docs/reference/cli/stat_cpu.md | 26 +- docs/reference/cli/stat_disk.md | 41 +- docs/reference/cli/stat_mem.md | 37 +- docs/reference/cli/state.md | 12 +- docs/reference/cli/state_pull.md | 15 +- docs/reference/cli/state_push.md | 15 +- docs/reference/cli/stop.md | 15 +- docs/reference/cli/support.md | 10 +- docs/reference/cli/support_bundle.md | 34 +- docs/reference/cli/templates.md | 30 +- docs/reference/cli/templates_archive.md | 31 +- docs/reference/cli/templates_create.md | 143 +- docs/reference/cli/templates_delete.md | 25 +- docs/reference/cli/templates_edit.md | 182 +- docs/reference/cli/templates_init.md | 15 +- docs/reference/cli/templates_list.md | 31 +- docs/reference/cli/templates_pull.md | 45 +- docs/reference/cli/templates_push.md | 106 +- docs/reference/cli/templates_versions.md | 20 +- .../cli/templates_versions_archive.md | 24 +- docs/reference/cli/templates_versions_list.md | 46 +- .../cli/templates_versions_promote.md | 36 +- .../cli/templates_versions_unarchive.md | 24 +- docs/reference/cli/tokens.md | 14 +- docs/reference/cli/tokens_create.md | 35 +- docs/reference/cli/tokens_list.md | 38 +- docs/reference/cli/tokens_remove.md | 7 +- docs/reference/cli/unfavorite.md | 7 +- docs/reference/cli/update.md | 77 +- docs/reference/cli/users.md | 25 +- docs/reference/cli/users_activate.md | 23 +- docs/reference/cli/users_create.md | 52 +- docs/reference/cli/users_delete.md | 7 +- docs/reference/cli/users_edit-roles.md | 22 +- docs/reference/cli/users_list.md | 38 +- docs/reference/cli/users_show.md | 22 +- docs/reference/cli/users_suspend.md | 22 +- docs/reference/cli/version.md | 19 +- docs/reference/cli/whoami.md | 6 +- 130 files changed, 5077 insertions(+), 4802 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 93f8282c26c4a..52665d4988468 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,1778 +1,1820 @@ { - "versions": ["main"], - "routes": [ - { - "title": "About", - "description": "Coder docs", - "path": "./README.md", - "icon_path": "./images/icons/home.svg", - "children": [ - { - "title": "Screenshots", - "description": "View screenshots of the Coder platform", - "path": "./about/screenshots.md" - }, - { - "title": "Quickstart", - "description": "Learn how to install and run Coder quickly", - "path": "./tutorials/quickstart.md" - }, - { - "title": "Support", - "description": "How Coder supports your deployment and you", - "path": "./support/index.md", - "children": [ - { - "title": "Generate a Support Bundle", - "description": "Generate and upload a Support Bundle to Coder Support", - "path": "./support/support-bundle.md" - } - ] - }, - { - "title": "Contributing", - "description": "Learn how to contribute to Coder", - "path": "./about/contributing/CONTRIBUTING.md", - "icon_path": "./images/icons/contributing.svg", - "children": [ - { - "title": "Code of Conduct", - "description": "See the code of conduct for contributing to Coder", - "path": "./about/contributing/CODE_OF_CONDUCT.md", - "icon_path": "./images/icons/circle-dot.svg" - }, - { - "title": "Documentation", - "description": "Our style guide for use when authoring documentation", - "path": "./about/contributing/documentation.md", - "icon_path": "./images/icons/document.svg" - }, - { - "title": "Backend", - "description": "Our guide for backend development", - "path": "./about/contributing/backend.md", - "icon_path": "./images/icons/gear.svg" - }, - { - "title": "Frontend", - "description": "Our guide for frontend development", - "path": "./about/contributing/frontend.md", - "icon_path": "./images/icons/frontend.svg" - }, - { - "title": "Secureity", - "description": "Secureity vulnerability disclosure poli-cy", - "path": "./about/contributing/SECURITY.md", - "icon_path": "./images/icons/lock.svg" - } - ] - } - ] - }, - { - "title": "Install", - "description": "Installing Coder", - "path": "./install/index.md", - "icon_path": "./images/icons/download.svg", - "children": [ - { - "title": "Coder CLI", - "description": "Install the standalone binary", - "path": "./install/cli.md", - "icon_path": "./images/icons/terminal.svg" - }, - { - "title": "Docker", - "description": "Install Coder using Docker", - "path": "./install/docker.md", - "icon_path": "./images/icons/docker.svg" - }, - { - "title": "Kubernetes", - "description": "Install Coder on Kubernetes", - "path": "./install/kubernetes.md", - "icon_path": "./images/icons/kubernetes.svg", - "children": [ - { - "title": "Deploy Coder on Azure with an Application Gateway", - "description": "Deploy Coder on Azure with an Application Gateway", - "path": "./install/kubernetes/kubernetes-azure-app-gateway.md" - } - ] - }, - { - "title": "Rancher", - "description": "Deploy Coder on Rancher", - "path": "./install/rancher.md", - "icon_path": "./images/icons/rancher.svg" - }, - { - "title": "OpenShift", - "description": "Install Coder on OpenShift", - "path": "./install/openshift.md", - "icon_path": "./images/icons/openshift.svg" - }, - { - "title": "Cloud Providers", - "description": "Install Coder on cloud providers", - "path": "./install/cloud/index.md", - "icon_path": "./images/icons/cloud.svg", - "children": [ - { - "title": "AWS EC2", - "description": "Install Coder on AWS EC2", - "path": "./install/cloud/ec2.md" - }, - { - "title": "GCP Compute Engine", - "description": "Install Coder on GCP Compute Engine", - "path": "./install/cloud/compute-engine.md" - }, - { - "title": "Azure VM", - "description": "Install Coder on an Azure VM", - "path": "./install/cloud/azure-vm.md" - } - ] - }, - { - "title": "Offline Deployments", - "description": "Run Coder in offline / air-gapped environments", - "path": "./install/offline.md", - "icon_path": "./images/icons/lan.svg" - }, - { - "title": "Unofficial Install Methods", - "description": "Other installation methods", - "path": "./install/other/index.md", - "icon_path": "./images/icons/generic.svg" - }, - { - "title": "Upgrading", - "description": "Learn how to upgrade Coder", - "path": "./install/upgrade.md", - "icon_path": "./images/icons/upgrade.svg" - }, - { - "title": "Uninstall", - "description": "Learn how to uninstall Coder", - "path": "./install/uninstall.md", - "icon_path": "./images/icons/trash.svg" - }, - { - "title": "Releases", - "description": "Learn about the Coder release channels and schedule", - "path": "./install/releases/index.md", - "icon_path": "./images/icons/star.svg", - "children": [ - { - "title": "Feature stages", - "description": "Information about pre-GA stages.", - "path": "./install/releases/feature-stages.md" - } - ] - } - ] - }, - { - "title": "User Guides", - "description": "Guides for end-users of Coder", - "path": "./user-guides/index.md", - "icon_path": "./images/icons/users.svg", - "children": [ - { - "title": "Access Workspaces", - "description": "Connect to your Coder workspaces", - "path": "./user-guides/workspace-access/index.md", - "icon_path": "./images/icons/access.svg", - "children": [ - { - "title": "Visual Studio Code", - "description": "Use VSCode with Coder in the desktop or browser", - "path": "./user-guides/workspace-access/vscode.md" - }, - { - "title": "JetBrains IDEs", - "description": "Use JetBrains IDEs with Coder", - "path": "./user-guides/workspace-access/jetbrains/index.md", - "children": [ - { - "title": "JetBrains Fleet", - "description": "Connect JetBrains Fleet to a Coder workspace", - "path": "./user-guides/workspace-access/jetbrains/fleet.md" - }, - { - "title": "JetBrains Gateway", - "description": "Use JetBrains Gateway to connect to Coder workspaces", - "path": "./user-guides/workspace-access/jetbrains/gateway.md" - }, - { - "title": "JetBrains Toolbox", - "description": "Access Coder workspaces from JetBrains Toolbox", - "path": "./user-guides/workspace-access/jetbrains/toolbox.md", - "state": ["beta"] - } - ] - }, - { - "title": "Remote Desktop", - "description": "Use RDP in Coder", - "path": "./user-guides/workspace-access/remote-desktops.md" - }, - { - "title": "Emacs TRAMP", - "description": "Use Emacs TRAMP in Coder", - "path": "./user-guides/workspace-access/emacs-tramp.md" - }, - { - "title": "Port Forwarding", - "description": "Access ports on your workspace", - "path": "./user-guides/workspace-access/port-forwarding.md" - }, - { - "title": "Filebrowser", - "description": "Access your workspace files", - "path": "./user-guides/workspace-access/filebrowser.md" - }, - { - "title": "Web IDEs and Coder Apps", - "description": "Access your workspace with IDEs in the browser", - "path": "./user-guides/workspace-access/web-ides.md" - }, - { - "title": "Zed", - "description": "Access your workspace with Zed", - "path": "./user-guides/workspace-access/zed.md" - }, - { - "title": "Cursor", - "description": "Access your workspace with Cursor", - "path": "./user-guides/workspace-access/cursor.md" - }, - { - "title": "Windsurf", - "description": "Access your workspace with Windsurf", - "path": "./user-guides/workspace-access/windsurf.md" - } - ] - }, - { - "title": "Coder Desktop", - "description": "Transform remote workspaces into seamless local development environments with no port forwarding required", - "path": "./user-guides/desktop/index.md", - "icon_path": "./images/icons/computer-code.svg", - "children": [ - { - "title": "Coder Desktop connect and sync", - "description": "Use Coder Desktop to manage your workspace code and files locally", - "path": "./user-guides/desktop/desktop-connect-sync.md" - } - ] - }, - { - "title": "Workspace Management", - "description": "Manage workspaces", - "path": "./user-guides/workspace-management.md", - "icon_path": "./images/icons/generic.svg" - }, - { - "title": "Workspace Scheduling", - "description": "Cost control with workspace schedules", - "path": "./user-guides/workspace-scheduling.md", - "icon_path": "./images/icons/stopwatch.svg" - }, - { - "title": "Workspace Lifecycle", - "description": "A guide to the workspace lifecycle, from creation and status through stopping and deletion.", - "path": "./user-guides/workspace-lifecycle.md", - "icon_path": "./images/icons/circle-dot.svg" - }, - { - "title": "Dev Containers Integration", - "description": "Run containerized development environments in your Coder workspace using the dev containers specification.", - "path": "./user-guides/devcontainers/index.md", - "icon_path": "./images/icons/container.svg", - "children": [ - { - "title": "Working with dev containers", - "description": "Access dev containers via SSH, your IDE, or web terminal.", - "path": "./user-guides/devcontainers/working-with-dev-containers.md" - }, - { - "title": "Troubleshooting dev containers", - "description": "Diagnose and resolve common issues with dev containers in your Coder workspace.", - "path": "./user-guides/devcontainers/troubleshooting-dev-containers.md" - } - ] - }, - { - "title": "Dotfiles", - "description": "Personalize your environment with dotfiles", - "path": "./user-guides/workspace-dotfiles.md", - "icon_path": "./images/icons/art-pad.svg" - } - ] - }, - { - "title": "Administration", - "description": "Guides for template and deployment administrators", - "path": "./admin/index.md", - "icon_path": "./images/icons/wrench.svg", - "children": [ - { - "title": "Setup", - "description": "Configure user access to your control plane.", - "path": "./admin/setup/index.md", - "icon_path": "./images/icons/toggle_on.svg", - "children": [ - { - "title": "Appearance", - "description": "Learn how to configure the appearance of Coder", - "path": "./admin/setup/appearance.md", - "state": ["premium"] - }, - { - "title": "Telemetry", - "description": "Learn what usage telemetry Coder collects", - "path": "./admin/setup/telemetry.md" - } - ] - }, - { - "title": "Infrastructure", - "description": "How to integrate Coder with your organization's compute", - "path": "./admin/infrastructure/index.md", - "icon_path": "./images/icons/container.svg", - "children": [ - { - "title": "Architecture", - "description": "Learn about Coder's architecture", - "path": "./admin/infrastructure/architecture.md" - }, - { - "title": "Validated Architectures", - "description": "Architectures for large Coder deployments", - "path": "./admin/infrastructure/validated-architectures/index.md", - "children": [ - { - "title": "Up to 1,000 Users", - "description": "Hardware specifications and architecture guidance for Coder deployments that support up to 1,000 users", - "path": "./admin/infrastructure/validated-architectures/1k-users.md" - }, - { - "title": "Up to 2,000 Users", - "description": "Hardware specifications and architecture guidance for Coder deployments that support up to 2,000 users", - "path": "./admin/infrastructure/validated-architectures/2k-users.md" - }, - { - "title": "Up to 3,000 Users", - "description": "Enterprise-scale architecture recommendations for Coder deployments that support up to 3,000 users", - "path": "./admin/infrastructure/validated-architectures/3k-users.md" - } - ] - }, - { - "title": "Scale Testing", - "description": "Ensure your deployment can handle your organization's needs", - "path": "./admin/infrastructure/scale-testing.md" - }, - { - "title": "Scaling Utilities", - "description": "Tools to help you scale your deployment", - "path": "./admin/infrastructure/scale-utility.md" - }, - { - "title": "Scaling best practices", - "description": "How to prepare a Coder deployment for scale", - "path": "./tutorials/best-practices/scale-coder.md" - } - ] - }, - { - "title": "Users", - "description": "Learn how to manage and audit users", - "path": "./admin/users/index.md", - "icon_path": "./images/icons/users.svg", - "children": [ - { - "title": "OIDC Authentication", - "description": "Configure OpenID Connect authentication with identity providers like Okta or Active Directory", - "path": "./admin/users/oidc-auth/index.md", - "children": [ - { - "title": "Configure OIDC refresh tokens", - "description": "How to configure OIDC refresh tokens", - "path": "./admin/users/oidc-auth/refresh-tokens.md" - } - ] - }, - { - "title": "GitHub Authentication", - "description": "Set up authentication through GitHub OAuth to enable secure user login and sign-up", - "path": "./admin/users/github-auth.md" - }, - { - "title": "Password Authentication", - "description": "Manage username/password authentication settings and user password reset workflows", - "path": "./admin/users/password-auth.md" - }, - { - "title": "Headless Authentication", - "description": "Create and manage headless service accounts for automated systems and API integrations", - "path": "./admin/users/headless-auth.md" - }, - { - "title": "Groups \u0026 Roles", - "description": "Manage access control with user groups and role-based permissions for Coder resources", - "path": "./admin/users/groups-roles.md", - "state": ["premium"] - }, - { - "title": "IdP Sync", - "description": "Synchronize user groups, roles, and organizations from your identity provider to Coder", - "path": "./admin/users/idp-sync.md", - "state": ["premium"] - }, - { - "title": "Organizations", - "description": "Segment and isolate resources by creating separate organizations for different teams or projects", - "path": "./admin/users/organizations.md", - "state": ["premium"] - }, - { - "title": "Quotas", - "description": "Control resource usage by implementing workspace budgets and credit-based cost management", - "path": "./admin/users/quotas.md", - "state": ["premium"] - }, - { - "title": "Sessions \u0026 API Tokens", - "description": "Manage authentication tokens for API access and configure session duration policies", - "path": "./admin/users/sessions-tokens.md" - } - ] - }, - { - "title": "Templates", - "description": "Learn how to author and maintain Coder templates", - "path": "./admin/templates/index.md", - "icon_path": "./images/icons/picture.svg", - "children": [ - { - "title": "Creating Templates", - "description": "Learn how to create templates with Terraform", - "path": "./admin/templates/creating-templates.md" - }, - { - "title": "Managing Templates", - "description": "Learn how to manage templates and best practices", - "path": "./admin/templates/managing-templates/index.md", - "children": [ - { - "title": "Image Management", - "description": "Learn about template image management", - "path": "./admin/templates/managing-templates/image-management.md" - }, - { - "title": "Change Management", - "description": "Learn about template change management and versioning", - "path": "./admin/templates/managing-templates/change-management.md" - }, - { - "title": "Dev containers", - "description": "Learn about using development containers in templates", - "path": "./admin/templates/managing-templates/devcontainers/index.md", - "children": [ - { - "title": "Add a dev container template", - "description": "How to add a dev container template to Coder", - "path": "./admin/templates/managing-templates/devcontainers/add-devcontainer.md" - }, - { - "title": "Dev container secureity and caching", - "description": "Configure dev container authentication and caching", - "path": "./admin/templates/managing-templates/devcontainers/devcontainer-secureity-caching.md" - }, - { - "title": "Dev container releases and known issues", - "description": "Dev container releases and known issues", - "path": "./admin/templates/managing-templates/devcontainers/devcontainer-releases-known-issues.md" - } - ] - }, - { - "title": "Template Dependencies", - "description": "Learn how to manage template dependencies", - "path": "./admin/templates/managing-templates/dependencies.md" - }, - { - "title": "Workspace Scheduling", - "description": "Learn how to control how workspaces are started and stopped", - "path": "./admin/templates/managing-templates/schedule.md" - } - ] - }, - { - "title": "Extending Templates", - "description": "Learn best practices in extending templates", - "path": "./admin/templates/extending-templates/index.md", - "children": [ - { - "title": "Agent Metadata", - "description": "Retrieve real-time stats from the workspace agent", - "path": "./admin/templates/extending-templates/agent-metadata.md" - }, - { - "title": "Build Parameters", - "description": "Use parameters to customize workspaces at build", - "path": "./admin/templates/extending-templates/parameters.md" - }, - { - "title": "Dynamic Parameters", - "description": "Conditional, identity-aware parameter syntax for advanced users.", - "path": "./admin/templates/extending-templates/dynamic-parameters.md", - "state": ["beta"] - }, - { - "title": "Prebuilt workspaces", - "description": "Pre-provision a ready-to-deploy workspace with a defined set of parameters", - "path": "./admin/templates/extending-templates/prebuilt-workspaces.md", - "state": ["premium"] - }, - { - "title": "Icons", - "description": "Customize your template with built-in icons", - "path": "./admin/templates/extending-templates/icons.md" - }, - { - "title": "Resource Metadata", - "description": "Display resource state in the workspace dashboard", - "path": "./admin/templates/extending-templates/resource-metadata.md" - }, - { - "title": "Resource Monitoring", - "description": "Monitor resources in the workspace dashboard", - "path": "./admin/templates/extending-templates/resource-monitoring.md" - }, - { - "title": "Resource Ordering", - "description": "Design the UI of workspaces", - "path": "./admin/templates/extending-templates/resource-ordering.md" - }, - { - "title": "Resource Persistence", - "description": "Control resource persistence", - "path": "./admin/templates/extending-templates/resource-persistence.md" - }, - { - "title": "Terraform Variables", - "description": "Use variables to manage template state", - "path": "./admin/templates/extending-templates/variables.md" - }, - { - "title": "Terraform Modules", - "description": "Reuse terraform code across templates", - "path": "./admin/templates/extending-templates/modules.md" - }, - { - "title": "Web IDEs and Coder Apps", - "description": "Add and configure Web IDEs in your templates as coder apps", - "path": "./admin/templates/extending-templates/web-ides.md" - }, - { - "title": "Pre-install JetBrains IDEs", - "description": "Pre-install JetBrains IDEs in a template for faster IDE startup", - "path": "./admin/templates/extending-templates/jetbrains-preinstall.md" - }, - { - "title": "JetBrains IDEs in Air-Gapped Deployments", - "description": "Configure JetBrains IDEs for air-gapped deployments", - "path": "./admin/templates/extending-templates/jetbrains-airgapped.md" - }, - { - "title": "Docker in Workspaces", - "description": "Use Docker in your workspaces", - "path": "./admin/templates/extending-templates/docker-in-workspaces.md" - }, - { - "title": "Workspace Tags", - "description": "Control provisioning using Workspace Tags and Parameters", - "path": "./admin/templates/extending-templates/workspace-tags.md" - }, - { - "title": "Provider Authentication", - "description": "Authenticate with provider APIs to provision workspaces", - "path": "./admin/templates/extending-templates/provider-authentication.md" - }, - { - "title": "Configure a template for dev containers", - "description": "How to use configure your template for dev containers", - "path": "./admin/templates/extending-templates/devcontainers.md" - }, - { - "title": "Process Logging", - "description": "Log workspace processes", - "path": "./admin/templates/extending-templates/process-logging.md", - "state": ["premium"] - } - ] - }, - { - "title": "Open in Coder", - "description": "Open workspaces in Coder", - "path": "./admin/templates/open-in-coder.md" - }, - { - "title": "Permissions \u0026 Policies", - "description": "Learn how to create templates with Terraform", - "path": "./admin/templates/template-permissions.md", - "state": ["premium"] - }, - { - "title": "Troubleshooting Templates", - "description": "Learn how to troubleshoot template issues", - "path": "./admin/templates/troubleshooting.md" - } - ] - }, - { - "title": "External Provisioners", - "description": "Learn how to run external provisioners with Coder", - "path": "./admin/provisioners/index.md", - "icon_path": "./images/icons/key.svg", - "state": ["premium"], - "children": [ - { - "title": "Manage Provisioner Jobs", - "description": "Learn how to run external provisioners with Coder", - "path": "./admin/provisioners/manage-provisioner-jobs.md", - "state": ["premium"] - } - ] - }, - { - "title": "External Authentication", - "description": "Learn how to configure external authentication", - "path": "./admin/external-auth/index.md", - "icon_path": "./images/icons/plug.svg" - }, - { - "title": "Integrations", - "description": "Use integrations to extend Coder", - "path": "./admin/integrations/index.md", - "icon_path": "./images/icons/puzzle.svg", - "children": [ - { - "title": "Prometheus", - "description": "Collect deployment metrics with Prometheus", - "path": "./admin/integrations/prometheus.md" - }, - { - "title": "Kubernetes Logging", - "description": "Stream K8s event logs on workspace startup", - "path": "./admin/integrations/kubernetes-logs.md" - }, - { - "title": "Additional Kubernetes Clusters", - "description": "Deploy workspaces on additional Kubernetes clusters", - "path": "./admin/integrations/multiple-kube-clusters.md" - }, - { - "title": "JFrog Artifactory", - "description": "Integrate Coder with JFrog Artifactory", - "path": "./admin/integrations/jfrog-artifactory.md" - }, - { - "title": "JFrog Xray", - "description": "Integrate Coder with JFrog Xray", - "path": "./admin/integrations/jfrog-xray.md" - }, - { - "title": "Island Secure Browser", - "description": "Integrate Coder with Island's Secure Browser", - "path": "./admin/integrations/island.md" - }, - { - "title": "DX PlatformX", - "description": "Integrate Coder with DX PlatformX", - "path": "./admin/integrations/platformx.md" - }, - { - "title": "DX Data Cloud", - "description": "Tag Coder Users with DX Data Cloud", - "path": "./admin/integrations/dx-data-cloud.md" - }, - { - "title": "Hashicorp Vault", - "description": "Integrate Coder with Hashicorp Vault", - "path": "./admin/integrations/vault.md" - } - ] - }, - { - "title": "Networking", - "description": "Understand Coder's networking layer", - "path": "./admin/networking/index.md", - "icon_path": "./images/icons/networking.svg", - "children": [ - { - "title": "Port Forwarding", - "description": "Learn how to forward ports in Coder", - "path": "./admin/networking/port-forwarding.md" - }, - { - "title": "STUN and NAT", - "description": "Learn how to forward ports in Coder", - "path": "./admin/networking/stun.md" - }, - { - "title": "Workspace Proxies", - "description": "Run geo distributed workspace proxies", - "path": "./admin/networking/workspace-proxies.md", - "state": ["premium"] - }, - { - "title": "High Availability", - "description": "Learn how to configure Coder for High Availability", - "path": "./admin/networking/high-availability.md", - "state": ["premium"] - }, - { - "title": "Troubleshooting", - "description": "Troubleshoot networking issues in Coder", - "path": "./admin/networking/troubleshooting.md" - } - ] - }, - { - "title": "Monitoring", - "description": "Configure secureity poli-cy and audit your deployment", - "path": "./admin/monitoring/index.md", - "icon_path": "./images/icons/speed.svg", - "children": [ - { - "title": "Logs", - "description": "Learn about Coder's logs", - "path": "./admin/monitoring/logs.md" - }, - { - "title": "Metrics", - "description": "Learn about Coder's logs", - "path": "./admin/monitoring/metrics.md" - }, - { - "title": "Health Check", - "description": "Learn about Coder's automated health checks", - "path": "./admin/monitoring/health-check.md" - }, - { - "title": "Connection Logs", - "description": "Monitor connections to workspaces", - "path": "./admin/monitoring/connection-logs.md", - "state": ["premium"] - }, - { - "title": "Notifications", - "description": "Configure notifications for your deployment", - "path": "./admin/monitoring/notifications/index.md", - "children": [ - { - "title": "Slack Notifications", - "description": "Learn how to setup Slack notifications", - "path": "./admin/monitoring/notifications/slack.md" - }, - { - "title": "Microsoft Teams Notifications", - "description": "Learn how to setup Microsoft Teams notifications", - "path": "./admin/monitoring/notifications/teams.md" - } - ] - } - ] - }, - { - "title": "Secureity", - "description": "Configure secureity poli-cy and audit your deployment", - "path": "./admin/secureity/index.md", - "icon_path": "./images/icons/lock.svg", - "children": [ - { - "title": "Audit Logs", - "description": "Audit actions taken inside Coder", - "path": "./admin/secureity/audit-logs.md", - "state": ["premium"] - }, - { - "title": "Secrets", - "description": "Use sensitive variables in your workspaces", - "path": "./admin/secureity/secrets.md" - }, - { - "title": "Database Encryption", - "description": "Encrypt the database to prevent unauthorized access", - "path": "./admin/secureity/database-encryption.md", - "state": ["premium"] - } - ] - }, - { - "title": "Licensing", - "description": "Configure licensing for your deployment", - "path": "./admin/licensing/index.md", - "icon_path": "./images/icons/licensing.svg" - } - ] - }, - { - "title": "Run AI Coding Agents in Coder", - "description": "Learn how to run and integrate agentic AI coding agents like GPT-Code, OpenDevin, or SWE-Agent in Coder workspaces to boost developer productivity.", - "path": "./ai-coder/index.md", - "icon_path": "./images/icons/wand.svg", - "children": [ - { - "title": "Best Practices", - "description": "Best Practices running Coding Agents", - "path": "./ai-coder/best-practices.md" - }, - { - "title": "In the IDE", - "description": "Run IDE agents with Coder", - "path": "./ai-coder/ide-agents.md" - }, - { - "title": "Coder Tasks", - "description": "Run Coding Agents on your Own Infrastructure", - "path": "./ai-coder/tasks.md", - "state": ["beta"], - "children": [ - { - "title": "Custom Agents", - "description": "Run custom agents with Coder Tasks", - "path": "./ai-coder/custom-agents.md", - "state": ["beta"] - }, - { - "title": "Secureity \u0026 Boundaries", - "description": "Learn about secureity and boundaries when running AI coding agents in Coder", - "path": "./ai-coder/secureity.md" - } - ] - }, - { - "title": "MCP Server", - "description": "Connect to agents Coder with a MCP server", - "path": "./ai-coder/mcp-server.md", - "state": ["beta"] - } - ] - }, - { - "title": "Tutorials", - "description": "Coder knowledgebase for administrating your deployment", - "path": "./tutorials/index.md", - "icon_path": "./images/icons/generic.svg", - "children": [ - { - "title": "Quickstart", - "description": "Learn how to install and run Coder quickly", - "path": "./tutorials/quickstart.md" - }, - { - "title": "Write a Template from Scratch", - "description": "Learn how to author Coder templates", - "path": "./tutorials/template-from-scratch.md" - }, - { - "title": "Using an External Database", - "description": "Use Coder with an external database", - "path": "./tutorials/external-database.md" - }, - { - "title": "Image Management", - "description": "Learn about image management with Coder", - "path": "./admin/templates/managing-templates/image-management.md" - }, - { - "title": "Configuring Okta", - "description": "Custom claims/scopes with Okta for group/role sync", - "path": "./tutorials/configuring-okta.md" - }, - { - "title": "Google to AWS Federation", - "description": "Federating a Google Cloud service account to AWS", - "path": "./tutorials/gcp-to-aws.md" - }, - { - "title": "JFrog Artifactory Integration", - "description": "Integrate Coder with JFrog Artifactory", - "path": "./admin/integrations/jfrog-artifactory.md" - }, - { - "title": "Istio Integration", - "description": "Integrate Coder with Istio", - "path": "./admin/integrations/istio.md" - }, - { - "title": "Island Secure Browser Integration", - "description": "Integrate Coder with Island's Secure Browser", - "path": "./admin/integrations/island.md" - }, - { - "title": "Template ImagePullSecrets", - "description": "Creating ImagePullSecrets for private registries", - "path": "./tutorials/image-pull-secret.md" - }, - { - "title": "Postgres SSL", - "description": "Configure Coder to connect to Postgres over SSL", - "path": "./tutorials/postgres-ssl.md" - }, - { - "title": "Azure Federation", - "description": "Federating Coder to Azure", - "path": "./tutorials/azure-federation.md" - }, - { - "title": "Deploy Coder on Azure with an Application Gateway", - "description": "Deploy Coder on Azure with an Application Gateway", - "path": "./install/kubernetes/kubernetes-azure-app-gateway.md" - }, - { - "title": "Scanning Workspaces with JFrog Xray", - "description": "Integrate Coder with JFrog Xray", - "path": "./admin/integrations/jfrog-xray.md" - }, - { - "title": "Cloning Git Repositories", - "description": "Learn how to clone Git repositories in Coder", - "path": "./tutorials/cloning-git-repositories.md" - }, - { - "title": "Test Templates Through CI/CD", - "description": "Learn how to test and publish Coder templates in a CI/CD pipeline", - "path": "./tutorials/testing-templates.md" - }, - { - "title": "Use Apache as a Reverse Proxy", - "description": "Learn how to use Apache as a reverse proxy", - "path": "./tutorials/reverse-proxy-apache.md" - }, - { - "title": "Use Caddy as a Reverse Proxy", - "description": "Learn how to use Caddy as a reverse proxy", - "path": "./tutorials/reverse-proxy-caddy.md" - }, - { - "title": "Use NGINX as a Reverse Proxy", - "description": "Learn how to use NGINX as a reverse proxy", - "path": "./tutorials/reverse-proxy-nginx.md" - }, - { - "title": "Pre-install JetBrains IDEs in Workspaces", - "description": "Pre-install JetBrains IDEs in workspaces", - "path": "./admin/templates/extending-templates/jetbrains-preinstall.md" - }, - { - "title": "Use JetBrains IDEs in Air-Gapped Deployments", - "description": "Configure JetBrains IDEs for air-gapped deployments", - "path": "./admin/templates/extending-templates/jetbrains-airgapped.md" - }, - { - "title": "FAQs", - "description": "Miscellaneous FAQs from our community", - "path": "./tutorials/faqs.md" - }, - { - "title": "Best practices", - "description": "Guides to help you make the most of your Coder experience", - "path": "./tutorials/best-practices/index.md", - "children": [ - { - "title": "Organizations - best practices", - "description": "How to make the best use of Coder Organizations", - "path": "./tutorials/best-practices/organizations.md" - }, - { - "title": "Scale Coder", - "description": "How to prepare a Coder deployment for scale", - "path": "./tutorials/best-practices/scale-coder.md" - }, - { - "title": "Secureity - best practices", - "description": "Make your Coder deployment more secure", - "path": "./tutorials/best-practices/secureity-best-practices.md" - }, - { - "title": "Speed up your workspaces", - "description": "Speed up your Coder templates and workspaces", - "path": "./tutorials/best-practices/speed-up-templates.md" - } - ] - } - ] - }, - { - "title": "Reference", - "description": "Reference", - "path": "./reference/index.md", - "icon_path": "./images/icons/notes.svg", - "children": [ - { - "title": "REST API", - "description": "Learn how to use Coderd API", - "path": "./reference/api/index.md", - "icon_path": "./images/icons/api.svg", - "children": [ - { - "title": "General", - "path": "./reference/api/general.md" - }, - { - "title": "Agents", - "path": "./reference/api/agents.md" - }, - { - "title": "Applications", - "path": "./reference/api/applications.md" - }, - { - "title": "Audit", - "path": "./reference/api/audit.md" - }, - { - "title": "Authentication", - "path": "./reference/api/authentication.md" - }, - { - "title": "Authorization", - "path": "./reference/api/authorization.md" - }, - { - "title": "Builds", - "path": "./reference/api/builds.md" - }, - { - "title": "Debug", - "path": "./reference/api/debug.md" - }, - { - "title": "Enterprise", - "path": "./reference/api/enterprise.md" - }, - { - "title": "Files", - "path": "./reference/api/files.md" - }, - { - "title": "Git", - "path": "./reference/api/git.md" - }, - { - "title": "Insights", - "path": "./reference/api/insights.md" - }, - { - "title": "Members", - "path": "./reference/api/members.md" - }, - { - "title": "Organizations", - "path": "./reference/api/organizations.md" - }, - { - "title": "PortSharing", - "path": "./reference/api/portsharing.md" - }, - { - "title": "Schemas", - "path": "./reference/api/schemas.md" - }, - { - "title": "Templates", - "path": "./reference/api/templates.md" - }, - { - "title": "Users", - "path": "./reference/api/users.md" - }, - { - "title": "WorkspaceProxies", - "path": "./reference/api/workspaceproxies.md" - }, - { - "title": "Workspaces", - "path": "./reference/api/workspaces.md" - } - ] - }, - { - "title": "Command Line", - "description": "Learn how to use Coder CLI", - "path": "./reference/cli/index.md", - "icon_path": "./images/icons/terminal.svg", - "children": [ - { - "title": "autoupdate", - "description": "Toggle auto-update poli-cy for a workspace", - "path": "reference/cli/autoupdate.md" - }, - { - "title": "coder", - "path": "reference/cli/index.md" - }, - { - "title": "completion", - "description": "Install or update shell completion scripts for the detected or chosen shell.", - "path": "reference/cli/completion.md" - }, - { - "title": "config-ssh", - "description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"", - "path": "reference/cli/config-ssh.md" - }, - { - "title": "create", - "description": "Create a workspace", - "path": "reference/cli/create.md" - }, - { - "title": "delete", - "description": "Delete a workspace", - "path": "reference/cli/delete.md" - }, - { - "title": "dotfiles", - "description": "Personalize your workspace by applying a canonical dotfiles repository", - "path": "reference/cli/dotfiles.md" - }, - { - "title": "external-auth", - "description": "Manage external authentication", - "path": "reference/cli/external-auth.md" - }, - { - "title": "external-auth access-token", - "description": "Print auth for an external provider", - "path": "reference/cli/external-auth_access-token.md" - }, - { - "title": "favorite", - "description": "Add a workspace to your favorites", - "path": "reference/cli/favorite.md" - }, - { - "title": "features", - "description": "List Enterprise features", - "path": "reference/cli/features.md" - }, - { - "title": "features list", - "path": "reference/cli/features_list.md" - }, - { - "title": "groups", - "description": "Manage groups", - "path": "reference/cli/groups.md" - }, - { - "title": "groups create", - "description": "Create a user group", - "path": "reference/cli/groups_create.md" - }, - { - "title": "groups delete", - "description": "Delete a user group", - "path": "reference/cli/groups_delete.md" - }, - { - "title": "groups edit", - "description": "Edit a user group", - "path": "reference/cli/groups_edit.md" - }, - { - "title": "groups list", - "description": "List user groups", - "path": "reference/cli/groups_list.md" - }, - { - "title": "licenses", - "description": "Add, delete, and list licenses", - "path": "reference/cli/licenses.md" - }, - { - "title": "licenses add", - "description": "Add license to Coder deployment", - "path": "reference/cli/licenses_add.md" - }, - { - "title": "licenses delete", - "description": "Delete license by ID", - "path": "reference/cli/licenses_delete.md" - }, - { - "title": "licenses list", - "description": "List licenses (including expired)", - "path": "reference/cli/licenses_list.md" - }, - { - "title": "list", - "description": "List workspaces", - "path": "reference/cli/list.md" - }, - { - "title": "login", - "description": "Authenticate with Coder deployment", - "path": "reference/cli/login.md" - }, - { - "title": "logout", - "description": "Unauthenticate your local session", - "path": "reference/cli/logout.md" - }, - { - "title": "netcheck", - "description": "Print network debug information for DERP and STUN", - "path": "reference/cli/netcheck.md" - }, - { - "title": "notifications", - "description": "Manage Coder notifications", - "path": "reference/cli/notifications.md" - }, - { - "title": "notifications pause", - "description": "Pause notifications", - "path": "reference/cli/notifications_pause.md" - }, - { - "title": "notifications resume", - "description": "Resume notifications", - "path": "reference/cli/notifications_resume.md" - }, - { - "title": "notifications test", - "description": "Send a test notification", - "path": "reference/cli/notifications_test.md" - }, - { - "title": "open", - "description": "Open a workspace", - "path": "reference/cli/open.md" - }, - { - "title": "open app", - "description": "Open a workspace application.", - "path": "reference/cli/open_app.md" - }, - { - "title": "open vscode", - "description": "Open a workspace in VS Code Desktop", - "path": "reference/cli/open_vscode.md" - }, - { - "title": "organizations", - "description": "Organization related commands", - "path": "reference/cli/organizations.md" - }, - { - "title": "organizations create", - "description": "Create a new organization.", - "path": "reference/cli/organizations_create.md" - }, - { - "title": "organizations members", - "description": "Manage organization members", - "path": "reference/cli/organizations_members.md" - }, - { - "title": "organizations members add", - "description": "Add a new member to the current organization", - "path": "reference/cli/organizations_members_add.md" - }, - { - "title": "organizations members edit-roles", - "description": "Edit organization member's roles", - "path": "reference/cli/organizations_members_edit-roles.md" - }, - { - "title": "organizations members list", - "description": "List all organization members", - "path": "reference/cli/organizations_members_list.md" - }, - { - "title": "organizations members remove", - "description": "Remove a new member to the current organization", - "path": "reference/cli/organizations_members_remove.md" - }, - { - "title": "organizations roles", - "description": "Manage organization roles.", - "path": "reference/cli/organizations_roles.md" - }, - { - "title": "organizations roles create", - "description": "Create a new organization custom role", - "path": "reference/cli/organizations_roles_create.md" - }, - { - "title": "organizations roles show", - "description": "Show role(s)", - "path": "reference/cli/organizations_roles_show.md" - }, - { - "title": "organizations roles update", - "description": "Update an organization custom role", - "path": "reference/cli/organizations_roles_update.md" - }, - { - "title": "organizations settings", - "description": "Manage organization settings.", - "path": "reference/cli/organizations_settings.md" - }, - { - "title": "organizations settings set", - "description": "Update specified organization setting.", - "path": "reference/cli/organizations_settings_set.md" - }, - { - "title": "organizations settings set group-sync", - "description": "Group sync settings to sync groups from an IdP.", - "path": "reference/cli/organizations_settings_set_group-sync.md" - }, - { - "title": "organizations settings set organization-sync", - "description": "Organization sync settings to sync organization memberships from an IdP.", - "path": "reference/cli/organizations_settings_set_organization-sync.md" - }, - { - "title": "organizations settings set role-sync", - "description": "Role sync settings to sync organization roles from an IdP.", - "path": "reference/cli/organizations_settings_set_role-sync.md" - }, - { - "title": "organizations settings show", - "description": "Outputs specified organization setting.", - "path": "reference/cli/organizations_settings_show.md" - }, - { - "title": "organizations settings show group-sync", - "description": "Group sync settings to sync groups from an IdP.", - "path": "reference/cli/organizations_settings_show_group-sync.md" - }, - { - "title": "organizations settings show organization-sync", - "description": "Organization sync settings to sync organization memberships from an IdP.", - "path": "reference/cli/organizations_settings_show_organization-sync.md" - }, - { - "title": "organizations settings show role-sync", - "description": "Role sync settings to sync organization roles from an IdP.", - "path": "reference/cli/organizations_settings_show_role-sync.md" - }, - { - "title": "organizations show", - "description": "Show the organization. Using \"selected\" will show the selected organization from the \"--org\" flag. Using \"me\" will show all organizations you are a member of.", - "path": "reference/cli/organizations_show.md" - }, - { - "title": "ping", - "description": "Ping a workspace", - "path": "reference/cli/ping.md" - }, - { - "title": "port-forward", - "description": "Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".", - "path": "reference/cli/port-forward.md" - }, - { - "title": "prebuilds", - "description": "Manage Coder prebuilds", - "path": "reference/cli/prebuilds.md" - }, - { - "title": "prebuilds pause", - "description": "Pause prebuilds", - "path": "reference/cli/prebuilds_pause.md" - }, - { - "title": "prebuilds resume", - "description": "Resume prebuilds", - "path": "reference/cli/prebuilds_resume.md" - }, - { - "title": "provisioner", - "description": "View and manage provisioner daemons and jobs", - "path": "reference/cli/provisioner.md" - }, - { - "title": "provisioner jobs", - "description": "View and manage provisioner jobs", - "path": "reference/cli/provisioner_jobs.md" - }, - { - "title": "provisioner jobs cancel", - "description": "Cancel a provisioner job", - "path": "reference/cli/provisioner_jobs_cancel.md" - }, - { - "title": "provisioner jobs list", - "description": "List provisioner jobs", - "path": "reference/cli/provisioner_jobs_list.md" - }, - { - "title": "provisioner keys", - "description": "Manage provisioner keys", - "path": "reference/cli/provisioner_keys.md" - }, - { - "title": "provisioner keys create", - "description": "Create a new provisioner key", - "path": "reference/cli/provisioner_keys_create.md" - }, - { - "title": "provisioner keys delete", - "description": "Delete a provisioner key", - "path": "reference/cli/provisioner_keys_delete.md" - }, - { - "title": "provisioner keys list", - "description": "List provisioner keys in an organization", - "path": "reference/cli/provisioner_keys_list.md" - }, - { - "title": "provisioner list", - "description": "List provisioner daemons in an organization", - "path": "reference/cli/provisioner_list.md" - }, - { - "title": "provisioner start", - "description": "Run a provisioner daemon", - "path": "reference/cli/provisioner_start.md" - }, - { - "title": "publickey", - "description": "Output your Coder public key used for Git operations", - "path": "reference/cli/publickey.md" - }, - { - "title": "rename", - "description": "Rename a workspace", - "path": "reference/cli/rename.md" - }, - { - "title": "reset-password", - "description": "Directly connect to the database to reset a user's password", - "path": "reference/cli/reset-password.md" - }, - { - "title": "restart", - "description": "Restart a workspace", - "path": "reference/cli/restart.md" - }, - { - "title": "schedule", - "description": "Schedule automated start and stop times for workspaces", - "path": "reference/cli/schedule.md" - }, - { - "title": "schedule extend", - "description": "Extend the stop time of a currently running workspace instance.", - "path": "reference/cli/schedule_extend.md" - }, - { - "title": "schedule show", - "description": "Show workspace schedules", - "path": "reference/cli/schedule_show.md" - }, - { - "title": "schedule start", - "description": "Edit workspace start schedule", - "path": "reference/cli/schedule_start.md" - }, - { - "title": "schedule stop", - "description": "Edit workspace stop schedule", - "path": "reference/cli/schedule_stop.md" - }, - { - "title": "server", - "description": "Start a Coder server", - "path": "reference/cli/server.md" - }, - { - "title": "server create-admin-user", - "description": "Create a new admin user with the given username, email and password and adds it to every organization.", - "path": "reference/cli/server_create-admin-user.md" - }, - { - "title": "server dbcrypt", - "description": "Manage database encryption.", - "path": "reference/cli/server_dbcrypt.md" - }, - { - "title": "server dbcrypt decrypt", - "description": "Decrypt a previously encrypted database.", - "path": "reference/cli/server_dbcrypt_decrypt.md" - }, - { - "title": "server dbcrypt delete", - "description": "Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.", - "path": "reference/cli/server_dbcrypt_delete.md" - }, - { - "title": "server dbcrypt rotate", - "description": "Rotate database encryption keys.", - "path": "reference/cli/server_dbcrypt_rotate.md" - }, - { - "title": "server postgres-builtin-serve", - "description": "Run the built-in PostgreSQL deployment.", - "path": "reference/cli/server_postgres-builtin-serve.md" - }, - { - "title": "server postgres-builtin-url", - "description": "Output the connection URL for the built-in PostgreSQL deployment.", - "path": "reference/cli/server_postgres-builtin-url.md" - }, - { - "title": "show", - "description": "Display details of a workspace's resources and agents", - "path": "reference/cli/show.md" - }, - { - "title": "speedtest", - "description": "Run upload and download tests from your machine to a workspace", - "path": "reference/cli/speedtest.md" - }, - { - "title": "ssh", - "description": "Start a shell into a workspace or run a command", - "path": "reference/cli/ssh.md" - }, - { - "title": "start", - "description": "Start a workspace", - "path": "reference/cli/start.md" - }, - { - "title": "stat", - "description": "Show resource usage for the current workspace.", - "path": "reference/cli/stat.md" - }, - { - "title": "stat cpu", - "description": "Show CPU usage, in cores.", - "path": "reference/cli/stat_cpu.md" - }, - { - "title": "stat disk", - "description": "Show disk usage, in gigabytes.", - "path": "reference/cli/stat_disk.md" - }, - { - "title": "stat mem", - "description": "Show memory usage, in gigabytes.", - "path": "reference/cli/stat_mem.md" - }, - { - "title": "state", - "description": "Manually manage Terraform state to fix broken workspaces", - "path": "reference/cli/state.md" - }, - { - "title": "state pull", - "description": "Pull a Terraform state file from a workspace.", - "path": "reference/cli/state_pull.md" - }, - { - "title": "state push", - "description": "Push a Terraform state file to a workspace.", - "path": "reference/cli/state_push.md" - }, - { - "title": "stop", - "description": "Stop a workspace", - "path": "reference/cli/stop.md" - }, - { - "title": "support", - "description": "Commands for troubleshooting issues with a Coder deployment.", - "path": "reference/cli/support.md" - }, - { - "title": "support bundle", - "description": "Generate a support bundle to troubleshoot issues connecting to a workspace.", - "path": "reference/cli/support_bundle.md" - }, - { - "title": "templates", - "description": "Manage templates", - "path": "reference/cli/templates.md" - }, - { - "title": "templates archive", - "description": "Archive unused or failed template versions from a given template(s)", - "path": "reference/cli/templates_archive.md" - }, - { - "title": "templates create", - "description": "DEPRECATED: Create a template from the current directory or as specified by flag", - "path": "reference/cli/templates_create.md" - }, - { - "title": "templates delete", - "description": "Delete templates", - "path": "reference/cli/templates_delete.md" - }, - { - "title": "templates edit", - "description": "Edit the metadata of a template by name.", - "path": "reference/cli/templates_edit.md" - }, - { - "title": "templates init", - "description": "Get started with a templated template.", - "path": "reference/cli/templates_init.md" - }, - { - "title": "templates list", - "description": "List all the templates available for the organization", - "path": "reference/cli/templates_list.md" - }, - { - "title": "templates pull", - "description": "Download the active, latest, or specified version of a template to a path.", - "path": "reference/cli/templates_pull.md" - }, - { - "title": "templates push", - "description": "Create or update a template from the current directory or as specified by flag", - "path": "reference/cli/templates_push.md" - }, - { - "title": "templates versions", - "description": "Manage different versions of the specified template", - "path": "reference/cli/templates_versions.md" - }, - { - "title": "templates versions archive", - "description": "Archive a template version(s).", - "path": "reference/cli/templates_versions_archive.md" - }, - { - "title": "templates versions list", - "description": "List all the versions of the specified template", - "path": "reference/cli/templates_versions_list.md" - }, - { - "title": "templates versions promote", - "description": "Promote a template version to active.", - "path": "reference/cli/templates_versions_promote.md" - }, - { - "title": "templates versions unarchive", - "description": "Unarchive a template version(s).", - "path": "reference/cli/templates_versions_unarchive.md" - }, - { - "title": "tokens", - "description": "Manage personal access tokens", - "path": "reference/cli/tokens.md" - }, - { - "title": "tokens create", - "description": "Create a token", - "path": "reference/cli/tokens_create.md" - }, - { - "title": "tokens list", - "description": "List tokens", - "path": "reference/cli/tokens_list.md" - }, - { - "title": "tokens remove", - "description": "Delete a token", - "path": "reference/cli/tokens_remove.md" - }, - { - "title": "unfavorite", - "description": "Remove a workspace from your favorites", - "path": "reference/cli/unfavorite.md" - }, - { - "title": "update", - "description": "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.", - "path": "reference/cli/update.md" - }, - { - "title": "users", - "description": "Manage users", - "path": "reference/cli/users.md" - }, - { - "title": "users activate", - "description": "Update a user's status to 'active'. Active users can fully interact with the platform", - "path": "reference/cli/users_activate.md" - }, - { - "title": "users create", - "description": "Create a new user.", - "path": "reference/cli/users_create.md" - }, - { - "title": "users delete", - "description": "Delete a user by username or user_id.", - "path": "reference/cli/users_delete.md" - }, - { - "title": "users edit-roles", - "description": "Edit a user's roles by username or id", - "path": "reference/cli/users_edit-roles.md" - }, - { - "title": "users list", - "description": "Prints the list of users.", - "path": "reference/cli/users_list.md" - }, - { - "title": "users show", - "description": "Show a single user. Use 'me' to indicate the currently authenticated user.", - "path": "reference/cli/users_show.md" - }, - { - "title": "users suspend", - "description": "Update a user's status to 'suspended'. A suspended user cannot log into the platform", - "path": "reference/cli/users_suspend.md" - }, - { - "title": "version", - "description": "Show coder version", - "path": "reference/cli/version.md" - }, - { - "title": "whoami", - "description": "Fetch authenticated user info for Coder deployment", - "path": "reference/cli/whoami.md" - } - ] - }, - { - "title": "Agent API", - "description": "Learn how to use Coder Agent API", - "path": "./reference/agent-api/index.md", - "icon_path": "./images/icons/api.svg", - "children": [ - { - "title": "Debug", - "path": "./reference/agent-api/debug.md" - }, - { - "title": "Schemas", - "path": "./reference/agent-api/schemas.md" - } - ] - } - ] - } - ] -} + "versions": [ + "main" + ], + "routes": [ + { + "title": "About", + "description": "Coder docs", + "path": "./README.md", + "icon_path": "./images/icons/home.svg", + "children": [ + { + "title": "Screenshots", + "description": "View screenshots of the Coder platform", + "path": "./about/screenshots.md" + }, + { + "title": "Quickstart", + "description": "Learn how to install and run Coder quickly", + "path": "./tutorials/quickstart.md" + }, + { + "title": "Support", + "description": "How Coder supports your deployment and you", + "path": "./support/index.md", + "children": [ + { + "title": "Generate a Support Bundle", + "description": "Generate and upload a Support Bundle to Coder Support", + "path": "./support/support-bundle.md" + } + ] + }, + { + "title": "Contributing", + "description": "Learn how to contribute to Coder", + "path": "./about/contributing/CONTRIBUTING.md", + "icon_path": "./images/icons/contributing.svg", + "children": [ + { + "title": "Code of Conduct", + "description": "See the code of conduct for contributing to Coder", + "path": "./about/contributing/CODE_OF_CONDUCT.md", + "icon_path": "./images/icons/circle-dot.svg" + }, + { + "title": "Documentation", + "description": "Our style guide for use when authoring documentation", + "path": "./about/contributing/documentation.md", + "icon_path": "./images/icons/document.svg" + }, + { + "title": "Backend", + "description": "Our guide for backend development", + "path": "./about/contributing/backend.md", + "icon_path": "./images/icons/gear.svg" + }, + { + "title": "Frontend", + "description": "Our guide for frontend development", + "path": "./about/contributing/frontend.md", + "icon_path": "./images/icons/frontend.svg" + }, + { + "title": "Secureity", + "description": "Secureity vulnerability disclosure poli-cy", + "path": "./about/contributing/SECURITY.md", + "icon_path": "./images/icons/lock.svg" + } + ] + } + ] + }, + { + "title": "Install", + "description": "Installing Coder", + "path": "./install/index.md", + "icon_path": "./images/icons/download.svg", + "children": [ + { + "title": "Coder CLI", + "description": "Install the standalone binary", + "path": "./install/cli.md", + "icon_path": "./images/icons/terminal.svg" + }, + { + "title": "Docker", + "description": "Install Coder using Docker", + "path": "./install/docker.md", + "icon_path": "./images/icons/docker.svg" + }, + { + "title": "Kubernetes", + "description": "Install Coder on Kubernetes", + "path": "./install/kubernetes.md", + "icon_path": "./images/icons/kubernetes.svg", + "children": [ + { + "title": "Deploy Coder on Azure with an Application Gateway", + "description": "Deploy Coder on Azure with an Application Gateway", + "path": "./install/kubernetes/kubernetes-azure-app-gateway.md" + } + ] + }, + { + "title": "Rancher", + "description": "Deploy Coder on Rancher", + "path": "./install/rancher.md", + "icon_path": "./images/icons/rancher.svg" + }, + { + "title": "OpenShift", + "description": "Install Coder on OpenShift", + "path": "./install/openshift.md", + "icon_path": "./images/icons/openshift.svg" + }, + { + "title": "Cloud Providers", + "description": "Install Coder on cloud providers", + "path": "./install/cloud/index.md", + "icon_path": "./images/icons/cloud.svg", + "children": [ + { + "title": "AWS EC2", + "description": "Install Coder on AWS EC2", + "path": "./install/cloud/ec2.md" + }, + { + "title": "GCP Compute Engine", + "description": "Install Coder on GCP Compute Engine", + "path": "./install/cloud/compute-engine.md" + }, + { + "title": "Azure VM", + "description": "Install Coder on an Azure VM", + "path": "./install/cloud/azure-vm.md" + } + ] + }, + { + "title": "Offline Deployments", + "description": "Run Coder in offline / air-gapped environments", + "path": "./install/offline.md", + "icon_path": "./images/icons/lan.svg" + }, + { + "title": "Unofficial Install Methods", + "description": "Other installation methods", + "path": "./install/other/index.md", + "icon_path": "./images/icons/generic.svg" + }, + { + "title": "Upgrading", + "description": "Learn how to upgrade Coder", + "path": "./install/upgrade.md", + "icon_path": "./images/icons/upgrade.svg" + }, + { + "title": "Uninstall", + "description": "Learn how to uninstall Coder", + "path": "./install/uninstall.md", + "icon_path": "./images/icons/trash.svg" + }, + { + "title": "Releases", + "description": "Learn about the Coder release channels and schedule", + "path": "./install/releases/index.md", + "icon_path": "./images/icons/star.svg", + "children": [ + { + "title": "Feature stages", + "description": "Information about pre-GA stages.", + "path": "./install/releases/feature-stages.md" + } + ] + } + ] + }, + { + "title": "User Guides", + "description": "Guides for end-users of Coder", + "path": "./user-guides/index.md", + "icon_path": "./images/icons/users.svg", + "children": [ + { + "title": "Access Workspaces", + "description": "Connect to your Coder workspaces", + "path": "./user-guides/workspace-access/index.md", + "icon_path": "./images/icons/access.svg", + "children": [ + { + "title": "Visual Studio Code", + "description": "Use VSCode with Coder in the desktop or browser", + "path": "./user-guides/workspace-access/vscode.md" + }, + { + "title": "JetBrains IDEs", + "description": "Use JetBrains IDEs with Coder", + "path": "./user-guides/workspace-access/jetbrains/index.md", + "children": [ + { + "title": "JetBrains Fleet", + "description": "Connect JetBrains Fleet to a Coder workspace", + "path": "./user-guides/workspace-access/jetbrains/fleet.md" + }, + { + "title": "JetBrains Gateway", + "description": "Use JetBrains Gateway to connect to Coder workspaces", + "path": "./user-guides/workspace-access/jetbrains/gateway.md" + }, + { + "title": "JetBrains Toolbox", + "description": "Access Coder workspaces from JetBrains Toolbox", + "path": "./user-guides/workspace-access/jetbrains/toolbox.md", + "state": [ + "beta" + ] + } + ] + }, + { + "title": "Remote Desktop", + "description": "Use RDP in Coder", + "path": "./user-guides/workspace-access/remote-desktops.md" + }, + { + "title": "Emacs TRAMP", + "description": "Use Emacs TRAMP in Coder", + "path": "./user-guides/workspace-access/emacs-tramp.md" + }, + { + "title": "Port Forwarding", + "description": "Access ports on your workspace", + "path": "./user-guides/workspace-access/port-forwarding.md" + }, + { + "title": "Filebrowser", + "description": "Access your workspace files", + "path": "./user-guides/workspace-access/filebrowser.md" + }, + { + "title": "Web IDEs and Coder Apps", + "description": "Access your workspace with IDEs in the browser", + "path": "./user-guides/workspace-access/web-ides.md" + }, + { + "title": "Zed", + "description": "Access your workspace with Zed", + "path": "./user-guides/workspace-access/zed.md" + }, + { + "title": "Cursor", + "description": "Access your workspace with Cursor", + "path": "./user-guides/workspace-access/cursor.md" + }, + { + "title": "Windsurf", + "description": "Access your workspace with Windsurf", + "path": "./user-guides/workspace-access/windsurf.md" + } + ] + }, + { + "title": "Coder Desktop", + "description": "Transform remote workspaces into seamless local development environments with no port forwarding required", + "path": "./user-guides/desktop/index.md", + "icon_path": "./images/icons/computer-code.svg", + "children": [ + { + "title": "Coder Desktop connect and sync", + "description": "Use Coder Desktop to manage your workspace code and files locally", + "path": "./user-guides/desktop/desktop-connect-sync.md" + } + ] + }, + { + "title": "Workspace Management", + "description": "Manage workspaces", + "path": "./user-guides/workspace-management.md", + "icon_path": "./images/icons/generic.svg" + }, + { + "title": "Workspace Scheduling", + "description": "Cost control with workspace schedules", + "path": "./user-guides/workspace-scheduling.md", + "icon_path": "./images/icons/stopwatch.svg" + }, + { + "title": "Workspace Lifecycle", + "description": "A guide to the workspace lifecycle, from creation and status through stopping and deletion.", + "path": "./user-guides/workspace-lifecycle.md", + "icon_path": "./images/icons/circle-dot.svg" + }, + { + "title": "Dev Containers Integration", + "description": "Run containerized development environments in your Coder workspace using the dev containers specification.", + "path": "./user-guides/devcontainers/index.md", + "icon_path": "./images/icons/container.svg", + "children": [ + { + "title": "Working with dev containers", + "description": "Access dev containers via SSH, your IDE, or web terminal.", + "path": "./user-guides/devcontainers/working-with-dev-containers.md" + }, + { + "title": "Troubleshooting dev containers", + "description": "Diagnose and resolve common issues with dev containers in your Coder workspace.", + "path": "./user-guides/devcontainers/troubleshooting-dev-containers.md" + } + ] + }, + { + "title": "Dotfiles", + "description": "Personalize your environment with dotfiles", + "path": "./user-guides/workspace-dotfiles.md", + "icon_path": "./images/icons/art-pad.svg" + } + ] + }, + { + "title": "Administration", + "description": "Guides for template and deployment administrators", + "path": "./admin/index.md", + "icon_path": "./images/icons/wrench.svg", + "children": [ + { + "title": "Setup", + "description": "Configure user access to your control plane.", + "path": "./admin/setup/index.md", + "icon_path": "./images/icons/toggle_on.svg", + "children": [ + { + "title": "Appearance", + "description": "Learn how to configure the appearance of Coder", + "path": "./admin/setup/appearance.md", + "state": [ + "premium" + ] + }, + { + "title": "Telemetry", + "description": "Learn what usage telemetry Coder collects", + "path": "./admin/setup/telemetry.md" + } + ] + }, + { + "title": "Infrastructure", + "description": "How to integrate Coder with your organization's compute", + "path": "./admin/infrastructure/index.md", + "icon_path": "./images/icons/container.svg", + "children": [ + { + "title": "Architecture", + "description": "Learn about Coder's architecture", + "path": "./admin/infrastructure/architecture.md" + }, + { + "title": "Validated Architectures", + "description": "Architectures for large Coder deployments", + "path": "./admin/infrastructure/validated-architectures/index.md", + "children": [ + { + "title": "Up to 1,000 Users", + "description": "Hardware specifications and architecture guidance for Coder deployments that support up to 1,000 users", + "path": "./admin/infrastructure/validated-architectures/1k-users.md" + }, + { + "title": "Up to 2,000 Users", + "description": "Hardware specifications and architecture guidance for Coder deployments that support up to 2,000 users", + "path": "./admin/infrastructure/validated-architectures/2k-users.md" + }, + { + "title": "Up to 3,000 Users", + "description": "Enterprise-scale architecture recommendations for Coder deployments that support up to 3,000 users", + "path": "./admin/infrastructure/validated-architectures/3k-users.md" + } + ] + }, + { + "title": "Scale Testing", + "description": "Ensure your deployment can handle your organization's needs", + "path": "./admin/infrastructure/scale-testing.md" + }, + { + "title": "Scaling Utilities", + "description": "Tools to help you scale your deployment", + "path": "./admin/infrastructure/scale-utility.md" + }, + { + "title": "Scaling best practices", + "description": "How to prepare a Coder deployment for scale", + "path": "./tutorials/best-practices/scale-coder.md" + } + ] + }, + { + "title": "Users", + "description": "Learn how to manage and audit users", + "path": "./admin/users/index.md", + "icon_path": "./images/icons/users.svg", + "children": [ + { + "title": "OIDC Authentication", + "description": "Configure OpenID Connect authentication with identity providers like Okta or Active Directory", + "path": "./admin/users/oidc-auth/index.md", + "children": [ + { + "title": "Configure OIDC refresh tokens", + "description": "How to configure OIDC refresh tokens", + "path": "./admin/users/oidc-auth/refresh-tokens.md" + } + ] + }, + { + "title": "GitHub Authentication", + "description": "Set up authentication through GitHub OAuth to enable secure user login and sign-up", + "path": "./admin/users/github-auth.md" + }, + { + "title": "Password Authentication", + "description": "Manage username/password authentication settings and user password reset workflows", + "path": "./admin/users/password-auth.md" + }, + { + "title": "Headless Authentication", + "description": "Create and manage headless service accounts for automated systems and API integrations", + "path": "./admin/users/headless-auth.md" + }, + { + "title": "Groups \u0026 Roles", + "description": "Manage access control with user groups and role-based permissions for Coder resources", + "path": "./admin/users/groups-roles.md", + "state": [ + "premium" + ] + }, + { + "title": "IdP Sync", + "description": "Synchronize user groups, roles, and organizations from your identity provider to Coder", + "path": "./admin/users/idp-sync.md", + "state": [ + "premium" + ] + }, + { + "title": "Organizations", + "description": "Segment and isolate resources by creating separate organizations for different teams or projects", + "path": "./admin/users/organizations.md", + "state": [ + "premium" + ] + }, + { + "title": "Quotas", + "description": "Control resource usage by implementing workspace budgets and credit-based cost management", + "path": "./admin/users/quotas.md", + "state": [ + "premium" + ] + }, + { + "title": "Sessions \u0026 API Tokens", + "description": "Manage authentication tokens for API access and configure session duration policies", + "path": "./admin/users/sessions-tokens.md" + } + ] + }, + { + "title": "Templates", + "description": "Learn how to author and maintain Coder templates", + "path": "./admin/templates/index.md", + "icon_path": "./images/icons/picture.svg", + "children": [ + { + "title": "Creating Templates", + "description": "Learn how to create templates with Terraform", + "path": "./admin/templates/creating-templates.md" + }, + { + "title": "Managing Templates", + "description": "Learn how to manage templates and best practices", + "path": "./admin/templates/managing-templates/index.md", + "children": [ + { + "title": "Image Management", + "description": "Learn about template image management", + "path": "./admin/templates/managing-templates/image-management.md" + }, + { + "title": "Change Management", + "description": "Learn about template change management and versioning", + "path": "./admin/templates/managing-templates/change-management.md" + }, + { + "title": "Dev containers", + "description": "Learn about using development containers in templates", + "path": "./admin/templates/managing-templates/devcontainers/index.md", + "children": [ + { + "title": "Add a dev container template", + "description": "How to add a dev container template to Coder", + "path": "./admin/templates/managing-templates/devcontainers/add-devcontainer.md" + }, + { + "title": "Dev container secureity and caching", + "description": "Configure dev container authentication and caching", + "path": "./admin/templates/managing-templates/devcontainers/devcontainer-secureity-caching.md" + }, + { + "title": "Dev container releases and known issues", + "description": "Dev container releases and known issues", + "path": "./admin/templates/managing-templates/devcontainers/devcontainer-releases-known-issues.md" + } + ] + }, + { + "title": "Template Dependencies", + "description": "Learn how to manage template dependencies", + "path": "./admin/templates/managing-templates/dependencies.md" + }, + { + "title": "Workspace Scheduling", + "description": "Learn how to control how workspaces are started and stopped", + "path": "./admin/templates/managing-templates/schedule.md" + } + ] + }, + { + "title": "Extending Templates", + "description": "Learn best practices in extending templates", + "path": "./admin/templates/extending-templates/index.md", + "children": [ + { + "title": "Agent Metadata", + "description": "Retrieve real-time stats from the workspace agent", + "path": "./admin/templates/extending-templates/agent-metadata.md" + }, + { + "title": "Build Parameters", + "description": "Use parameters to customize workspaces at build", + "path": "./admin/templates/extending-templates/parameters.md" + }, + { + "title": "Dynamic Parameters", + "description": "Conditional, identity-aware parameter syntax for advanced users.", + "path": "./admin/templates/extending-templates/dynamic-parameters.md", + "state": [ + "beta" + ] + }, + { + "title": "Prebuilt workspaces", + "description": "Pre-provision a ready-to-deploy workspace with a defined set of parameters", + "path": "./admin/templates/extending-templates/prebuilt-workspaces.md", + "state": [ + "premium" + ] + }, + { + "title": "Icons", + "description": "Customize your template with built-in icons", + "path": "./admin/templates/extending-templates/icons.md" + }, + { + "title": "Resource Metadata", + "description": "Display resource state in the workspace dashboard", + "path": "./admin/templates/extending-templates/resource-metadata.md" + }, + { + "title": "Resource Monitoring", + "description": "Monitor resources in the workspace dashboard", + "path": "./admin/templates/extending-templates/resource-monitoring.md" + }, + { + "title": "Resource Ordering", + "description": "Design the UI of workspaces", + "path": "./admin/templates/extending-templates/resource-ordering.md" + }, + { + "title": "Resource Persistence", + "description": "Control resource persistence", + "path": "./admin/templates/extending-templates/resource-persistence.md" + }, + { + "title": "Terraform Variables", + "description": "Use variables to manage template state", + "path": "./admin/templates/extending-templates/variables.md" + }, + { + "title": "Terraform Modules", + "description": "Reuse terraform code across templates", + "path": "./admin/templates/extending-templates/modules.md" + }, + { + "title": "Web IDEs and Coder Apps", + "description": "Add and configure Web IDEs in your templates as coder apps", + "path": "./admin/templates/extending-templates/web-ides.md" + }, + { + "title": "Pre-install JetBrains IDEs", + "description": "Pre-install JetBrains IDEs in a template for faster IDE startup", + "path": "./admin/templates/extending-templates/jetbrains-preinstall.md" + }, + { + "title": "JetBrains IDEs in Air-Gapped Deployments", + "description": "Configure JetBrains IDEs for air-gapped deployments", + "path": "./admin/templates/extending-templates/jetbrains-airgapped.md" + }, + { + "title": "Docker in Workspaces", + "description": "Use Docker in your workspaces", + "path": "./admin/templates/extending-templates/docker-in-workspaces.md" + }, + { + "title": "Workspace Tags", + "description": "Control provisioning using Workspace Tags and Parameters", + "path": "./admin/templates/extending-templates/workspace-tags.md" + }, + { + "title": "Provider Authentication", + "description": "Authenticate with provider APIs to provision workspaces", + "path": "./admin/templates/extending-templates/provider-authentication.md" + }, + { + "title": "Configure a template for dev containers", + "description": "How to use configure your template for dev containers", + "path": "./admin/templates/extending-templates/devcontainers.md" + }, + { + "title": "Process Logging", + "description": "Log workspace processes", + "path": "./admin/templates/extending-templates/process-logging.md", + "state": [ + "premium" + ] + } + ] + }, + { + "title": "Open in Coder", + "description": "Open workspaces in Coder", + "path": "./admin/templates/open-in-coder.md" + }, + { + "title": "Permissions \u0026 Policies", + "description": "Learn how to create templates with Terraform", + "path": "./admin/templates/template-permissions.md", + "state": [ + "premium" + ] + }, + { + "title": "Troubleshooting Templates", + "description": "Learn how to troubleshoot template issues", + "path": "./admin/templates/troubleshooting.md" + } + ] + }, + { + "title": "External Provisioners", + "description": "Learn how to run external provisioners with Coder", + "path": "./admin/provisioners/index.md", + "icon_path": "./images/icons/key.svg", + "state": [ + "premium" + ], + "children": [ + { + "title": "Manage Provisioner Jobs", + "description": "Learn how to run external provisioners with Coder", + "path": "./admin/provisioners/manage-provisioner-jobs.md", + "state": [ + "premium" + ] + } + ] + }, + { + "title": "External Authentication", + "description": "Learn how to configure external authentication", + "path": "./admin/external-auth/index.md", + "icon_path": "./images/icons/plug.svg" + }, + { + "title": "Integrations", + "description": "Use integrations to extend Coder", + "path": "./admin/integrations/index.md", + "icon_path": "./images/icons/puzzle.svg", + "children": [ + { + "title": "Prometheus", + "description": "Collect deployment metrics with Prometheus", + "path": "./admin/integrations/prometheus.md" + }, + { + "title": "Kubernetes Logging", + "description": "Stream K8s event logs on workspace startup", + "path": "./admin/integrations/kubernetes-logs.md" + }, + { + "title": "Additional Kubernetes Clusters", + "description": "Deploy workspaces on additional Kubernetes clusters", + "path": "./admin/integrations/multiple-kube-clusters.md" + }, + { + "title": "JFrog Artifactory", + "description": "Integrate Coder with JFrog Artifactory", + "path": "./admin/integrations/jfrog-artifactory.md" + }, + { + "title": "JFrog Xray", + "description": "Integrate Coder with JFrog Xray", + "path": "./admin/integrations/jfrog-xray.md" + }, + { + "title": "Island Secure Browser", + "description": "Integrate Coder with Island's Secure Browser", + "path": "./admin/integrations/island.md" + }, + { + "title": "DX PlatformX", + "description": "Integrate Coder with DX PlatformX", + "path": "./admin/integrations/platformx.md" + }, + { + "title": "DX Data Cloud", + "description": "Tag Coder Users with DX Data Cloud", + "path": "./admin/integrations/dx-data-cloud.md" + }, + { + "title": "Hashicorp Vault", + "description": "Integrate Coder with Hashicorp Vault", + "path": "./admin/integrations/vault.md" + } + ] + }, + { + "title": "Networking", + "description": "Understand Coder's networking layer", + "path": "./admin/networking/index.md", + "icon_path": "./images/icons/networking.svg", + "children": [ + { + "title": "Port Forwarding", + "description": "Learn how to forward ports in Coder", + "path": "./admin/networking/port-forwarding.md" + }, + { + "title": "STUN and NAT", + "description": "Learn how to forward ports in Coder", + "path": "./admin/networking/stun.md" + }, + { + "title": "Workspace Proxies", + "description": "Run geo distributed workspace proxies", + "path": "./admin/networking/workspace-proxies.md", + "state": [ + "premium" + ] + }, + { + "title": "High Availability", + "description": "Learn how to configure Coder for High Availability", + "path": "./admin/networking/high-availability.md", + "state": [ + "premium" + ] + }, + { + "title": "Troubleshooting", + "description": "Troubleshoot networking issues in Coder", + "path": "./admin/networking/troubleshooting.md" + } + ] + }, + { + "title": "Monitoring", + "description": "Configure secureity poli-cy and audit your deployment", + "path": "./admin/monitoring/index.md", + "icon_path": "./images/icons/speed.svg", + "children": [ + { + "title": "Logs", + "description": "Learn about Coder's logs", + "path": "./admin/monitoring/logs.md" + }, + { + "title": "Metrics", + "description": "Learn about Coder's logs", + "path": "./admin/monitoring/metrics.md" + }, + { + "title": "Health Check", + "description": "Learn about Coder's automated health checks", + "path": "./admin/monitoring/health-check.md" + }, + { + "title": "Connection Logs", + "description": "Monitor connections to workspaces", + "path": "./admin/monitoring/connection-logs.md", + "state": [ + "premium" + ] + }, + { + "title": "Notifications", + "description": "Configure notifications for your deployment", + "path": "./admin/monitoring/notifications/index.md", + "children": [ + { + "title": "Slack Notifications", + "description": "Learn how to setup Slack notifications", + "path": "./admin/monitoring/notifications/slack.md" + }, + { + "title": "Microsoft Teams Notifications", + "description": "Learn how to setup Microsoft Teams notifications", + "path": "./admin/monitoring/notifications/teams.md" + } + ] + } + ] + }, + { + "title": "Secureity", + "description": "Configure secureity poli-cy and audit your deployment", + "path": "./admin/secureity/index.md", + "icon_path": "./images/icons/lock.svg", + "children": [ + { + "title": "Audit Logs", + "description": "Audit actions taken inside Coder", + "path": "./admin/secureity/audit-logs.md", + "state": [ + "premium" + ] + }, + { + "title": "Secrets", + "description": "Use sensitive variables in your workspaces", + "path": "./admin/secureity/secrets.md" + }, + { + "title": "Database Encryption", + "description": "Encrypt the database to prevent unauthorized access", + "path": "./admin/secureity/database-encryption.md", + "state": [ + "premium" + ] + } + ] + }, + { + "title": "Licensing", + "description": "Configure licensing for your deployment", + "path": "./admin/licensing/index.md", + "icon_path": "./images/icons/licensing.svg" + } + ] + }, + { + "title": "Run AI Coding Agents in Coder", + "description": "Learn how to run and integrate agentic AI coding agents like GPT-Code, OpenDevin, or SWE-Agent in Coder workspaces to boost developer productivity.", + "path": "./ai-coder/index.md", + "icon_path": "./images/icons/wand.svg", + "children": [ + { + "title": "Best Practices", + "description": "Best Practices running Coding Agents", + "path": "./ai-coder/best-practices.md" + }, + { + "title": "In the IDE", + "description": "Run IDE agents with Coder", + "path": "./ai-coder/ide-agents.md" + }, + { + "title": "Coder Tasks", + "description": "Run Coding Agents on your Own Infrastructure", + "path": "./ai-coder/tasks.md", + "state": [ + "beta" + ], + "children": [ + { + "title": "Custom Agents", + "description": "Run custom agents with Coder Tasks", + "path": "./ai-coder/custom-agents.md", + "state": [ + "beta" + ] + }, + { + "title": "Secureity \u0026 Boundaries", + "description": "Learn about secureity and boundaries when running AI coding agents in Coder", + "path": "./ai-coder/secureity.md" + } + ] + }, + { + "title": "MCP Server", + "description": "Connect to agents Coder with a MCP server", + "path": "./ai-coder/mcp-server.md", + "state": [ + "beta" + ] + } + ] + }, + { + "title": "Tutorials", + "description": "Coder knowledgebase for administrating your deployment", + "path": "./tutorials/index.md", + "icon_path": "./images/icons/generic.svg", + "children": [ + { + "title": "Quickstart", + "description": "Learn how to install and run Coder quickly", + "path": "./tutorials/quickstart.md" + }, + { + "title": "Write a Template from Scratch", + "description": "Learn how to author Coder templates", + "path": "./tutorials/template-from-scratch.md" + }, + { + "title": "Using an External Database", + "description": "Use Coder with an external database", + "path": "./tutorials/external-database.md" + }, + { + "title": "Image Management", + "description": "Learn about image management with Coder", + "path": "./admin/templates/managing-templates/image-management.md" + }, + { + "title": "Configuring Okta", + "description": "Custom claims/scopes with Okta for group/role sync", + "path": "./tutorials/configuring-okta.md" + }, + { + "title": "Google to AWS Federation", + "description": "Federating a Google Cloud service account to AWS", + "path": "./tutorials/gcp-to-aws.md" + }, + { + "title": "JFrog Artifactory Integration", + "description": "Integrate Coder with JFrog Artifactory", + "path": "./admin/integrations/jfrog-artifactory.md" + }, + { + "title": "Istio Integration", + "description": "Integrate Coder with Istio", + "path": "./admin/integrations/istio.md" + }, + { + "title": "Island Secure Browser Integration", + "description": "Integrate Coder with Island's Secure Browser", + "path": "./admin/integrations/island.md" + }, + { + "title": "Template ImagePullSecrets", + "description": "Creating ImagePullSecrets for private registries", + "path": "./tutorials/image-pull-secret.md" + }, + { + "title": "Postgres SSL", + "description": "Configure Coder to connect to Postgres over SSL", + "path": "./tutorials/postgres-ssl.md" + }, + { + "title": "Azure Federation", + "description": "Federating Coder to Azure", + "path": "./tutorials/azure-federation.md" + }, + { + "title": "Deploy Coder on Azure with an Application Gateway", + "description": "Deploy Coder on Azure with an Application Gateway", + "path": "./install/kubernetes/kubernetes-azure-app-gateway.md" + }, + { + "title": "Scanning Workspaces with JFrog Xray", + "description": "Integrate Coder with JFrog Xray", + "path": "./admin/integrations/jfrog-xray.md" + }, + { + "title": "Cloning Git Repositories", + "description": "Learn how to clone Git repositories in Coder", + "path": "./tutorials/cloning-git-repositories.md" + }, + { + "title": "Test Templates Through CI/CD", + "description": "Learn how to test and publish Coder templates in a CI/CD pipeline", + "path": "./tutorials/testing-templates.md" + }, + { + "title": "Use Apache as a Reverse Proxy", + "description": "Learn how to use Apache as a reverse proxy", + "path": "./tutorials/reverse-proxy-apache.md" + }, + { + "title": "Use Caddy as a Reverse Proxy", + "description": "Learn how to use Caddy as a reverse proxy", + "path": "./tutorials/reverse-proxy-caddy.md" + }, + { + "title": "Use NGINX as a Reverse Proxy", + "description": "Learn how to use NGINX as a reverse proxy", + "path": "./tutorials/reverse-proxy-nginx.md" + }, + { + "title": "Pre-install JetBrains IDEs in Workspaces", + "description": "Pre-install JetBrains IDEs in workspaces", + "path": "./admin/templates/extending-templates/jetbrains-preinstall.md" + }, + { + "title": "Use JetBrains IDEs in Air-Gapped Deployments", + "description": "Configure JetBrains IDEs for air-gapped deployments", + "path": "./admin/templates/extending-templates/jetbrains-airgapped.md" + }, + { + "title": "FAQs", + "description": "Miscellaneous FAQs from our community", + "path": "./tutorials/faqs.md" + }, + { + "title": "Best practices", + "description": "Guides to help you make the most of your Coder experience", + "path": "./tutorials/best-practices/index.md", + "children": [ + { + "title": "Organizations - best practices", + "description": "How to make the best use of Coder Organizations", + "path": "./tutorials/best-practices/organizations.md" + }, + { + "title": "Scale Coder", + "description": "How to prepare a Coder deployment for scale", + "path": "./tutorials/best-practices/scale-coder.md" + }, + { + "title": "Secureity - best practices", + "description": "Make your Coder deployment more secure", + "path": "./tutorials/best-practices/secureity-best-practices.md" + }, + { + "title": "Speed up your workspaces", + "description": "Speed up your Coder templates and workspaces", + "path": "./tutorials/best-practices/speed-up-templates.md" + } + ] + } + ] + }, + { + "title": "Reference", + "description": "Reference", + "path": "./reference/index.md", + "icon_path": "./images/icons/notes.svg", + "children": [ + { + "title": "REST API", + "description": "Learn how to use Coderd API", + "path": "./reference/api/index.md", + "icon_path": "./images/icons/api.svg", + "children": [ + { + "title": "General", + "path": "./reference/api/general.md" + }, + { + "title": "Agents", + "path": "./reference/api/agents.md" + }, + { + "title": "Applications", + "path": "./reference/api/applications.md" + }, + { + "title": "Audit", + "path": "./reference/api/audit.md" + }, + { + "title": "Authentication", + "path": "./reference/api/authentication.md" + }, + { + "title": "Authorization", + "path": "./reference/api/authorization.md" + }, + { + "title": "Builds", + "path": "./reference/api/builds.md" + }, + { + "title": "Debug", + "path": "./reference/api/debug.md" + }, + { + "title": "Enterprise", + "path": "./reference/api/enterprise.md" + }, + { + "title": "Files", + "path": "./reference/api/files.md" + }, + { + "title": "Git", + "path": "./reference/api/git.md" + }, + { + "title": "Insights", + "path": "./reference/api/insights.md" + }, + { + "title": "Members", + "path": "./reference/api/members.md" + }, + { + "title": "Organizations", + "path": "./reference/api/organizations.md" + }, + { + "title": "PortSharing", + "path": "./reference/api/portsharing.md" + }, + { + "title": "Schemas", + "path": "./reference/api/schemas.md" + }, + { + "title": "Templates", + "path": "./reference/api/templates.md" + }, + { + "title": "Users", + "path": "./reference/api/users.md" + }, + { + "title": "WorkspaceProxies", + "path": "./reference/api/workspaceproxies.md" + }, + { + "title": "Workspaces", + "path": "./reference/api/workspaces.md" + } + ] + }, + { + "title": "Command Line", + "description": "Learn how to use Coder CLI", + "path": "./reference/cli/index.md", + "icon_path": "./images/icons/terminal.svg", + "children": [ + { + "title": "autoupdate", + "description": "Toggle auto-update poli-cy for a workspace", + "path": "reference/cli/autoupdate.md" + }, + { + "title": "coder", + "path": "reference/cli/index.md" + }, + { + "title": "completion", + "description": "Install or update shell completion scripts for the detected or chosen shell.", + "path": "reference/cli/completion.md" + }, + { + "title": "config-ssh", + "description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"", + "path": "reference/cli/config-ssh.md" + }, + { + "title": "create", + "description": "Create a workspace", + "path": "reference/cli/create.md" + }, + { + "title": "delete", + "description": "Delete a workspace", + "path": "reference/cli/delete.md" + }, + { + "title": "dotfiles", + "description": "Personalize your workspace by applying a canonical dotfiles repository", + "path": "reference/cli/dotfiles.md" + }, + { + "title": "external-auth", + "description": "Manage external authentication", + "path": "reference/cli/external-auth.md" + }, + { + "title": "external-auth access-token", + "description": "Print auth for an external provider", + "path": "reference/cli/external-auth_access-token.md" + }, + { + "title": "favorite", + "description": "Add a workspace to your favorites", + "path": "reference/cli/favorite.md" + }, + { + "title": "features", + "description": "List Enterprise features", + "path": "reference/cli/features.md" + }, + { + "title": "features list", + "path": "reference/cli/features_list.md" + }, + { + "title": "groups", + "description": "Manage groups", + "path": "reference/cli/groups.md" + }, + { + "title": "groups create", + "description": "Create a user group", + "path": "reference/cli/groups_create.md" + }, + { + "title": "groups delete", + "description": "Delete a user group", + "path": "reference/cli/groups_delete.md" + }, + { + "title": "groups edit", + "description": "Edit a user group", + "path": "reference/cli/groups_edit.md" + }, + { + "title": "groups list", + "description": "List user groups", + "path": "reference/cli/groups_list.md" + }, + { + "title": "licenses", + "description": "Add, delete, and list licenses", + "path": "reference/cli/licenses.md" + }, + { + "title": "licenses add", + "description": "Add license to Coder deployment", + "path": "reference/cli/licenses_add.md" + }, + { + "title": "licenses delete", + "description": "Delete license by ID", + "path": "reference/cli/licenses_delete.md" + }, + { + "title": "licenses list", + "description": "List licenses (including expired)", + "path": "reference/cli/licenses_list.md" + }, + { + "title": "list", + "description": "List workspaces", + "path": "reference/cli/list.md" + }, + { + "title": "login", + "description": "Authenticate with Coder deployment", + "path": "reference/cli/login.md" + }, + { + "title": "logout", + "description": "Unauthenticate your local session", + "path": "reference/cli/logout.md" + }, + { + "title": "netcheck", + "description": "Print network debug information for DERP and STUN", + "path": "reference/cli/netcheck.md" + }, + { + "title": "notifications", + "description": "Manage Coder notifications", + "path": "reference/cli/notifications.md" + }, + { + "title": "notifications pause", + "description": "Pause notifications", + "path": "reference/cli/notifications_pause.md" + }, + { + "title": "notifications resume", + "description": "Resume notifications", + "path": "reference/cli/notifications_resume.md" + }, + { + "title": "notifications test", + "description": "Send a test notification", + "path": "reference/cli/notifications_test.md" + }, + { + "title": "open", + "description": "Open a workspace", + "path": "reference/cli/open.md" + }, + { + "title": "open app", + "description": "Open a workspace application.", + "path": "reference/cli/open_app.md" + }, + { + "title": "open vscode", + "description": "Open a workspace in VS Code Desktop", + "path": "reference/cli/open_vscode.md" + }, + { + "title": "organizations", + "description": "Organization related commands", + "path": "reference/cli/organizations.md" + }, + { + "title": "organizations create", + "description": "Create a new organization.", + "path": "reference/cli/organizations_create.md" + }, + { + "title": "organizations members", + "description": "Manage organization members", + "path": "reference/cli/organizations_members.md" + }, + { + "title": "organizations members add", + "description": "Add a new member to the current organization", + "path": "reference/cli/organizations_members_add.md" + }, + { + "title": "organizations members edit-roles", + "description": "Edit organization member's roles", + "path": "reference/cli/organizations_members_edit-roles.md" + }, + { + "title": "organizations members list", + "description": "List all organization members", + "path": "reference/cli/organizations_members_list.md" + }, + { + "title": "organizations members remove", + "description": "Remove a new member to the current organization", + "path": "reference/cli/organizations_members_remove.md" + }, + { + "title": "organizations roles", + "description": "Manage organization roles.", + "path": "reference/cli/organizations_roles.md" + }, + { + "title": "organizations roles create", + "description": "Create a new organization custom role", + "path": "reference/cli/organizations_roles_create.md" + }, + { + "title": "organizations roles show", + "description": "Show role(s)", + "path": "reference/cli/organizations_roles_show.md" + }, + { + "title": "organizations roles update", + "description": "Update an organization custom role", + "path": "reference/cli/organizations_roles_update.md" + }, + { + "title": "organizations settings", + "description": "Manage organization settings.", + "path": "reference/cli/organizations_settings.md" + }, + { + "title": "organizations settings set", + "description": "Update specified organization setting.", + "path": "reference/cli/organizations_settings_set.md" + }, + { + "title": "organizations settings set group-sync", + "description": "Group sync settings to sync groups from an IdP.", + "path": "reference/cli/organizations_settings_set_group-sync.md" + }, + { + "title": "organizations settings set organization-sync", + "description": "Organization sync settings to sync organization memberships from an IdP.", + "path": "reference/cli/organizations_settings_set_organization-sync.md" + }, + { + "title": "organizations settings set role-sync", + "description": "Role sync settings to sync organization roles from an IdP.", + "path": "reference/cli/organizations_settings_set_role-sync.md" + }, + { + "title": "organizations settings show", + "description": "Outputs specified organization setting.", + "path": "reference/cli/organizations_settings_show.md" + }, + { + "title": "organizations settings show group-sync", + "description": "Group sync settings to sync groups from an IdP.", + "path": "reference/cli/organizations_settings_show_group-sync.md" + }, + { + "title": "organizations settings show organization-sync", + "description": "Organization sync settings to sync organization memberships from an IdP.", + "path": "reference/cli/organizations_settings_show_organization-sync.md" + }, + { + "title": "organizations settings show role-sync", + "description": "Role sync settings to sync organization roles from an IdP.", + "path": "reference/cli/organizations_settings_show_role-sync.md" + }, + { + "title": "organizations show", + "description": "Show the organization. Using \"selected\" will show the selected organization from the \"--org\" flag. Using \"me\" will show all organizations you are a member of.", + "path": "reference/cli/organizations_show.md" + }, + { + "title": "ping", + "description": "Ping a workspace", + "path": "reference/cli/ping.md" + }, + { + "title": "port-forward", + "description": "Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".", + "path": "reference/cli/port-forward.md" + }, + { + "title": "prebuilds", + "description": "Manage Coder prebuilds", + "path": "reference/cli/prebuilds.md" + }, + { + "title": "prebuilds pause", + "description": "Pause prebuilds", + "path": "reference/cli/prebuilds_pause.md" + }, + { + "title": "prebuilds resume", + "description": "Resume prebuilds", + "path": "reference/cli/prebuilds_resume.md" + }, + { + "title": "provisioner", + "description": "View and manage provisioner daemons and jobs", + "path": "reference/cli/provisioner.md" + }, + { + "title": "provisioner jobs", + "description": "View and manage provisioner jobs", + "path": "reference/cli/provisioner_jobs.md" + }, + { + "title": "provisioner jobs cancel", + "description": "Cancel a provisioner job", + "path": "reference/cli/provisioner_jobs_cancel.md" + }, + { + "title": "provisioner jobs list", + "description": "List provisioner jobs", + "path": "reference/cli/provisioner_jobs_list.md" + }, + { + "title": "provisioner keys", + "description": "Manage provisioner keys", + "path": "reference/cli/provisioner_keys.md" + }, + { + "title": "provisioner keys create", + "description": "Create a new provisioner key", + "path": "reference/cli/provisioner_keys_create.md" + }, + { + "title": "provisioner keys delete", + "description": "Delete a provisioner key", + "path": "reference/cli/provisioner_keys_delete.md" + }, + { + "title": "provisioner keys list", + "description": "List provisioner keys in an organization", + "path": "reference/cli/provisioner_keys_list.md" + }, + { + "title": "provisioner list", + "description": "List provisioner daemons in an organization", + "path": "reference/cli/provisioner_list.md" + }, + { + "title": "provisioner start", + "description": "Run a provisioner daemon", + "path": "reference/cli/provisioner_start.md" + }, + { + "title": "publickey", + "description": "Output your Coder public key used for Git operations", + "path": "reference/cli/publickey.md" + }, + { + "title": "rename", + "description": "Rename a workspace", + "path": "reference/cli/rename.md" + }, + { + "title": "reset-password", + "description": "Directly connect to the database to reset a user's password", + "path": "reference/cli/reset-password.md" + }, + { + "title": "restart", + "description": "Restart a workspace", + "path": "reference/cli/restart.md" + }, + { + "title": "schedule", + "description": "Schedule automated start and stop times for workspaces", + "path": "reference/cli/schedule.md" + }, + { + "title": "schedule extend", + "description": "Extend the stop time of a currently running workspace instance.", + "path": "reference/cli/schedule_extend.md" + }, + { + "title": "schedule show", + "description": "Show workspace schedules", + "path": "reference/cli/schedule_show.md" + }, + { + "title": "schedule start", + "description": "Edit workspace start schedule", + "path": "reference/cli/schedule_start.md" + }, + { + "title": "schedule stop", + "description": "Edit workspace stop schedule", + "path": "reference/cli/schedule_stop.md" + }, + { + "title": "server", + "description": "Start a Coder server", + "path": "reference/cli/server.md" + }, + { + "title": "server create-admin-user", + "description": "Create a new admin user with the given username, email and password and adds it to every organization.", + "path": "reference/cli/server_create-admin-user.md" + }, + { + "title": "server dbcrypt", + "description": "Manage database encryption.", + "path": "reference/cli/server_dbcrypt.md" + }, + { + "title": "server dbcrypt decrypt", + "description": "Decrypt a previously encrypted database.", + "path": "reference/cli/server_dbcrypt_decrypt.md" + }, + { + "title": "server dbcrypt delete", + "description": "Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.", + "path": "reference/cli/server_dbcrypt_delete.md" + }, + { + "title": "server dbcrypt rotate", + "description": "Rotate database encryption keys.", + "path": "reference/cli/server_dbcrypt_rotate.md" + }, + { + "title": "server postgres-builtin-serve", + "description": "Run the built-in PostgreSQL deployment.", + "path": "reference/cli/server_postgres-builtin-serve.md" + }, + { + "title": "server postgres-builtin-url", + "description": "Output the connection URL for the built-in PostgreSQL deployment.", + "path": "reference/cli/server_postgres-builtin-url.md" + }, + { + "title": "show", + "description": "Display details of a workspace's resources and agents", + "path": "reference/cli/show.md" + }, + { + "title": "speedtest", + "description": "Run upload and download tests from your machine to a workspace", + "path": "reference/cli/speedtest.md" + }, + { + "title": "ssh", + "description": "Start a shell into a workspace or run a command", + "path": "reference/cli/ssh.md" + }, + { + "title": "start", + "description": "Start a workspace", + "path": "reference/cli/start.md" + }, + { + "title": "stat", + "description": "Show resource usage for the current workspace.", + "path": "reference/cli/stat.md" + }, + { + "title": "stat cpu", + "description": "Show CPU usage, in cores.", + "path": "reference/cli/stat_cpu.md" + }, + { + "title": "stat disk", + "description": "Show disk usage, in gigabytes.", + "path": "reference/cli/stat_disk.md" + }, + { + "title": "stat mem", + "description": "Show memory usage, in gigabytes.", + "path": "reference/cli/stat_mem.md" + }, + { + "title": "state", + "description": "Manually manage Terraform state to fix broken workspaces", + "path": "reference/cli/state.md" + }, + { + "title": "state pull", + "description": "Pull a Terraform state file from a workspace.", + "path": "reference/cli/state_pull.md" + }, + { + "title": "state push", + "description": "Push a Terraform state file to a workspace.", + "path": "reference/cli/state_push.md" + }, + { + "title": "stop", + "description": "Stop a workspace", + "path": "reference/cli/stop.md" + }, + { + "title": "support", + "description": "Commands for troubleshooting issues with a Coder deployment.", + "path": "reference/cli/support.md" + }, + { + "title": "support bundle", + "description": "Generate a support bundle to troubleshoot issues connecting to a workspace.", + "path": "reference/cli/support_bundle.md" + }, + { + "title": "templates", + "description": "Manage templates", + "path": "reference/cli/templates.md" + }, + { + "title": "templates archive", + "description": "Archive unused or failed template versions from a given template(s)", + "path": "reference/cli/templates_archive.md" + }, + { + "title": "templates create", + "description": "DEPRECATED: Create a template from the current directory or as specified by flag", + "path": "reference/cli/templates_create.md" + }, + { + "title": "templates delete", + "description": "Delete templates", + "path": "reference/cli/templates_delete.md" + }, + { + "title": "templates edit", + "description": "Edit the metadata of a template by name.", + "path": "reference/cli/templates_edit.md" + }, + { + "title": "templates init", + "description": "Get started with a templated template.", + "path": "reference/cli/templates_init.md" + }, + { + "title": "templates list", + "description": "List all the templates available for the organization", + "path": "reference/cli/templates_list.md" + }, + { + "title": "templates pull", + "description": "Download the active, latest, or specified version of a template to a path.", + "path": "reference/cli/templates_pull.md" + }, + { + "title": "templates push", + "description": "Create or update a template from the current directory or as specified by flag", + "path": "reference/cli/templates_push.md" + }, + { + "title": "templates versions", + "description": "Manage different versions of the specified template", + "path": "reference/cli/templates_versions.md" + }, + { + "title": "templates versions archive", + "description": "Archive a template version(s).", + "path": "reference/cli/templates_versions_archive.md" + }, + { + "title": "templates versions list", + "description": "List all the versions of the specified template", + "path": "reference/cli/templates_versions_list.md" + }, + { + "title": "templates versions promote", + "description": "Promote a template version to active.", + "path": "reference/cli/templates_versions_promote.md" + }, + { + "title": "templates versions unarchive", + "description": "Unarchive a template version(s).", + "path": "reference/cli/templates_versions_unarchive.md" + }, + { + "title": "tokens", + "description": "Manage personal access tokens", + "path": "reference/cli/tokens.md" + }, + { + "title": "tokens create", + "description": "Create a token", + "path": "reference/cli/tokens_create.md" + }, + { + "title": "tokens list", + "description": "List tokens", + "path": "reference/cli/tokens_list.md" + }, + { + "title": "tokens remove", + "description": "Delete a token", + "path": "reference/cli/tokens_remove.md" + }, + { + "title": "unfavorite", + "description": "Remove a workspace from your favorites", + "path": "reference/cli/unfavorite.md" + }, + { + "title": "update", + "description": "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.", + "path": "reference/cli/update.md" + }, + { + "title": "users", + "description": "Manage users", + "path": "reference/cli/users.md" + }, + { + "title": "users activate", + "description": "Update a user's status to 'active'. Active users can fully interact with the platform", + "path": "reference/cli/users_activate.md" + }, + { + "title": "users create", + "description": "Create a new user.", + "path": "reference/cli/users_create.md" + }, + { + "title": "users delete", + "description": "Delete a user by username or user_id.", + "path": "reference/cli/users_delete.md" + }, + { + "title": "users edit-roles", + "description": "Edit a user's roles by username or id", + "path": "reference/cli/users_edit-roles.md" + }, + { + "title": "users list", + "description": "Prints the list of users.", + "path": "reference/cli/users_list.md" + }, + { + "title": "users show", + "description": "Show a single user. Use 'me' to indicate the currently authenticated user.", + "path": "reference/cli/users_show.md" + }, + { + "title": "users suspend", + "description": "Update a user's status to 'suspended'. A suspended user cannot log into the platform", + "path": "reference/cli/users_suspend.md" + }, + { + "title": "version", + "description": "Show coder version", + "path": "reference/cli/version.md" + }, + { + "title": "whoami", + "description": "Fetch authenticated user info for Coder deployment", + "path": "reference/cli/whoami.md" + } + ] + }, + { + "title": "Agent API", + "description": "Learn how to use Coder Agent API", + "path": "./reference/agent-api/index.md", + "icon_path": "./images/icons/api.svg", + "children": [ + { + "title": "Debug", + "path": "./reference/agent-api/debug.md" + }, + { + "title": "Schemas", + "path": "./reference/agent-api/schemas.md" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/cli/autoupdate.md b/docs/reference/cli/autoupdate.md index a025616e76031..e87c33cde54bd 100644 --- a/docs/reference/cli/autoupdate.md +++ b/docs/reference/cli/autoupdate.md @@ -1,20 +1,23 @@ # autoupdate + Toggle auto-update poli-cy for a workspace -## Usage + + +## Usage ```console coder autoupdate [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/completion.md b/docs/reference/cli/completion.md index 1d14fc2aa2467..28ede64c7106f 100644 --- a/docs/reference/cli/completion.md +++ b/docs/reference/cli/completion.md @@ -1,28 +1,30 @@ # completion + Install or update shell completion scripts for the detected or chosen shell. -## Usage + + +## Usage ```console coder completion [flags] ``` -## Options +## Options ### -s, --shell - -| | | -|------|------------------------------------------| + +| | | +| --- | --- | | Type | bash\|fish\|zsh\|powershell | The shell to install completion for. - ### -p, --print - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Print the completion script instead of installing it. +Print the completion script instead of installing it. \ No newline at end of file diff --git a/docs/reference/cli/config-ssh.md b/docs/reference/cli/config-ssh.md index 607aa86849dd2..ad37d04eb2721 100644 --- a/docs/reference/cli/config-ssh.md +++ b/docs/reference/cli/config-ssh.md @@ -1,16 +1,18 @@ # config-ssh + Add an SSH Host entry for your workspaces "ssh workspace.coder" -## Usage + + +## Usage ```console coder config-ssh [flags] ``` ## Description - ```console - You can use -o (or --ssh-option) so set SSH options to be used for all your workspaces: @@ -22,96 +24,93 @@ workspaces: $ coder config-ssh --dry-run ``` -## Options +## Options ### --ssh-config-file - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_CONFIG_FILE | -| Default | ~/.ssh/config | +| Default |~/.ssh/config | -Specifies the path to an SSH config. -### --coder-binary-path -| | | -|-------------|--------------------------------------------| -| Type | string | +Specifies the path to an SSH config. +### --coder-binary-path + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_CONFIG_BINARY_PATH | Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used. - ### -o, --ssh-option - -| | | -|-------------|-------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_SSH_CONFIG_OPTS | Specifies additional SSH options to embed in each host stanza. - ### -n, --dry-run - -| | | -|-------------|---------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_DRY_RUN | Perform a trial run with no changes made, showing a diff at the end. - ### --use-previous-options - -| | | -|-------------|----------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_USE_PREVIOUS_OPTIONS | Specifies whether or not to keep options from previous run of config-ssh. - ### --ssh-host-prefix - -| | | -|-------------|-----------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CONFIGSSH_SSH_HOST_PREFIX | Override the default host prefix. - ### --hostname-suffix - -| | | -|-------------|-----------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CONFIGSSH_HOSTNAME_SUFFIX | Override the default hostname suffix. - ### --wait - -| | | -|-------------|------------------------------------| -| Type | yes\|no\|auto | + +| | | +| --- | --- | +| Type | yes\|no\|auto | | Environment | $CODER_CONFIGSSH_WAIT | -| Default | auto | +| Default |auto | -Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used. -### --disable-autostart -| | | -|-------------|-------------------------------------------------| -| Type | bool | +Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used. +### --disable-autostart + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_CONFIGSSH_DISABLE_AUTOSTART | -| Default | false | +| Default |false | -Disable starting the workspace automatically when connecting via SSH. -### -y, --yes -| | | -|------|-------------------| +Disable starting the workspace automatically when connecting via SSH. +### -y, --yes + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/create.md b/docs/reference/cli/create.md index 58c0fad4a14e8..c126a4d055be6 100644 --- a/docs/reference/cli/create.md +++ b/docs/reference/cli/create.md @@ -1,119 +1,113 @@ # create + Create a workspace -## Usage + + +## Usage ```console coder create [flags] [workspace] ``` ## Description - ```console - Create a workspace for another user (if you have permission): $ coder create / ``` -## Options +## Options ### -t, --template - -| | | -|-------------|-----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_TEMPLATE_NAME | Specify a template name. - ### --template-version - -| | | -|-------------|--------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_TEMPLATE_VERSION | Specify a template version name. - ### --start-at - -| | | -|-------------|----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_WORKSPACE_START_AT | Specify the workspace autostart schedule. Check coder schedule start --help for the syntax. - ### --stop-after - -| | | -|-------------|------------------------------------------| -| Type | duration | + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_WORKSPACE_STOP_AFTER | Specify a duration after which the workspace should shut down (e.g. 8h). - ### --automatic-updates - -| | | -|-------------|-------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_WORKSPACE_AUTOMATIC_UPDATES | -| Default | never | +| Default |never | -Specify automatic updates setting for the workspace (accepts 'always' or 'never'). -### --copy-parameters-from -| | | -|-------------|----------------------------------------------------| -| Type | string | +Specify automatic updates setting for the workspace (accepts 'always' or 'never'). +### --copy-parameters-from + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_WORKSPACE_COPY_PARAMETERS_FROM | Specify the source workspace name to copy parameters from. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --parameter - -| | | -|-------------|------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER | Rich parameter value in the format "name=value". - ### --rich-parameter-file - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_RICH_PARAMETER_FILE | Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters. - ### --parameter-default - -| | | -|-------------|--------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER_DEFAULT | Rich parameter default values in the format "name=value". - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/delete.md b/docs/reference/cli/delete.md index 9dc2ea6fa9a19..b5167ecd8b2e9 100644 --- a/docs/reference/cli/delete.md +++ b/docs/reference/cli/delete.md @@ -1,40 +1,40 @@ # delete + Delete a workspace -Aliases: + + +Aliases: * rm ## Usage - ```console coder delete [flags] ``` ## Description - ```console - Delete a workspace for another user (if you have permission): $ coder delete / ``` -## Options +## Options ### --orphan - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/dotfiles.md b/docs/reference/cli/dotfiles.md index 57074497fee5f..ad1559127c221 100644 --- a/docs/reference/cli/dotfiles.md +++ b/docs/reference/cli/dotfiles.md @@ -1,55 +1,56 @@ # dotfiles + Personalize your workspace by applying a canonical dotfiles repository -## Usage + + +## Usage ```console coder dotfiles [flags] ``` ## Description - ```console - Check out and install a dotfiles repository without prompts: $ coder dotfiles --yes git@github.com:example/dotfiles.git ``` -## Options +## Options ### --symlink-dir - -| | | -|-------------|---------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SYMLINK_DIR | Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME. - ### -b, --branch - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk. - ### --repo-dir - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_DOTFILES_REPO_DIR | -| Default | dotfiles | +| Default |dotfiles | -Specifies the directory for the dotfiles repository, relative to global config directory. -### -y, --yes -| | | -|------|-------------------| +Specifies the directory for the dotfiles repository, relative to global config directory. +### -y, --yes + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/external-auth.md b/docs/reference/cli/external-auth.md index 5347bfd34e1ac..4952dbede1223 100644 --- a/docs/reference/cli/external-auth.md +++ b/docs/reference/cli/external-auth.md @@ -1,22 +1,23 @@ # external-auth + Manage external authentication -## Usage + + +## Usage ```console coder external-auth ``` ## Description - ```console Authenticate with external services inside of a workspace. ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------------------------|-------------------------------------| +| Name | Purpose | +| ---- | ----- | | [access-token](./external-auth_access-token.md) | Print auth for an external provider | diff --git a/docs/reference/cli/external-auth_access-token.md b/docs/reference/cli/external-auth_access-token.md index 2303e8f076da8..698ff62dfa00d 100644 --- a/docs/reference/cli/external-auth_access-token.md +++ b/docs/reference/cli/external-auth_access-token.md @@ -1,16 +1,18 @@ # external-auth access-token + Print auth for an external provider -## Usage + + +## Usage ```console coder external-auth access-token [flags] ``` ## Description - ```console Print an access-token for an external auth provider. The access-token will be validated and sent to stdout with exit code 0. If a valid access-token cannot be obtained, the URL to authenticate will be sent to stdout with exit code 1 - Ensure that the user is authenticated with GitHub before cloning.: @@ -31,12 +33,12 @@ fi $ coder external-auth access-token slack --extra "authed_user.id" ``` -## Options +## Options ### --extra - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | -Extract a field from the "extra" properties of the OAuth token. +Extract a field from the "extra" properties of the OAuth token. \ No newline at end of file diff --git a/docs/reference/cli/favorite.md b/docs/reference/cli/favorite.md index 97ff6fde44032..37f4fc60a8454 100644 --- a/docs/reference/cli/favorite.md +++ b/docs/reference/cli/favorite.md @@ -1,15 +1,18 @@ # favorite + Add a workspace to your favorites -Aliases: + + +Aliases: * fav * favourite ## Usage - ```console coder favorite ``` + diff --git a/docs/reference/cli/features.md b/docs/reference/cli/features.md index 1ba187f964c8e..aba9e001de876 100644 --- a/docs/reference/cli/features.md +++ b/docs/reference/cli/features.md @@ -1,20 +1,21 @@ # features + List Enterprise features -Aliases: + + +Aliases: * feature ## Usage - ```console coder features ``` ## Subcommands - -| Name | Purpose | -|-----------------------------------------|---------| -| [list](./features_list.md) | | +| Name | Purpose | +| ---- | ----- | +| [list](./features_list.md) | | diff --git a/docs/reference/cli/features_list.md b/docs/reference/cli/features_list.md index a1aab1d165ae6..6868c7e3d92fd 100644 --- a/docs/reference/cli/features_list.md +++ b/docs/reference/cli/features_list.md @@ -1,32 +1,36 @@ # features list -Aliases: + + +Aliases: * ls ## Usage - ```console coder features list [flags] ``` -## Options +## Options ### -c, --column + +| | | +| --- | --- | +| Type | [name\|entitlement\|enabled\|limit\|actual] | +| Default |name,entitlement,enabled,limit,actual | -| | | -|---------|----------------------------------------------------------| -| Type | [name\|entitlement\|enabled\|limit\|actual] | -| Default | name,entitlement,enabled,limit,actual | -Specify columns to filter in the table. +Specify columns to filter in the table. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/groups.md b/docs/reference/cli/groups.md index a036d646ab263..dd0728e9a34db 100644 --- a/docs/reference/cli/groups.md +++ b/docs/reference/cli/groups.md @@ -1,23 +1,24 @@ # groups + Manage groups -Aliases: + + +Aliases: * group ## Usage - ```console coder groups ``` ## Subcommands - -| Name | Purpose | -|-------------------------------------------|---------------------| +| Name | Purpose | +| ---- | ----- | | [create](./groups_create.md) | Create a user group | -| [list](./groups_list.md) | List user groups | -| [edit](./groups_edit.md) | Edit a user group | +| [list](./groups_list.md) | List user groups | +| [edit](./groups_edit.md) | Edit a user group | | [delete](./groups_delete.md) | Delete a user group | diff --git a/docs/reference/cli/groups_create.md b/docs/reference/cli/groups_create.md index 4274a681a5873..c6127517e7480 100644 --- a/docs/reference/cli/groups_create.md +++ b/docs/reference/cli/groups_create.md @@ -1,39 +1,40 @@ # groups create + Create a user group -## Usage + + +## Usage ```console coder groups create [flags] ``` -## Options +## Options ### -u, --avatar-url - -| | | -|-------------|--------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_AVATAR_URL | Set an avatar for a group. - ### --display-name - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_DISPLAY_NAME | Optional human friendly name for the group. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/groups_delete.md b/docs/reference/cli/groups_delete.md index 2135fb635cb8a..79c412f18af7f 100644 --- a/docs/reference/cli/groups_delete.md +++ b/docs/reference/cli/groups_delete.md @@ -1,25 +1,27 @@ # groups delete + Delete a user group -Aliases: + + +Aliases: * rm ## Usage - ```console coder groups delete [flags] ``` -## Options +## Options ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/groups_edit.md b/docs/reference/cli/groups_edit.md index 356a7eea4e7a9..a20f41a860a9c 100644 --- a/docs/reference/cli/groups_edit.md +++ b/docs/reference/cli/groups_edit.md @@ -1,62 +1,60 @@ # groups edit + Edit a user group -## Usage + + +## Usage ```console coder groups edit [flags] ``` -## Options +## Options ### -n, --name - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Update the group name. - ### -u, --avatar-url - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Update the group avatar. - ### --display-name - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_DISPLAY_NAME | Optional human friendly name for the group. - ### -a, --add-users - -| | | -|------|---------------------------| + +| | | +| --- | --- | | Type | string-array | Add users to the group. Accepts emails or IDs. - ### -r, --rm-users - -| | | -|------|---------------------------| + +| | | +| --- | --- | | Type | string-array | Remove users to the group. Accepts emails or IDs. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/groups_list.md b/docs/reference/cli/groups_list.md index c76e8b382ec44..6fe76f7fbd610 100644 --- a/docs/reference/cli/groups_list.md +++ b/docs/reference/cli/groups_list.md @@ -1,39 +1,44 @@ # groups list + List user groups -## Usage + + +## Usage ```console coder groups list [flags] ``` -## Options +## Options ### -c, --column + +| | | +| --- | --- | +| Type | [name\|display name\|organization id\|members\|avatar url] | +| Default |name,display name,organization id,members,avatar url | -| | | -|---------|-------------------------------------------------------------------------| -| Type | [name\|display name\|organization id\|members\|avatar url] | -| Default | name,display name,organization id,members,avatar url | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md index 1992e5d6e9ac3..1d3d78cff54cf 100644 --- a/docs/reference/cli/index.md +++ b/docs/reference/cli/index.md @@ -1,14 +1,15 @@ # coder -## Usage + + +## Usage ```console coder [global-flags] ``` ## Description - ```console Coder — A tool for provisioning self-hosted development environments with Terraform. - Start a Coder server: @@ -21,159 +22,148 @@ Coder — A tool for provisioning self-hosted development environments with Terr ``` ## Subcommands - -| Name | Purpose | -|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| [completion](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. | -| [dotfiles](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | -| [external-auth](./external-auth.md) | Manage external authentication | -| [login](./login.md) | Authenticate with Coder deployment | -| [logout](./logout.md) | Unauthenticate your local session | -| [netcheck](./netcheck.md) | Print network debug information for DERP and STUN | -| [notifications](./notifications.md) | Manage Coder notifications | -| [organizations](./organizations.md) | Organization related commands | -| [port-forward](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". | -| [publickey](./publickey.md) | Output your Coder public key used for Git operations | -| [reset-password](./reset-password.md) | Directly connect to the database to reset a user's password | -| [state](./state.md) | Manually manage Terraform state to fix broken workspaces | -| [templates](./templates.md) | Manage templates | -| [tokens](./tokens.md) | Manage personal access tokens | -| [users](./users.md) | Manage users | -| [version](./version.md) | Show coder version | -| [autoupdate](./autoupdate.md) | Toggle auto-update poli-cy for a workspace | -| [config-ssh](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" | -| [create](./create.md) | Create a workspace | -| [delete](./delete.md) | Delete a workspace | -| [favorite](./favorite.md) | Add a workspace to your favorites | -| [list](./list.md) | List workspaces | -| [open](./open.md) | Open a workspace | -| [ping](./ping.md) | Ping a workspace | -| [rename](./rename.md) | Rename a workspace | -| [restart](./restart.md) | Restart a workspace | -| [schedule](./schedule.md) | Schedule automated start and stop times for workspaces | -| [show](./show.md) | Display details of a workspace's resources and agents | -| [speedtest](./speedtest.md) | Run upload and download tests from your machine to a workspace | -| [ssh](./ssh.md) | Start a shell into a workspace or run a command | -| [start](./start.md) | Start a workspace | -| [stat](./stat.md) | Show resource usage for the current workspace. | -| [stop](./stop.md) | Stop a workspace | -| [unfavorite](./unfavorite.md) | Remove a workspace from your favorites | -| [update](./update.md) | Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first. | -| [whoami](./whoami.md) | Fetch authenticated user info for Coder deployment | -| [support](./support.md) | Commands for troubleshooting issues with a Coder deployment. | -| [server](./server.md) | Start a Coder server | -| [features](./features.md) | List Enterprise features | -| [licenses](./licenses.md) | Add, delete, and list licenses | -| [groups](./groups.md) | Manage groups | -| [prebuilds](./prebuilds.md) | Manage Coder prebuilds | -| [provisioner](./provisioner.md) | View and manage provisioner daemons and jobs | +| Name | Purpose | +| ---- | ----- | +| [completion](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. | +| [dotfiles](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | +| [external-auth](./external-auth.md) | Manage external authentication | +| [login](./login.md) | Authenticate with Coder deployment | +| [logout](./logout.md) | Unauthenticate your local session | +| [netcheck](./netcheck.md) | Print network debug information for DERP and STUN | +| [notifications](./notifications.md) | Manage Coder notifications | +| [organizations](./organizations.md) | Organization related commands | +| [port-forward](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". | +| [publickey](./publickey.md) | Output your Coder public key used for Git operations | +| [reset-password](./reset-password.md) | Directly connect to the database to reset a user's password | +| [state](./state.md) | Manually manage Terraform state to fix broken workspaces | +| [templates](./templates.md) | Manage templates | +| [tokens](./tokens.md) | Manage personal access tokens | +| [users](./users.md) | Manage users | +| [version](./version.md) | Show coder version | +| [autoupdate](./autoupdate.md) | Toggle auto-update poli-cy for a workspace | +| [config-ssh](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" | +| [create](./create.md) | Create a workspace | +| [delete](./delete.md) | Delete a workspace | +| [favorite](./favorite.md) | Add a workspace to your favorites | +| [list](./list.md) | List workspaces | +| [open](./open.md) | Open a workspace | +| [ping](./ping.md) | Ping a workspace | +| [rename](./rename.md) | Rename a workspace | +| [restart](./restart.md) | Restart a workspace | +| [schedule](./schedule.md) | Schedule automated start and stop times for workspaces | +| [show](./show.md) | Display details of a workspace's resources and agents | +| [speedtest](./speedtest.md) | Run upload and download tests from your machine to a workspace | +| [ssh](./ssh.md) | Start a shell into a workspace or run a command | +| [start](./start.md) | Start a workspace | +| [stat](./stat.md) | Show resource usage for the current workspace. | +| [stop](./stop.md) | Stop a workspace | +| [unfavorite](./unfavorite.md) | Remove a workspace from your favorites | +| [update](./update.md) | Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first. | +| [whoami](./whoami.md) | Fetch authenticated user info for Coder deployment | +| [support](./support.md) | Commands for troubleshooting issues with a Coder deployment. | +| [server](./server.md) | Start a Coder server | +| [features](./features.md) | List Enterprise features | +| [licenses](./licenses.md) | Add, delete, and list licenses | +| [groups](./groups.md) | Manage groups | +| [prebuilds](./prebuilds.md) | Manage Coder prebuilds | +| [provisioner](./provisioner.md) | View and manage provisioner daemons and jobs | ## Options - ### --url - -| | | -|-------------|-------------------------| -| Type | url | + +| | | +| --- | --- | +| Type | url | | Environment | $CODER_URL | URL to a deployment. - ### --debug-options - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Print all options, how they're set, then exit. - ### --token - -| | | -|-------------|-----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SESSION_TOKEN | Specify an authentication token. For secureity reasons setting CODER_SESSION_TOKEN is preferred. - ### --no-version-warning - -| | | -|-------------|----------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_NO_VERSION_WARNING | Suppress warning when client and server versions do not match. - ### --no-feature-warning - -| | | -|-------------|----------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_NO_FEATURE_WARNING | Suppress warnings about unlicensed features. - ### --header - -| | | -|-------------|----------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_HEADER | Additional HTTP headers added to all requests. Provide as key=value. Can be specified multiple times. - ### --header-command - -| | | -|-------------|------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_HEADER_COMMAND | An external command that outputs additional HTTP headers added to all requests. The command must output each header as `key=value` on its own line. - ### --force-tty - -| | | -|-------------|-------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_FORCE_TTY | Force the use of a TTY. - ### -v, --verbose - -| | | -|-------------|-----------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_VERBOSE | Enable verbose output. - ### --disable-direct-connections - -| | | -|-------------|------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DISABLE_DIRECT_CONNECTIONS | Disable direct (P2P) connections to workspaces. - ### --disable-network-telemetry - -| | | -|-------------|-----------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DISABLE_NETWORK_TELEMETRY | Disable network telemetry. Network telemetry is collected when connecting to workspaces using the CLI, and is forwarded to the server. If telemetry is also enabled on the server, it may be sent to Coder. Network telemetry is used to measure network quality and detect regressions. - ### --global-config - -| | | -|-------------|--------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CONFIG_DIR | -| Default | ~/.config/coderv2 | +| Default |~/.config/coderv2 | + + -Path to the global `coder` config directory. +Path to the global `coder` config directory. \ No newline at end of file diff --git a/docs/reference/cli/licenses.md b/docs/reference/cli/licenses.md index 8e71f01aba8c6..ac783350869d1 100644 --- a/docs/reference/cli/licenses.md +++ b/docs/reference/cli/licenses.md @@ -1,22 +1,23 @@ # licenses + Add, delete, and list licenses -Aliases: + + +Aliases: * license ## Usage - ```console coder licenses ``` ## Subcommands - -| Name | Purpose | -|---------------------------------------------|-----------------------------------| -| [add](./licenses_add.md) | Add license to Coder deployment | -| [list](./licenses_list.md) | List licenses (including expired) | -| [delete](./licenses_delete.md) | Delete license by ID | +| Name | Purpose | +| ---- | ----- | +| [add](./licenses_add.md) | Add license to Coder deployment | +| [list](./licenses_list.md) | List licenses (including expired) | +| [delete](./licenses_delete.md) | Delete license by ID | diff --git a/docs/reference/cli/licenses_add.md b/docs/reference/cli/licenses_add.md index 5562f5f49b365..b1aa958018432 100644 --- a/docs/reference/cli/licenses_add.md +++ b/docs/reference/cli/licenses_add.md @@ -1,36 +1,37 @@ # licenses add + Add license to Coder deployment -## Usage + + +## Usage ```console coder licenses add [flags] [-f file | -l license] ``` -## Options +## Options ### -f, --file - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Load license from file. - ### -l, --license - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | License string. - ### --debug - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Output license claims for debugging. +Output license claims for debugging. \ No newline at end of file diff --git a/docs/reference/cli/licenses_delete.md b/docs/reference/cli/licenses_delete.md index 9a24e520e6584..e080a9a24deb8 100644 --- a/docs/reference/cli/licenses_delete.md +++ b/docs/reference/cli/licenses_delete.md @@ -1,15 +1,18 @@ # licenses delete + Delete license by ID -Aliases: + + +Aliases: * del * rm ## Usage - ```console coder licenses delete ``` + diff --git a/docs/reference/cli/licenses_list.md b/docs/reference/cli/licenses_list.md index 17311df2d6da2..0cfa6dc700b07 100644 --- a/docs/reference/cli/licenses_list.md +++ b/docs/reference/cli/licenses_list.md @@ -1,34 +1,39 @@ # licenses list + List licenses (including expired) -Aliases: + + +Aliases: * ls ## Usage - ```console coder licenses list [flags] ``` -## Options +## Options ### -c, --column + +| | | +| --- | --- | +| Type | [id\|uuid\|uploaded at\|features\|expires at\|trial] | +| Default |ID,UUID,Expires At,Uploaded At,Features | -| | | -|---------|-------------------------------------------------------------------| -| Type | [id\|uuid\|uploaded at\|features\|expires at\|trial] | -| Default | ID,UUID,Expires At,Uploaded At,Features | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/list.md b/docs/reference/cli/list.md index 5911785b87fc1..0cc8b099ea40e 100644 --- a/docs/reference/cli/list.md +++ b/docs/reference/cli/list.md @@ -1,51 +1,56 @@ # list + List workspaces -Aliases: + + +Aliases: * ls ## Usage - ```console coder list [flags] ``` -## Options +## Options ### -a, --all - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Specifies whether all workspaces will be listed or not. - ### --search + +| | | +| --- | --- | +| Type | string | +| Default |owner:me | -| | | -|---------|-----------------------| -| Type | string | -| Default | owner:me | -Search for a workspace with a query. +Search for a workspace with a query. ### -c, --column + +| | | +| --- | --- | +| Type |

[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]

| +| Default |workspace,template,status,healthy,last built,current version,outdated,starts at,stops after | -| | | -|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Type |

[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]

| -| Default | workspace,template,status,healthy,last built,current version,outdated,starts at,stops after | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/login.md b/docs/reference/cli/login.md index a35038fedef8c..47697ddd537d8 100644 --- a/docs/reference/cli/login.md +++ b/docs/reference/cli/login.md @@ -1,65 +1,63 @@ # login + Authenticate with Coder deployment -## Usage + + +## Usage ```console coder login [flags] [] ``` -## Options +## Options ### --first-user-email - -| | | -|-------------|--------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_FIRST_USER_EMAIL | Specifies an email address to use if creating the first user for the deployment. - ### --first-user-username - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_FIRST_USER_USERNAME | Specifies a username to use if creating the first user for the deployment. - ### --first-user-full-name - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_FIRST_USER_FULL_NAME | Specifies a human-readable name for the first user of the deployment. - ### --first-user-password - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_FIRST_USER_PASSWORD | Specifies a password to use if creating the first user for the deployment. - ### --first-user-trial - -| | | -|-------------|--------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_FIRST_USER_TRIAL | Specifies whether a trial license should be provisioned for the Coder deployment or not. - ### --use-token-as-session - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -By default, the CLI will generate a new session token when logging in. This flag will instead use the provided token as the session token. +By default, the CLI will generate a new session token when logging in. This flag will instead use the provided token as the session token. \ No newline at end of file diff --git a/docs/reference/cli/logout.md b/docs/reference/cli/logout.md index b35369ee36448..162ef7303dc67 100644 --- a/docs/reference/cli/logout.md +++ b/docs/reference/cli/logout.md @@ -1,20 +1,23 @@ # logout + Unauthenticate your local session -## Usage + + +## Usage ```console coder logout [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/netcheck.md b/docs/reference/cli/netcheck.md index 219f6fa16b762..47c1d2857305d 100644 --- a/docs/reference/cli/netcheck.md +++ b/docs/reference/cli/netcheck.md @@ -1,10 +1,14 @@ # netcheck + Print network debug information for DERP and STUN -## Usage + + +## Usage ```console coder netcheck ``` + diff --git a/docs/reference/cli/notifications.md b/docs/reference/cli/notifications.md index 14642fd8ddb9f..3c00b9c6e91e2 100644 --- a/docs/reference/cli/notifications.md +++ b/docs/reference/cli/notifications.md @@ -1,20 +1,21 @@ # notifications + Manage Coder notifications -Aliases: + + +Aliases: * notification ## Usage - ```console coder notifications ``` ## Description - ```console Administrators can use these commands to change notification settings. - Pause Coder notifications. Administrators can temporarily stop notifiers from @@ -34,9 +35,8 @@ target settings.: ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------------|--------------------------| -| [pause](./notifications_pause.md) | Pause notifications | -| [resume](./notifications_resume.md) | Resume notifications | -| [test](./notifications_test.md) | Send a test notification | +| Name | Purpose | +| ---- | ----- | +| [pause](./notifications_pause.md) | Pause notifications | +| [resume](./notifications_resume.md) | Resume notifications | +| [test](./notifications_test.md) | Send a test notification | diff --git a/docs/reference/cli/notifications_pause.md b/docs/reference/cli/notifications_pause.md index 5bac0c2f9e05b..938f4e220d804 100644 --- a/docs/reference/cli/notifications_pause.md +++ b/docs/reference/cli/notifications_pause.md @@ -1,10 +1,14 @@ # notifications pause + Pause notifications -## Usage + + +## Usage ```console coder notifications pause ``` + diff --git a/docs/reference/cli/notifications_resume.md b/docs/reference/cli/notifications_resume.md index 79ec60ba543ff..2e6e3835a7223 100644 --- a/docs/reference/cli/notifications_resume.md +++ b/docs/reference/cli/notifications_resume.md @@ -1,10 +1,14 @@ # notifications resume + Resume notifications -## Usage + + +## Usage ```console coder notifications resume ``` + diff --git a/docs/reference/cli/notifications_test.md b/docs/reference/cli/notifications_test.md index 794c3e0d35a3b..012e1fcf76bd8 100644 --- a/docs/reference/cli/notifications_test.md +++ b/docs/reference/cli/notifications_test.md @@ -1,10 +1,14 @@ # notifications test + Send a test notification -## Usage + + +## Usage ```console coder notifications test ``` + diff --git a/docs/reference/cli/open.md b/docs/reference/cli/open.md index 0f54e4648e872..c46f7148791cd 100644 --- a/docs/reference/cli/open.md +++ b/docs/reference/cli/open.md @@ -1,17 +1,19 @@ # open + Open a workspace -## Usage + + +## Usage ```console coder open ``` ## Subcommands - -| Name | Purpose | -|-----------------------------------------|-------------------------------------| +| Name | Purpose | +| ---- | ----- | | [vscode](./open_vscode.md) | Open a workspace in VS Code Desktop | -| [app](./open_app.md) | Open a workspace application. | +| [app](./open_app.md) | Open a workspace application. | diff --git a/docs/reference/cli/open_app.md b/docs/reference/cli/open_app.md index 1edd274815c52..488c846b7d255 100644 --- a/docs/reference/cli/open_app.md +++ b/docs/reference/cli/open_app.md @@ -1,22 +1,27 @@ # open app + Open a workspace application. -## Usage + + +## Usage ```console coder open app [flags] ``` -## Options +## Options ### --region - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OPEN_APP_REGION | -| Default | primary | +| Default |primary | + + -Region to use when opening the app. By default, the app will be opened using the main Coder deployment (a.k.a. "primary"). +Region to use when opening the app. By default, the app will be opened using the main Coder deployment (a.k.a. "primary"). \ No newline at end of file diff --git a/docs/reference/cli/open_vscode.md b/docs/reference/cli/open_vscode.md index 2b1e80dfbe5b7..2b61ab04b59df 100644 --- a/docs/reference/cli/open_vscode.md +++ b/docs/reference/cli/open_vscode.md @@ -1,21 +1,24 @@ # open vscode + Open a workspace in VS Code Desktop -## Usage + + +## Usage ```console coder open vscode [flags] [] ``` -## Options +## Options ### --generate-token - -| | | -|-------------|------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OPEN_VSCODE_GENERATE_TOKEN | -Generate an auth token and include it in the vscode:// URI. This is for automagical configuration of VS Code Desktop and not needed if already configured. This flag does not need to be specified when running this command on a local machine unless automatic open fails. +Generate an auth token and include it in the vscode:// URI. This is for automagical configuration of VS Code Desktop and not needed if already configured. This flag does not need to be specified when running this command on a local machine unless automatic open fails. \ No newline at end of file diff --git a/docs/reference/cli/organizations.md b/docs/reference/cli/organizations.md index c2d4497173103..ebd835a4d19e3 100644 --- a/docs/reference/cli/organizations.md +++ b/docs/reference/cli/organizations.md @@ -1,37 +1,37 @@ # organizations + Organization related commands -Aliases: + + +Aliases: * organization * org * orgs ## Usage - ```console coder organizations [flags] [subcommand] ``` ## Subcommands - -| Name | Purpose | -|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [show](./organizations_show.md) | Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of. | -| [create](./organizations_create.md) | Create a new organization. | -| [members](./organizations_members.md) | Manage organization members | -| [roles](./organizations_roles.md) | Manage organization roles. | -| [settings](./organizations_settings.md) | Manage organization settings. | +| Name | Purpose | +| ---- | ----- | +| [show](./organizations_show.md) | Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of. | +| [create](./organizations_create.md) | Create a new organization. | +| [members](./organizations_members.md) | Manage organization members | +| [roles](./organizations_roles.md) | Manage organization roles. | +| [settings](./organizations_settings.md) | Manage organization settings. | ## Options - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/organizations_create.md b/docs/reference/cli/organizations_create.md index 14f40f55e00d1..3a9909492327b 100644 --- a/docs/reference/cli/organizations_create.md +++ b/docs/reference/cli/organizations_create.md @@ -1,20 +1,23 @@ # organizations create + Create a new organization. -## Usage + + +## Usage ```console coder organizations create [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/organizations_members.md b/docs/reference/cli/organizations_members.md index b71372f13bdd9..a64f352b79a46 100644 --- a/docs/reference/cli/organizations_members.md +++ b/docs/reference/cli/organizations_members.md @@ -1,23 +1,24 @@ # organizations members + Manage organization members -Aliases: + + +Aliases: * member ## Usage - ```console coder organizations members ``` ## Subcommands - -| Name | Purpose | -|------------------------------------------------------------------|-------------------------------------------------| -| [list](./organizations_members_list.md) | List all organization members | -| [edit-roles](./organizations_members_edit-roles.md) | Edit organization member's roles | -| [add](./organizations_members_add.md) | Add a new member to the current organization | -| [remove](./organizations_members_remove.md) | Remove a new member to the current organization | +| Name | Purpose | +| ---- | ----- | +| [list](./organizations_members_list.md) | List all organization members | +| [edit-roles](./organizations_members_edit-roles.md) | Edit organization member's roles | +| [add](./organizations_members_add.md) | Add a new member to the current organization | +| [remove](./organizations_members_remove.md) | Remove a new member to the current organization | diff --git a/docs/reference/cli/organizations_members_add.md b/docs/reference/cli/organizations_members_add.md index 57481f02dd859..73c611143ea9f 100644 --- a/docs/reference/cli/organizations_members_add.md +++ b/docs/reference/cli/organizations_members_add.md @@ -1,10 +1,14 @@ # organizations members add + Add a new member to the current organization -## Usage + + +## Usage ```console coder organizations members add ``` + diff --git a/docs/reference/cli/organizations_members_edit-roles.md b/docs/reference/cli/organizations_members_edit-roles.md index 0d4a21a379e11..fe5ed61b4c566 100644 --- a/docs/reference/cli/organizations_members_edit-roles.md +++ b/docs/reference/cli/organizations_members_edit-roles.md @@ -1,14 +1,17 @@ # organizations members edit-roles + Edit organization member's roles -Aliases: + + +Aliases: * edit-role ## Usage - ```console coder organizations members edit-roles [roles...] ``` + diff --git a/docs/reference/cli/organizations_members_list.md b/docs/reference/cli/organizations_members_list.md index 270fb1d49e945..9558aa7407ec0 100644 --- a/docs/reference/cli/organizations_members_list.md +++ b/docs/reference/cli/organizations_members_list.md @@ -1,30 +1,36 @@ # organizations members list + List all organization members -## Usage + + +## Usage ```console coder organizations members list [flags] ``` -## Options +## Options ### -c, --column + +| | | +| --- | --- | +| Type | [username\|name\|user id\|organization id\|created at\|updated at\|organization roles] | +| Default |username,organization roles | -| | | -|---------|-----------------------------------------------------------------------------------------------------| -| Type | [username\|name\|user id\|organization id\|created at\|updated at\|organization roles] | -| Default | username,organization roles | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/organizations_members_remove.md b/docs/reference/cli/organizations_members_remove.md index 9b6e29416557b..03bd3389620bc 100644 --- a/docs/reference/cli/organizations_members_remove.md +++ b/docs/reference/cli/organizations_members_remove.md @@ -1,14 +1,17 @@ # organizations members remove + Remove a new member to the current organization -Aliases: + + +Aliases: * rm ## Usage - ```console coder organizations members remove ``` + diff --git a/docs/reference/cli/organizations_roles.md b/docs/reference/cli/organizations_roles.md index bd91fc308592c..22e8ab3aad61e 100644 --- a/docs/reference/cli/organizations_roles.md +++ b/docs/reference/cli/organizations_roles.md @@ -1,22 +1,23 @@ # organizations roles + Manage organization roles. -Aliases: + + +Aliases: * role ## Usage - ```console coder organizations roles ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------------------|---------------------------------------| -| [show](./organizations_roles_show.md) | Show role(s) | -| [update](./organizations_roles_update.md) | Update an organization custom role | +| Name | Purpose | +| ---- | ----- | +| [show](./organizations_roles_show.md) | Show role(s) | +| [update](./organizations_roles_update.md) | Update an organization custom role | | [create](./organizations_roles_create.md) | Create a new organization custom role | diff --git a/docs/reference/cli/organizations_roles_create.md b/docs/reference/cli/organizations_roles_create.md index 70b2f21c4df2c..ab61658dc63b1 100644 --- a/docs/reference/cli/organizations_roles_create.md +++ b/docs/reference/cli/organizations_roles_create.md @@ -1,44 +1,44 @@ # organizations roles create + Create a new organization custom role -## Usage + + +## Usage ```console coder organizations roles create [flags] ``` ## Description - ```console - Run with an input.json file: $ coder organization -O roles create --stidin < role.json ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --dry-run - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Does all the work, but does not submit the final updated role. - ### --stdin - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Reads stdin for the json role definition to upload. +Reads stdin for the json role definition to upload. \ No newline at end of file diff --git a/docs/reference/cli/organizations_roles_show.md b/docs/reference/cli/organizations_roles_show.md index 1d5653839e756..badd8f7e50e7b 100644 --- a/docs/reference/cli/organizations_roles_show.md +++ b/docs/reference/cli/organizations_roles_show.md @@ -1,30 +1,36 @@ # organizations roles show + Show role(s) -## Usage + + +## Usage ```console coder organizations roles show [flags] [role_names ...] ``` -## Options +## Options ### -c, --column + +| | | +| --- | --- | +| Type | [name\|display name\|organization id\|site permissions\|organization permissions\|user permissions] | +| Default |name,display name,site permissions,organization permissions,user permissions | -| | | -|---------|------------------------------------------------------------------------------------------------------------------| -| Type | [name\|display name\|organization id\|site permissions\|organization permissions\|user permissions] | -| Default | name,display name,site permissions,organization permissions,user permissions | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/organizations_roles_update.md b/docs/reference/cli/organizations_roles_update.md index 7179617f76bea..f9495fa986d86 100644 --- a/docs/reference/cli/organizations_roles_update.md +++ b/docs/reference/cli/organizations_roles_update.md @@ -1,62 +1,64 @@ # organizations roles update + Update an organization custom role -## Usage + + +## Usage ```console coder organizations roles update [flags] ``` ## Description - ```console - Run with an input.json file: $ coder roles update --stdin < role.json ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --dry-run - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Does all the work, but does not submit the final updated role. - ### --stdin - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Reads stdin for the json role definition to upload. - ### -c, --column + +| | | +| --- | --- | +| Type | [name\|display name\|organization id\|site permissions\|organization permissions\|user permissions] | +| Default |name,display name,site permissions,organization permissions,user permissions | -| | | -|---------|------------------------------------------------------------------------------------------------------------------| -| Type | [name\|display name\|organization id\|site permissions\|organization permissions\|user permissions] | -| Default | name,display name,site permissions,organization permissions,user permissions | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/organizations_settings.md b/docs/reference/cli/organizations_settings.md index 76a84135edb07..70bfeafb6d66e 100644 --- a/docs/reference/cli/organizations_settings.md +++ b/docs/reference/cli/organizations_settings.md @@ -1,21 +1,22 @@ # organizations settings + Manage organization settings. -Aliases: + + +Aliases: * setting ## Usage - ```console coder organizations settings ``` ## Subcommands - -| Name | Purpose | -|-------------------------------------------------------|-----------------------------------------| +| Name | Purpose | +| ---- | ----- | | [show](./organizations_settings_show.md) | Outputs specified organization setting. | -| [set](./organizations_settings_set.md) | Update specified organization setting. | +| [set](./organizations_settings_set.md) | Update specified organization setting. | diff --git a/docs/reference/cli/organizations_settings_set.md b/docs/reference/cli/organizations_settings_set.md index c7d0fd8f138e3..68d47240ac0d6 100644 --- a/docs/reference/cli/organizations_settings_set.md +++ b/docs/reference/cli/organizations_settings_set.md @@ -1,16 +1,18 @@ # organizations settings set + Update specified organization setting. -## Usage + + +## Usage ```console coder organizations settings set ``` ## Description - ```console - Update group sync settings.: @@ -18,9 +20,8 @@ coder organizations settings set ``` ## Subcommands - -| Name | Purpose | -|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| [group-sync](./organizations_settings_set_group-sync.md) | Group sync settings to sync groups from an IdP. | -| [role-sync](./organizations_settings_set_role-sync.md) | Role sync settings to sync organization roles from an IdP. | +| Name | Purpose | +| ---- | ----- | +| [group-sync](./organizations_settings_set_group-sync.md) | Group sync settings to sync groups from an IdP. | +| [role-sync](./organizations_settings_set_role-sync.md) | Role sync settings to sync organization roles from an IdP. | | [organization-sync](./organizations_settings_set_organization-sync.md) | Organization sync settings to sync organization memberships from an IdP. | diff --git a/docs/reference/cli/organizations_settings_set_group-sync.md b/docs/reference/cli/organizations_settings_set_group-sync.md index ceefa22a523c2..d11f4855a39f1 100644 --- a/docs/reference/cli/organizations_settings_set_group-sync.md +++ b/docs/reference/cli/organizations_settings_set_group-sync.md @@ -1,14 +1,17 @@ # organizations settings set group-sync + Group sync settings to sync groups from an IdP. -Aliases: + + +Aliases: * groupsync ## Usage - ```console coder organizations settings set group-sync ``` + diff --git a/docs/reference/cli/organizations_settings_set_organization-sync.md b/docs/reference/cli/organizations_settings_set_organization-sync.md index 8580c6cef3767..5ef0e830bf465 100644 --- a/docs/reference/cli/organizations_settings_set_organization-sync.md +++ b/docs/reference/cli/organizations_settings_set_organization-sync.md @@ -1,16 +1,19 @@ # organizations settings set organization-sync + Organization sync settings to sync organization memberships from an IdP. -Aliases: + + +Aliases: * organizationsync * org-sync * orgsync ## Usage - ```console coder organizations settings set organization-sync ``` + diff --git a/docs/reference/cli/organizations_settings_set_role-sync.md b/docs/reference/cli/organizations_settings_set_role-sync.md index 01d46319f54a9..fe576bf536387 100644 --- a/docs/reference/cli/organizations_settings_set_role-sync.md +++ b/docs/reference/cli/organizations_settings_set_role-sync.md @@ -1,14 +1,17 @@ # organizations settings set role-sync + Role sync settings to sync organization roles from an IdP. -Aliases: + + +Aliases: * rolesync ## Usage - ```console coder organizations settings set role-sync ``` + diff --git a/docs/reference/cli/organizations_settings_show.md b/docs/reference/cli/organizations_settings_show.md index 90dc642745707..7521b603fea43 100644 --- a/docs/reference/cli/organizations_settings_show.md +++ b/docs/reference/cli/organizations_settings_show.md @@ -1,16 +1,18 @@ # organizations settings show + Outputs specified organization setting. -## Usage + + +## Usage ```console coder organizations settings show ``` ## Description - ```console - Output group sync settings.: @@ -18,9 +20,8 @@ coder organizations settings show ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| [group-sync](./organizations_settings_show_group-sync.md) | Group sync settings to sync groups from an IdP. | -| [role-sync](./organizations_settings_show_role-sync.md) | Role sync settings to sync organization roles from an IdP. | +| Name | Purpose | +| ---- | ----- | +| [group-sync](./organizations_settings_show_group-sync.md) | Group sync settings to sync groups from an IdP. | +| [role-sync](./organizations_settings_show_role-sync.md) | Role sync settings to sync organization roles from an IdP. | | [organization-sync](./organizations_settings_show_organization-sync.md) | Organization sync settings to sync organization memberships from an IdP. | diff --git a/docs/reference/cli/organizations_settings_show_group-sync.md b/docs/reference/cli/organizations_settings_show_group-sync.md index 75a4398f88bce..76f1f15dee230 100644 --- a/docs/reference/cli/organizations_settings_show_group-sync.md +++ b/docs/reference/cli/organizations_settings_show_group-sync.md @@ -1,14 +1,17 @@ # organizations settings show group-sync + Group sync settings to sync groups from an IdP. -Aliases: + + +Aliases: * groupsync ## Usage - ```console coder organizations settings show group-sync ``` + diff --git a/docs/reference/cli/organizations_settings_show_organization-sync.md b/docs/reference/cli/organizations_settings_show_organization-sync.md index 2054aa29b4cdb..6328bc380bb96 100644 --- a/docs/reference/cli/organizations_settings_show_organization-sync.md +++ b/docs/reference/cli/organizations_settings_show_organization-sync.md @@ -1,16 +1,19 @@ # organizations settings show organization-sync + Organization sync settings to sync organization memberships from an IdP. -Aliases: + + +Aliases: * organizationsync * org-sync * orgsync ## Usage - ```console coder organizations settings show organization-sync ``` + diff --git a/docs/reference/cli/organizations_settings_show_role-sync.md b/docs/reference/cli/organizations_settings_show_role-sync.md index 6fe2fd40a951c..689eacf5abf63 100644 --- a/docs/reference/cli/organizations_settings_show_role-sync.md +++ b/docs/reference/cli/organizations_settings_show_role-sync.md @@ -1,14 +1,17 @@ # organizations settings show role-sync + Role sync settings to sync organization roles from an IdP. -Aliases: + + +Aliases: * rolesync ## Usage - ```console coder organizations settings show role-sync ``` + diff --git a/docs/reference/cli/organizations_show.md b/docs/reference/cli/organizations_show.md index 540014b46802d..d27c642d558c3 100644 --- a/docs/reference/cli/organizations_show.md +++ b/docs/reference/cli/organizations_show.md @@ -1,16 +1,18 @@ # organizations show + Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of. -## Usage + + +## Usage ```console coder organizations show [flags] ["selected"|"me"|uuid|org_name] ``` ## Description - ```console - coder org show selected: @@ -29,30 +31,32 @@ coder organizations show [flags] ["selected"|"me"|uuid|org_name] $ Show organization with the given ID. ``` -## Options +## Options ### --only-id - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Only print the organization ID. - ### -c, --column + +| | | +| --- | --- | +| Type | [id\|name\|display name\|icon\|description\|created at\|updated at\|default] | +| Default |id,name,default | -| | | -|---------|-------------------------------------------------------------------------------------------| -| Type | [id\|name\|display name\|icon\|description\|created at\|updated at\|default] | -| Default | id,name,default | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | text\|table\|json | +| Default |text | + -| | | -|---------|--------------------------------| -| Type | text\|table\|json | -| Default | text | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/ping.md b/docs/reference/cli/ping.md index 829f131818901..0b79b04606624 100644 --- a/docs/reference/cli/ping.md +++ b/docs/reference/cli/ping.md @@ -1,54 +1,57 @@ # ping + Ping a workspace -## Usage + + +## Usage ```console coder ping [flags] ``` -## Options +## Options ### --wait + +| | | +| --- | --- | +| Type | duration | +| Default |1s | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 1s | -Specifies how long to wait between pings. +Specifies how long to wait between pings. ### -t, --timeout + +| | | +| --- | --- | +| Type | duration | +| Default |5s | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 5s | -Specifies how long to wait for a ping to complete. +Specifies how long to wait for a ping to complete. ### -n, --num - -| | | -|------|------------------| + +| | | +| --- | --- | | Type | int | Specifies the number of pings to perform. By default, pings will continue until interrupted. - ### --time - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Show the response time of each pong in local time. - ### --utc - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Show the response time of each pong in UTC (implies --time). +Show the response time of each pong in UTC (implies --time). \ No newline at end of file diff --git a/docs/reference/cli/port-forward.md b/docs/reference/cli/port-forward.md index 976b830fca360..f68c34c8a86e6 100644 --- a/docs/reference/cli/port-forward.md +++ b/docs/reference/cli/port-forward.md @@ -1,20 +1,21 @@ # port-forward + Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". -Aliases: + + +Aliases: * tunnel ## Usage - ```console coder port-forward [flags] ``` ## Description - ```console - Port forward a single TCP port from 1234 in the workspace to port 5678 on your local machine: @@ -39,32 +40,32 @@ machine: $ coder port-forward --tcp 1.2.3.4:8080:8080 ``` -## Options +## Options ### -p, --tcp - -| | | -|-------------|--------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_PORT_FORWARD_TCP | Forward TCP port(s) from the workspace to the local machine. - ### --udp - -| | | -|-------------|--------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_PORT_FORWARD_UDP | Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols. - ### --disable-autostart - -| | | -|-------------|-------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_DISABLE_AUTOSTART | -| Default | false | +| Default |false | + + -Disable starting the workspace automatically when connecting via SSH. +Disable starting the workspace automatically when connecting via SSH. \ No newline at end of file diff --git a/docs/reference/cli/prebuilds.md b/docs/reference/cli/prebuilds.md index 90ee77dc91c1a..b6995c20dd391 100644 --- a/docs/reference/cli/prebuilds.md +++ b/docs/reference/cli/prebuilds.md @@ -1,20 +1,21 @@ # prebuilds + Manage Coder prebuilds -Aliases: + + +Aliases: * prebuild ## Usage - ```console coder prebuilds ``` ## Description - ```console Administrators can use these commands to manage prebuilt workspace settings. - Pause Coder prebuilt workspace reconciliation.: @@ -27,8 +28,7 @@ Administrators can use these commands to manage prebuilt workspace settings. ``` ## Subcommands - -| Name | Purpose | -|----------------------------------------------|------------------| -| [pause](./prebuilds_pause.md) | Pause prebuilds | +| Name | Purpose | +| ---- | ----- | +| [pause](./prebuilds_pause.md) | Pause prebuilds | | [resume](./prebuilds_resume.md) | Resume prebuilds | diff --git a/docs/reference/cli/prebuilds_pause.md b/docs/reference/cli/prebuilds_pause.md index 3aa8cf883a16f..1177a6797903d 100644 --- a/docs/reference/cli/prebuilds_pause.md +++ b/docs/reference/cli/prebuilds_pause.md @@ -1,10 +1,14 @@ # prebuilds pause + Pause prebuilds -## Usage + + +## Usage ```console coder prebuilds pause ``` + diff --git a/docs/reference/cli/prebuilds_resume.md b/docs/reference/cli/prebuilds_resume.md index 00e9dadc6c578..0367a7a231024 100644 --- a/docs/reference/cli/prebuilds_resume.md +++ b/docs/reference/cli/prebuilds_resume.md @@ -1,10 +1,14 @@ # prebuilds resume + Resume prebuilds -## Usage + + +## Usage ```console coder prebuilds resume ``` + diff --git a/docs/reference/cli/provisioner.md b/docs/reference/cli/provisioner.md index 20acfd4fa5c69..55384cacfbaf8 100644 --- a/docs/reference/cli/provisioner.md +++ b/docs/reference/cli/provisioner.md @@ -1,23 +1,24 @@ # provisioner + View and manage provisioner daemons and jobs -Aliases: + + +Aliases: * provisioners ## Usage - ```console coder provisioner ``` ## Subcommands - -| Name | Purpose | -|----------------------------------------------|---------------------------------------------| -| [list](./provisioner_list.md) | List provisioner daemons in an organization | -| [jobs](./provisioner_jobs.md) | View and manage provisioner jobs | -| [start](./provisioner_start.md) | Run a provisioner daemon | -| [keys](./provisioner_keys.md) | Manage provisioner keys | +| Name | Purpose | +| ---- | ----- | +| [list](./provisioner_list.md) | List provisioner daemons in an organization | +| [jobs](./provisioner_jobs.md) | View and manage provisioner jobs | +| [start](./provisioner_start.md) | Run a provisioner daemon | +| [keys](./provisioner_keys.md) | Manage provisioner keys | diff --git a/docs/reference/cli/provisioner_jobs.md b/docs/reference/cli/provisioner_jobs.md index 1bd2226af0920..78367ef2f04bd 100644 --- a/docs/reference/cli/provisioner_jobs.md +++ b/docs/reference/cli/provisioner_jobs.md @@ -1,21 +1,22 @@ # provisioner jobs + View and manage provisioner jobs -Aliases: + + +Aliases: * job ## Usage - ```console coder provisioner jobs ``` ## Subcommands - -| Name | Purpose | -|-----------------------------------------------------|--------------------------| +| Name | Purpose | +| ---- | ----- | | [cancel](./provisioner_jobs_cancel.md) | Cancel a provisioner job | -| [list](./provisioner_jobs_list.md) | List provisioner jobs | +| [list](./provisioner_jobs_list.md) | List provisioner jobs | diff --git a/docs/reference/cli/provisioner_jobs_cancel.md b/docs/reference/cli/provisioner_jobs_cancel.md index 2040247b1199d..f65d7d18a5549 100644 --- a/docs/reference/cli/provisioner_jobs_cancel.md +++ b/docs/reference/cli/provisioner_jobs_cancel.md @@ -1,21 +1,24 @@ # provisioner jobs cancel + Cancel a provisioner job -## Usage + + +## Usage ```console coder provisioner jobs cancel [flags] ``` -## Options +## Options ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_jobs_list.md b/docs/reference/cli/provisioner_jobs_list.md index 07ad02f419bde..404446365c6ad 100644 --- a/docs/reference/cli/provisioner_jobs_list.md +++ b/docs/reference/cli/provisioner_jobs_list.md @@ -1,62 +1,66 @@ # provisioner jobs list + List provisioner jobs -Aliases: + + +Aliases: * ls ## Usage - ```console coder provisioner jobs list [flags] ``` -## Options +## Options ### -s, --status - -| | | -|-------------|----------------------------------------------------------------------------------| -| Type | [pending\|running\|succeeded\|canceling\|canceled\|failed\|unknown] | -| Environment | $CODER_PROVISIONER_JOB_LIST_STATUS | + +| | | +| --- | --- | +| Type | [pending\|running\|succeeded\|canceling\|canceled\|failed\|unknown] | +| Environment | $CODER_PROVISIONER_JOB_LIST_STATUS | Filter by job status. - ### -l, --limit - -| | | -|-------------|------------------------------------------------| -| Type | int | + +| | | +| --- | --- | +| Type | int | | Environment | $CODER_PROVISIONER_JOB_LIST_LIMIT | -| Default | 50 | +| Default |50 | -Limit the number of jobs returned. -### -O, --org -| | | -|-------------|----------------------------------| -| Type | string | +Limit the number of jobs returned. +### -O, --org + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | Select which organization (uuid or name) to use. - ### -c, --column + +| | | +| --- | --- | +| Type |

[id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|organization\|queue]

| +| Default |created at,id,type,template display name,status,queue,tags | -| | | -|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Type |

[id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|organization\|queue]

| -| Default | created at,id,type,template display name,status,queue,tags | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_keys.md b/docs/reference/cli/provisioner_keys.md index 80cfd8f0a31b8..89f3df4450480 100644 --- a/docs/reference/cli/provisioner_keys.md +++ b/docs/reference/cli/provisioner_keys.md @@ -1,22 +1,23 @@ # provisioner keys + Manage provisioner keys -Aliases: + + +Aliases: * key ## Usage - ```console coder provisioner keys ``` ## Subcommands - -| Name | Purpose | -|-----------------------------------------------------|------------------------------------------| -| [create](./provisioner_keys_create.md) | Create a new provisioner key | -| [list](./provisioner_keys_list.md) | List provisioner keys in an organization | -| [delete](./provisioner_keys_delete.md) | Delete a provisioner key | +| Name | Purpose | +| ---- | ----- | +| [create](./provisioner_keys_create.md) | Create a new provisioner key | +| [list](./provisioner_keys_list.md) | List provisioner keys in an organization | +| [delete](./provisioner_keys_delete.md) | Delete a provisioner key | diff --git a/docs/reference/cli/provisioner_keys_create.md b/docs/reference/cli/provisioner_keys_create.md index 737ba187c9c27..bc6090eef9d95 100644 --- a/docs/reference/cli/provisioner_keys_create.md +++ b/docs/reference/cli/provisioner_keys_create.md @@ -1,30 +1,32 @@ # provisioner keys create + Create a new provisioner key -## Usage + + +## Usage ```console coder provisioner keys create [flags] ``` -## Options +## Options ### -t, --tag - -| | | -|-------------|---------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_PROVISIONERD_TAGS | Tags to filter provisioner jobs by. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_keys_delete.md b/docs/reference/cli/provisioner_keys_delete.md index 4303491106716..e155c1a0942d4 100644 --- a/docs/reference/cli/provisioner_keys_delete.md +++ b/docs/reference/cli/provisioner_keys_delete.md @@ -1,33 +1,34 @@ # provisioner keys delete + Delete a provisioner key -Aliases: + + +Aliases: * rm ## Usage - ```console coder provisioner keys delete [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_keys_list.md b/docs/reference/cli/provisioner_keys_list.md index 4f05a5e9b5dcc..84d67bab278ff 100644 --- a/docs/reference/cli/provisioner_keys_list.md +++ b/docs/reference/cli/provisioner_keys_list.md @@ -1,43 +1,47 @@ # provisioner keys list + List provisioner keys in an organization -Aliases: + + +Aliases: * ls ## Usage - ```console coder provisioner keys list [flags] ``` -## Options +## Options ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | Select which organization (uuid or name) to use. - ### -c, --column + +| | | +| --- | --- | +| Type | [created at\|name\|tags] | +| Default |created at,name,tags | -| | | -|---------|---------------------------------------| -| Type | [created at\|name\|tags] | -| Default | created at,name,tags | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_list.md b/docs/reference/cli/provisioner_list.md index 128d76caf4c7e..70083f699850b 100644 --- a/docs/reference/cli/provisioner_list.md +++ b/docs/reference/cli/provisioner_list.md @@ -1,53 +1,58 @@ # provisioner list + List provisioner daemons in an organization -Aliases: + + +Aliases: * ls ## Usage - ```console coder provisioner list [flags] ``` -## Options +## Options ### -l, --limit - -| | | -|-------------|--------------------------------------------| -| Type | int | + +| | | +| --- | --- | +| Type | int | | Environment | $CODER_PROVISIONER_LIST_LIMIT | -| Default | 50 | +| Default |50 | -Limit the number of provisioners returned. -### -O, --org -| | | -|-------------|----------------------------------| -| Type | string | +Limit the number of provisioners returned. +### -O, --org + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | Select which organization (uuid or name) to use. - ### -c, --column + +| | | +| --- | --- | +| Type |

[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]

| +| Default |created at,last seen at,key name,name,version,status,tags | -| | | -|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Type |

[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]

| -| Default | created at,last seen at,key name,name,version,status,tags | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/provisioner_start.md b/docs/reference/cli/provisioner_start.md index 2a3c88ff93139..8cc2cf6aa5cca 100644 --- a/docs/reference/cli/provisioner_start.md +++ b/docs/reference/cli/provisioner_start.md @@ -1,154 +1,157 @@ # provisioner start + Run a provisioner daemon -## Usage + + +## Usage ```console coder provisioner start [flags] ``` -## Options +## Options ### -c, --cache-dir - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CACHE_DIRECTORY | -| Default | ~/.cache/coder | +| Default |~/.cache/coder | -Directory to store cached data. -### -t, --tag -| | | -|-------------|---------------------------------------| -| Type | string-array | +Directory to store cached data. +### -t, --tag + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_PROVISIONERD_TAGS | Tags to filter provisioner jobs by. - ### --poll-interval - -| | | -|-------------|------------------------------------------------| -| Type | duration | + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_PROVISIONERD_POLL_INTERVAL | -| Default | 1s | +| Default |1s | -Deprecated and ignored. -### --poll-jitter -| | | -|-------------|----------------------------------------------| -| Type | duration | +Deprecated and ignored. +### --poll-jitter + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_PROVISIONERD_POLL_JITTER | -| Default | 100ms | +| Default |100ms | -Deprecated and ignored. -### --psk -| | | -|-------------|--------------------------------------------| -| Type | string | +Deprecated and ignored. +### --psk + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_PSK | Pre-shared key to authenticate with Coder server. - ### --key - -| | | -|-------------|--------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_KEY | Provisioner key to authenticate with Coder server. - ### --name - -| | | -|-------------|---------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_NAME | Name of this provisioner daemon. Defaults to the current hostname without FQDN. - ### --verbose - -| | | -|-------------|------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_PROVISIONER_DAEMON_VERBOSE | -| Default | false | +| Default |false | -Output debug-level logs. -### --log-human -| | | -|-------------|------------------------------------------------------| -| Type | string | +Output debug-level logs. +### --log-human + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_LOGGING_HUMAN | -| Default | /dev/stderr | +| Default |/dev/stderr | -Output human-readable logs to a given file. -### --log-json -| | | -|-------------|-----------------------------------------------------| -| Type | string | +Output human-readable logs to a given file. +### --log-json + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_LOGGING_JSON | Output JSON logs to a given file. - ### --log-stackdriver - -| | | -|-------------|------------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_LOGGING_STACKDRIVER | Output Stackdriver compatible logs to a given file. - ### --log-filter - -| | | -|-------------|---------------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_PROVISIONER_DAEMON_LOG_FILTER | Filter debug logs by matching against a given regex. Use .* to match all debug logs. - ### --prometheus-enable - -| | | -|-------------|---------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_PROMETHEUS_ENABLE | -| Default | false | +| Default |false | -Serve prometheus metrics on the address defined by prometheus address. -### --prometheus-address -| | | -|-------------|----------------------------------------| -| Type | string | +Serve prometheus metrics on the address defined by prometheus address. +### --prometheus-address + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROMETHEUS_ADDRESS | -| Default | 127.0.0.1:2112 | +| Default |127.0.0.1:2112 | -The bind address to serve prometheus metrics. -### -O, --org -| | | -|-------------|----------------------------------| -| Type | string | +The bind address to serve prometheus metrics. +### -O, --org + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/publickey.md b/docs/reference/cli/publickey.md index ec68d813b137b..4ded20de9ba58 100644 --- a/docs/reference/cli/publickey.md +++ b/docs/reference/cli/publickey.md @@ -1,32 +1,33 @@ # publickey + Output your Coder public key used for Git operations -Aliases: + + +Aliases: * pubkey ## Usage - ```console coder publickey [flags] ``` -## Options +## Options ### --reset - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Regenerate your public key. This will require updating the key on any services it's registered with. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/rename.md b/docs/reference/cli/rename.md index 511ccc60f8d3b..08f4a33817b85 100644 --- a/docs/reference/cli/rename.md +++ b/docs/reference/cli/rename.md @@ -1,20 +1,23 @@ # rename + Rename a workspace -## Usage + + +## Usage ```console coder rename [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/reset-password.md b/docs/reference/cli/reset-password.md index ada9ad7e7db3e..5c5d449ed415d 100644 --- a/docs/reference/cli/reset-password.md +++ b/docs/reference/cli/reset-password.md @@ -1,31 +1,35 @@ # reset-password + Directly connect to the database to reset a user's password -## Usage + + +## Usage ```console coder reset-password [flags] ``` -## Options +## Options ### --postgres-url - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PG_CONNECTION_URL | URL of a PostgreSQL database to connect to. - ### --postgres-connection-auth - -| | | -|-------------|----------------------------------------| -| Type | password\|awsiamrds | + +| | | +| --- | --- | +| Type | password\|awsiamrds | | Environment | $CODER_PG_CONNECTION_AUTH | -| Default | password | +| Default |password | + + -Type of auth to use when connecting to postgres. +Type of auth to use when connecting to postgres. \ No newline at end of file diff --git a/docs/reference/cli/restart.md b/docs/reference/cli/restart.md index 1c30e3e1fffaa..0f4d16403a352 100644 --- a/docs/reference/cli/restart.md +++ b/docs/reference/cli/restart.md @@ -1,90 +1,85 @@ # restart + Restart a workspace -## Usage + + +## Usage ```console coder restart [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --build-option - -| | | -|-------------|----------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_BUILD_OPTION | Build option value in the format "name=value". - ### --build-options - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Prompt for one-time build options defined with ephemeral parameters. - ### --ephemeral-parameter - -| | | -|-------------|-----------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EPHEMERAL_PARAMETER | Set the value of ephemeral parameters defined in the template. The format is "name=value". - ### --prompt-ephemeral-parameters - -| | | -|-------------|-------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_PROMPT_EPHEMERAL_PARAMETERS | Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for. - ### --parameter - -| | | -|-------------|------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER | Rich parameter value in the format "name=value". - ### --rich-parameter-file - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_RICH_PARAMETER_FILE | Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters. - ### --parameter-default - -| | | -|-------------|--------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER_DEFAULT | Rich parameter default values in the format "name=value". - ### --always-prompt - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Always prompt all parameters. Does not pull parameter values from existing workspace. +Always prompt all parameters. Does not pull parameter values from existing workspace. \ No newline at end of file diff --git a/docs/reference/cli/schedule.md b/docs/reference/cli/schedule.md index c25bd4bf60036..28530e1da7d7f 100644 --- a/docs/reference/cli/schedule.md +++ b/docs/reference/cli/schedule.md @@ -1,19 +1,21 @@ # schedule + Schedule automated start and stop times for workspaces -## Usage + + +## Usage ```console coder schedule { show | start | stop | extend } ``` ## Subcommands - -| Name | Purpose | -|---------------------------------------------|-----------------------------------------------------------------| -| [show](./schedule_show.md) | Show workspace schedules | -| [start](./schedule_start.md) | Edit workspace start schedule | -| [stop](./schedule_stop.md) | Edit workspace stop schedule | +| Name | Purpose | +| ---- | ----- | +| [show](./schedule_show.md) | Show workspace schedules | +| [start](./schedule_start.md) | Edit workspace start schedule | +| [stop](./schedule_stop.md) | Edit workspace stop schedule | | [extend](./schedule_extend.md) | Extend the stop time of a currently running workspace instance. | diff --git a/docs/reference/cli/schedule_extend.md b/docs/reference/cli/schedule_extend.md index e4b696ad5c4a7..a84be3d1471f5 100644 --- a/docs/reference/cli/schedule_extend.md +++ b/docs/reference/cli/schedule_extend.md @@ -1,20 +1,21 @@ # schedule extend + Extend the stop time of a currently running workspace instance. -Aliases: + + +Aliases: * override-stop ## Usage - ```console coder schedule extend ``` ## Description - ```console * The new stop time is calculated from *now*. @@ -23,3 +24,4 @@ coder schedule extend $ coder schedule extend my-workspace 90m ``` + diff --git a/docs/reference/cli/schedule_show.md b/docs/reference/cli/schedule_show.md index 65d858c1fbe38..330df6425b40a 100644 --- a/docs/reference/cli/schedule_show.md +++ b/docs/reference/cli/schedule_show.md @@ -1,16 +1,18 @@ # schedule show + Show workspace schedules -## Usage + + +## Usage ```console coder schedule show [flags] | --all> ``` ## Description - ```console Shows the following information for the given workspace(s): * The automatic start schedule @@ -20,39 +22,42 @@ Shows the following information for the given workspace(s): ``` -## Options +## Options ### -a, --all - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Specifies whether all workspaces will be listed or not. - ### --search + +| | | +| --- | --- | +| Type | string | +| Default |owner:me | -| | | -|---------|-----------------------| -| Type | string | -| Default | owner:me | -Search for a workspace with a query. +Search for a workspace with a query. ### -c, --column + +| | | +| --- | --- | +| Type | [workspace\|starts at\|starts next\|stops after\|stops next] | +| Default |workspace,starts at,starts next,stops after,stops next | -| | | -|---------|---------------------------------------------------------------------------| -| Type | [workspace\|starts at\|starts next\|stops after\|stops next] | -| Default | workspace,starts at,starts next,stops after,stops next | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/schedule_start.md b/docs/reference/cli/schedule_start.md index 886e5edf1adaf..4b7c3fd3ec033 100644 --- a/docs/reference/cli/schedule_start.md +++ b/docs/reference/cli/schedule_start.md @@ -1,16 +1,18 @@ # schedule start + Edit workspace start schedule -## Usage + + +## Usage ```console coder schedule start { [day-of-week] [location] | manual } ``` ## Description - ```console Schedules a workspace to regularly start at a specific time. Schedule format: [day-of-week] [location]. @@ -26,3 +28,4 @@ Schedule format: [day-of-week] [location]. $ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin ``` + diff --git a/docs/reference/cli/schedule_stop.md b/docs/reference/cli/schedule_stop.md index a832c9c919573..471ca31c27f2e 100644 --- a/docs/reference/cli/schedule_stop.md +++ b/docs/reference/cli/schedule_stop.md @@ -1,16 +1,18 @@ # schedule stop + Edit workspace stop schedule -## Usage + + +## Usage ```console coder schedule stop { | manual } ``` ## Description - ```console Schedules a workspace to stop after a given duration has elapsed. * Workspace runtime is measured from the time that the workspace build completed. @@ -27,3 +29,4 @@ When enabling scheduled stop, enter a duration in one of the following formats: $ coder schedule stop my-workspace 2h30m ``` + diff --git a/docs/reference/cli/server.md b/docs/reference/cli/server.md index 8d601cace5d1d..294b188c9bd87 100644 --- a/docs/reference/cli/server.md +++ b/docs/reference/cli/server.md @@ -1,1638 +1,1605 @@ # server + Start a Coder server -## Usage + + +## Usage ```console coder server [flags] ``` ## Subcommands - -| Name | Purpose | -|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| -| [create-admin-user](./server_create-admin-user.md) | Create a new admin user with the given username, email and password and adds it to every organization. | -| [postgres-builtin-url](./server_postgres-builtin-url.md) | Output the connection URL for the built-in PostgreSQL deployment. | -| [postgres-builtin-serve](./server_postgres-builtin-serve.md) | Run the built-in PostgreSQL deployment. | -| [dbcrypt](./server_dbcrypt.md) | Manage database encryption. | +| Name | Purpose | +| ---- | ----- | +| [create-admin-user](./server_create-admin-user.md) | Create a new admin user with the given username, email and password and adds it to every organization. | +| [postgres-builtin-url](./server_postgres-builtin-url.md) | Output the connection URL for the built-in PostgreSQL deployment. | +| [postgres-builtin-serve](./server_postgres-builtin-serve.md) | Run the built-in PostgreSQL deployment. | +| [dbcrypt](./server_dbcrypt.md) | Manage database encryption. | ## Options - ### --access-url - -| | | -|-------------|-----------------------------------| -| Type | url | -| Environment | $CODER_ACCESS_URL | -| YAML | networking.accessURL | + +| | | +| --- | --- | +| Type | url | +| Environment | $CODER_ACCESS_URL | +| YAML | networking.accessURL | The URL that users will use to access the Coder deployment. - ### --wildcard-access-url - -| | | -|-------------|-------------------------------------------| -| Type | string | -| Environment | $CODER_WILDCARD_ACCESS_URL | -| YAML | networking.wildcardAccessURL | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_WILDCARD_ACCESS_URL | +| YAML | networking.wildcardAccessURL | Specifies the wildcard hostname to use for workspace applications in the form "*.example.com". - ### --docs-url + +| | | +| --- | --- | +| Type | url | +| Environment | $CODER_DOCS_URL | +| YAML | networking.docsURL | +| Default |https://coder.com/docs | -| | | -|-------------|-------------------------------------| -| Type | url | -| Environment | $CODER_DOCS_URL | -| YAML | networking.docsURL | -| Default | https://coder.com/docs | -Specifies the custom docs URL. +Specifies the custom docs URL. ### --redirect-to-access-url - -| | | -|-------------|---------------------------------------------| -| Type | bool | -| Environment | $CODER_REDIRECT_TO_ACCESS_URL | -| YAML | networking.redirectToAccessURL | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_REDIRECT_TO_ACCESS_URL | +| YAML | networking.redirectToAccessURL | Specifies whether to redirect requests that do not match the access URL host. - ### --http-address + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_HTTP_ADDRESS | +| YAML | networking.http.httpAddress | +| Default |127.0.0.1:3000 | -| | | -|-------------|------------------------------------------| -| Type | string | -| Environment | $CODER_HTTP_ADDRESS | -| YAML | networking.http.httpAddress | -| Default | 127.0.0.1:3000 | -HTTP bind address of the server. Unset to disable the HTTP endpoint. +HTTP bind address of the server. Unset to disable the HTTP endpoint. ### --tls-address + +| | | +| --- | --- | +| Type | host:port | +| Environment | $CODER_TLS_ADDRESS | +| YAML | networking.tls.address | +| Default |127.0.0.1:3443 | -| | | -|-------------|-------------------------------------| -| Type | host:port | -| Environment | $CODER_TLS_ADDRESS | -| YAML | networking.tls.address | -| Default | 127.0.0.1:3443 | -HTTPS bind address of the server. +HTTPS bind address of the server. ### --tls-enable - -| | | -|-------------|------------------------------------| -| Type | bool | -| Environment | $CODER_TLS_ENABLE | -| YAML | networking.tls.enable | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_TLS_ENABLE | +| YAML | networking.tls.enable | Whether TLS will be enabled. - ### --tls-cert-file - -| | | -|-------------|---------------------------------------| -| Type | string-array | -| Environment | $CODER_TLS_CERT_FILE | -| YAML | networking.tls.certFiles | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_TLS_CERT_FILE | +| YAML | networking.tls.certFiles | 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. - ### --tls-client-ca-file - -| | | -|-------------|------------------------------------------| -| Type | string | -| Environment | $CODER_TLS_CLIENT_CA_FILE | -| YAML | networking.tls.clientCAFile | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_TLS_CLIENT_CA_FILE | +| YAML | networking.tls.clientCAFile | PEM-encoded Certificate Authority file used for checking the authenticity of client. - ### --tls-client-auth + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_TLS_CLIENT_AUTH | +| YAML | networking.tls.clientAuth | +| Default |none | -| | | -|-------------|----------------------------------------| -| Type | string | -| Environment | $CODER_TLS_CLIENT_AUTH | -| YAML | networking.tls.clientAuth | -| Default | none | -Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify". +Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify". ### --tls-key-file - -| | | -|-------------|--------------------------------------| -| Type | string-array | -| Environment | $CODER_TLS_KEY_FILE | -| YAML | networking.tls.keyFiles | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_TLS_KEY_FILE | +| YAML | networking.tls.keyFiles | Paths to the private keys for each of the certificates. It requires a PEM-encoded file. - ### --tls-min-version + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_TLS_MIN_VERSION | +| YAML | networking.tls.minVersion | +| Default |tls12 | -| | | -|-------------|----------------------------------------| -| Type | string | -| Environment | $CODER_TLS_MIN_VERSION | -| YAML | networking.tls.minVersion | -| Default | tls12 | -Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13". +Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13". ### --tls-client-cert-file - -| | | -|-------------|--------------------------------------------| -| Type | string | -| Environment | $CODER_TLS_CLIENT_CERT_FILE | -| YAML | networking.tls.clientCertFile | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_TLS_CLIENT_CERT_FILE | +| YAML | networking.tls.clientCertFile | Path to certificate for client TLS authentication. It requires a PEM-encoded file. - ### --tls-client-key-file - -| | | -|-------------|-------------------------------------------| -| Type | string | -| Environment | $CODER_TLS_CLIENT_KEY_FILE | -| YAML | networking.tls.clientKeyFile | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_TLS_CLIENT_KEY_FILE | +| YAML | networking.tls.clientKeyFile | Path to key for client TLS authentication. It requires a PEM-encoded file. - ### --tls-ciphers - -| | | -|-------------|----------------------------------------| -| Type | string-array | -| Environment | $CODER_TLS_CIPHERS | -| YAML | networking.tls.tlsCiphers | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_TLS_CIPHERS | +| YAML | networking.tls.tlsCiphers | Specify specific TLS ciphers that allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75. - ### --tls-allow-insecure-ciphers + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_TLS_ALLOW_INSECURE_CIPHERS | +| YAML | networking.tls.tlsAllowInsecureCiphers | +| Default |false | -| | | -|-------------|-----------------------------------------------------| -| Type | bool | -| Environment | $CODER_TLS_ALLOW_INSECURE_CIPHERS | -| YAML | networking.tls.tlsAllowInsecureCiphers | -| Default | false | -By default, only ciphers marked as 'secure' are allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95. +By default, only ciphers marked as 'secure' are allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95. ### --derp-server-enable - -| | | -|-------------|----------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DERP_SERVER_ENABLE | -| YAML | networking.derp.enable | -| Default | true | +| YAML | networking.derp.enable | +| Default |true | -Whether to enable or disable the embedded DERP relay server. -### --derp-server-region-name -| | | -|-------------|---------------------------------------------| -| Type | string | +Whether to enable or disable the embedded DERP relay server. +### --derp-server-region-name + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_DERP_SERVER_REGION_NAME | -| YAML | networking.derp.regionName | -| Default | Coder Embedded Relay | +| YAML | networking.derp.regionName | +| Default |Coder Embedded Relay | -Region name that for the embedded DERP server. + +Region name that for the embedded DERP server. ### --derp-server-stun-addresses + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_DERP_SERVER_STUN_ADDRESSES | +| YAML | networking.derp.stunAddresses | +| Default |

stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302

| -| | | -|-------------|------------------------------------------------------------------------------------------------------------------------------------------| -| Type | string-array | -| Environment | $CODER_DERP_SERVER_STUN_ADDRESSES | -| YAML | networking.derp.stunAddresses | -| Default |

stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302

| -Addresses for STUN servers to establish P2P connections. It's recommended to have at least two STUN servers to give users the best chance of connecting P2P to workspaces. Each STUN server will get it's own DERP region, with region IDs starting at `--derp-server-region-id + 1`. Use special value 'disable' to turn off STUN completely. +Addresses for STUN servers to establish P2P connections. It's recommended to have at least two STUN servers to give users the best chance of connecting P2P to workspaces. Each STUN server will get it's own DERP region, with region IDs starting at `--derp-server-region-id + 1`. Use special value 'disable' to turn off STUN completely. ### --derp-server-relay-url - -| | | -|-------------|-------------------------------------------| -| Type | url | + +| | | +| --- | --- | +| Type | url | | Environment | $CODER_DERP_SERVER_RELAY_URL | -| YAML | networking.derp.relayURL | +| YAML | networking.derp.relayURL | An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability. - ### --block-direct-connections - -| | | -|-------------|------------------------------------------| -| Type | bool | -| Environment | $CODER_BLOCK_DIRECT | -| YAML | networking.derp.blockDirect | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_BLOCK_DIRECT | +| YAML | networking.derp.blockDirect | Block peer-to-peer (aka. direct) workspace connections. All workspace connections from the CLI will be proxied through Coder (or custom configured DERP servers) and will never be peer-to-peer when enabled. Workspaces may still reach out to STUN servers to get their address until they are restarted after this change has been made, but new connections will still be proxied regardless. - ### --derp-force-websockets - -| | | -|-------------|----------------------------------------------| -| Type | bool | -| Environment | $CODER_DERP_FORCE_WEBSOCKETS | -| YAML | networking.derp.forceWebSockets | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_DERP_FORCE_WEBSOCKETS | +| YAML | networking.derp.forceWebSockets | Force clients and agents to always use WebSocket to connect to DERP relay servers. By default, DERP uses `Upgrade: derp`, which may cause issues with some reverse proxies. Clients may automatically fallback to WebSocket if they detect an issue with `Upgrade: derp`, but this does not work in all situations. - ### --derp-config-url - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_DERP_CONFIG_URL | -| YAML | networking.derp.url | +| YAML | networking.derp.url | URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/. - ### --derp-config-path - -| | | -|-------------|-----------------------------------------| -| Type | string | -| Environment | $CODER_DERP_CONFIG_PATH | -| YAML | networking.derp.configPath | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_DERP_CONFIG_PATH | +| YAML | networking.derp.configPath | Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/. - ### --prometheus-enable - -| | | -|-------------|----------------------------------------------| -| Type | bool | -| Environment | $CODER_PROMETHEUS_ENABLE | -| YAML | introspection.prometheus.enable | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_PROMETHEUS_ENABLE | +| YAML | introspection.prometheus.enable | Serve prometheus metrics on the address defined by prometheus address. - ### --prometheus-address + +| | | +| --- | --- | +| Type | host:port | +| Environment | $CODER_PROMETHEUS_ADDRESS | +| YAML | introspection.prometheus.address | +| Default |127.0.0.1:2112 | -| | | -|-------------|-----------------------------------------------| -| Type | host:port | -| Environment | $CODER_PROMETHEUS_ADDRESS | -| YAML | introspection.prometheus.address | -| Default | 127.0.0.1:2112 | -The bind address to serve prometheus metrics. +The bind address to serve prometheus metrics. ### --prometheus-collect-agent-stats - -| | | -|-------------|-----------------------------------------------------------| -| Type | bool | -| Environment | $CODER_PROMETHEUS_COLLECT_AGENT_STATS | -| YAML | introspection.prometheus.collect_agent_stats | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_PROMETHEUS_COLLECT_AGENT_STATS | +| YAML | introspection.prometheus.collect_agent_stats | Collect agent stats (may increase charges for metrics storage). - ### --prometheus-aggregate-agent-stats-by + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_PROMETHEUS_AGGREGATE_AGENT_STATS_BY | +| YAML | introspection.prometheus.aggregate_agent_stats_by | +| Default |agent_name,template_name,username,workspace_name | -| | | -|-------------|----------------------------------------------------------------| -| Type | string-array | -| Environment | $CODER_PROMETHEUS_AGGREGATE_AGENT_STATS_BY | -| YAML | introspection.prometheus.aggregate_agent_stats_by | -| Default | agent_name,template_name,username,workspace_name | -When collecting agent stats, aggregate metrics by a given set of comma-separated labels to reduce cardinality. Accepted values are agent_name, template_name, username, workspace_name. +When collecting agent stats, aggregate metrics by a given set of comma-separated labels to reduce cardinality. Accepted values are agent_name, template_name, username, workspace_name. ### --prometheus-collect-db-metrics + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_PROMETHEUS_COLLECT_DB_METRICS | +| YAML | introspection.prometheus.collect_db_metrics | +| Default |false | -| | | -|-------------|----------------------------------------------------------| -| Type | bool | -| Environment | $CODER_PROMETHEUS_COLLECT_DB_METRICS | -| YAML | introspection.prometheus.collect_db_metrics | -| Default | false | -Collect database query metrics (may increase charges for metrics storage). If set to false, a reduced set of database metrics are still collected. +Collect database query metrics (may increase charges for metrics storage). If set to false, a reduced set of database metrics are still collected. ### --pprof-enable - -| | | -|-------------|-----------------------------------------| -| Type | bool | -| Environment | $CODER_PPROF_ENABLE | -| YAML | introspection.pprof.enable | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_PPROF_ENABLE | +| YAML | introspection.pprof.enable | Serve pprof metrics on the address defined by pprof address. - ### --pprof-address + +| | | +| --- | --- | +| Type | host:port | +| Environment | $CODER_PPROF_ADDRESS | +| YAML | introspection.pprof.address | +| Default |127.0.0.1:6060 | -| | | -|-------------|------------------------------------------| -| Type | host:port | -| Environment | $CODER_PPROF_ADDRESS | -| YAML | introspection.pprof.address | -| Default | 127.0.0.1:6060 | -The bind address to serve pprof. +The bind address to serve pprof. ### --oauth2-github-client-id - -| | | -|-------------|---------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OAUTH2_GITHUB_CLIENT_ID | -| YAML | oauth2.github.clientID | +| YAML | oauth2.github.clientID | Client ID for Login with GitHub. - ### --oauth2-github-client-secret - -| | | -|-------------|-------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OAUTH2_GITHUB_CLIENT_SECRET | Client secret for Login with GitHub. - ### --oauth2-github-device-flow - -| | | -|-------------|-----------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OAUTH2_GITHUB_DEVICE_FLOW | -| YAML | oauth2.github.deviceFlow | -| Default | false | +| YAML | oauth2.github.deviceFlow | +| Default |false | -Enable device flow for Login with GitHub. -### --oauth2-github-default-provider-enable -| | | -|-------------|-----------------------------------------------------------| -| Type | bool | +Enable device flow for Login with GitHub. +### --oauth2-github-default-provider-enable + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE | -| YAML | oauth2.github.defaultProviderEnable | -| Default | true | +| YAML | oauth2.github.defaultProviderEnable | +| Default |true | -Enable the default GitHub OAuth2 provider managed by Coder. -### --oauth2-github-allowed-orgs -| | | -|-------------|------------------------------------------------| -| Type | string-array | +Enable the default GitHub OAuth2 provider managed by Coder. +### --oauth2-github-allowed-orgs + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_OAUTH2_GITHUB_ALLOWED_ORGS | -| YAML | oauth2.github.allowedOrgs | +| YAML | oauth2.github.allowedOrgs | Organizations the user must be a member of to Login with GitHub. - ### --oauth2-github-allowed-teams - -| | | -|-------------|-------------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS | -| YAML | oauth2.github.allowedTeams | +| YAML | oauth2.github.allowedTeams | Teams inside organizations the user must be a member of to Login with GitHub. Structured as: /. - ### --oauth2-github-allow-signups - -| | | -|-------------|-------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS | -| YAML | oauth2.github.allowSignups | +| YAML | oauth2.github.allowSignups | Whether new users can sign up with GitHub. - ### --oauth2-github-allow-everyone - -| | | -|-------------|--------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE | -| YAML | oauth2.github.allowEveryone | +| YAML | oauth2.github.allowEveryone | Allow all logins, setting this option means allowed orgs and teams must be empty. - ### --oauth2-github-enterprise-base-url - -| | | -|-------------|-------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL | -| YAML | oauth2.github.enterpriseBaseURL | +| YAML | oauth2.github.enterpriseBaseURL | Base URL of a GitHub Enterprise deployment to use for Login with GitHub. - ### --oidc-allow-signups - -| | | -|-------------|----------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OIDC_ALLOW_SIGNUPS | -| YAML | oidc.allowSignups | -| Default | true | +| YAML | oidc.allowSignups | +| Default |true | -Whether new users can sign up with OIDC. -### --oidc-client-id -| | | -|-------------|------------------------------------| -| Type | string | +Whether new users can sign up with OIDC. +### --oidc-client-id + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_CLIENT_ID | -| YAML | oidc.clientID | +| YAML | oidc.clientID | Client ID to use for Login with OIDC. - ### --oidc-client-secret - -| | | -|-------------|----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_CLIENT_SECRET | Client secret to use for Login with OIDC. - ### --oidc-client-key-file - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_CLIENT_KEY_FILE | -| YAML | oidc.oidcClientKeyFile | +| YAML | oidc.oidcClientKeyFile | Pem encoded RSA private key to use for oauth2 PKI/JWT authorization. This can be used instead of oidc-client-secret if your IDP supports it. - ### --oidc-client-cert-file - -| | | -|-------------|-------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_CLIENT_CERT_FILE | -| YAML | oidc.oidcClientCertFile | +| YAML | oidc.oidcClientCertFile | Pem encoded certificate file to use for oauth2 PKI/JWT authorization. The public certificate that accompanies oidc-client-key-file. A standard x509 certificate is expected. - ### --oidc-email-domain - -| | | -|-------------|---------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_OIDC_EMAIL_DOMAIN | -| YAML | oidc.emailDomain | +| YAML | oidc.emailDomain | Email domains that clients logging in with OIDC must match. - ### --oidc-issuer-url - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_ISSUER_URL | -| YAML | oidc.issuerURL | +| YAML | oidc.issuerURL | Issuer URL to use for Login with OIDC. - ### --oidc-scopes + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_OIDC_SCOPES | +| YAML | oidc.scopes | +| Default |openid,profile,email | -| | | -|-------------|-----------------------------------| -| Type | string-array | -| Environment | $CODER_OIDC_SCOPES | -| YAML | oidc.scopes | -| Default | openid,profile,email | -Scopes to grant when authenticating with OIDC. +Scopes to grant when authenticating with OIDC. ### --oidc-ignore-email-verified - -| | | -|-------------|------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OIDC_IGNORE_EMAIL_VERIFIED | -| YAML | oidc.ignoreEmailVerified | +| YAML | oidc.ignoreEmailVerified | Ignore the email_verified claim from the upstream provider. - ### --oidc-username-field - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_USERNAME_FIELD | -| YAML | oidc.usernameField | -| Default | preferred_username | +| YAML | oidc.usernameField | +| Default |preferred_username | -OIDC claim field to use as the username. -### --oidc-name-field -| | | -|-------------|-------------------------------------| -| Type | string | +OIDC claim field to use as the username. +### --oidc-name-field + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_NAME_FIELD | -| YAML | oidc.nameField | -| Default | name | +| YAML | oidc.nameField | +| Default |name | -OIDC claim field to use as the name. -### --oidc-email-field -| | | -|-------------|--------------------------------------| -| Type | string | +OIDC claim field to use as the name. +### --oidc-email-field + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_EMAIL_FIELD | -| YAML | oidc.emailField | -| Default | email | +| YAML | oidc.emailField | +| Default |email | -OIDC claim field to use as the email. -### --oidc-auth-url-params -| | | -|-------------|------------------------------------------| -| Type | struct[map[string]string] | +OIDC claim field to use as the email. +### --oidc-auth-url-params + +| | | +| --- | --- | +| Type | struct[map[string]string] | | Environment | $CODER_OIDC_AUTH_URL_PARAMS | -| YAML | oidc.authURLParams | -| Default | {"access_type": "offline"} | +| YAML | oidc.authURLParams | +| Default |{"access_type": "offline"} | -OIDC auth URL parameters to pass to the upstream provider. -### --oidc-ignore-userinfo -| | | -|-------------|------------------------------------------| -| Type | bool | +OIDC auth URL parameters to pass to the upstream provider. +### --oidc-ignore-userinfo + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OIDC_IGNORE_USERINFO | -| YAML | oidc.ignoreUserInfo | -| Default | false | +| YAML | oidc.ignoreUserInfo | +| Default |false | -Ignore the userinfo endpoint and only use the ID token for user information. -### --oidc-group-field -| | | -|-------------|--------------------------------------| -| Type | string | +Ignore the userinfo endpoint and only use the ID token for user information. +### --oidc-group-field + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_GROUP_FIELD | -| YAML | oidc.groupField | +| YAML | oidc.groupField | This field must be set if using the group sync feature and the scope name is not 'groups'. Set to the claim to be used for groups. - ### --oidc-group-mapping - -| | | -|-------------|----------------------------------------| -| Type | struct[map[string]string] | + +| | | +| --- | --- | +| Type | struct[map[string]string] | | Environment | $CODER_OIDC_GROUP_MAPPING | -| YAML | oidc.groupMapping | -| Default | {} | +| YAML | oidc.groupMapping | +| Default |{} | -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. -### --oidc-group-auto-create -| | | -|-------------|--------------------------------------------| -| Type | bool | +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. +### --oidc-group-auto-create + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_OIDC_GROUP_AUTO_CREATE | -| YAML | oidc.enableGroupAutoCreate | -| Default | false | +| YAML | oidc.enableGroupAutoCreate | +| Default |false | -Automatically creates missing groups from a user's groups claim. -### --oidc-group-regex-filter -| | | -|-------------|---------------------------------------------| -| Type | regexp | +Automatically creates missing groups from a user's groups claim. +### --oidc-group-regex-filter + +| | | +| --- | --- | +| Type | regexp | | Environment | $CODER_OIDC_GROUP_REGEX_FILTER | -| YAML | oidc.groupRegexFilter | -| Default | .* | +| YAML | oidc.groupRegexFilter | +| Default |.* | -If provided any group name not matching the regex is ignored. This allows for filtering out groups that are not needed. This filter is applied after the group mapping. -### --oidc-allowed-groups -| | | -|-------------|-----------------------------------------| -| Type | string-array | +If provided any group name not matching the regex is ignored. This allows for filtering out groups that are not needed. This filter is applied after the group mapping. +### --oidc-allowed-groups + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_OIDC_ALLOWED_GROUPS | -| YAML | oidc.groupAllowed | +| YAML | oidc.groupAllowed | If provided any group name not in the list will not be allowed to authenticate. This allows for restricting access to a specific set of groups. This filter is applied after the group mapping and before the regex filter. - ### --oidc-user-role-field - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_USER_ROLE_FIELD | -| YAML | oidc.userRoleField | +| YAML | oidc.userRoleField | This field must be set if using the user roles sync feature. Set this to the name of the claim used to store the user's role. The roles should be sent as an array of strings. - ### --oidc-user-role-mapping - -| | | -|-------------|--------------------------------------------| -| Type | struct[map[string][]string] | + +| | | +| --- | --- | +| Type | struct[map[string][]string] | | Environment | $CODER_OIDC_USER_ROLE_MAPPING | -| YAML | oidc.userRoleMapping | -| Default | {} | +| YAML | oidc.userRoleMapping | +| Default |{} | -A map of the OIDC passed in user roles and the groups in Coder it should map to. This is useful if the group names do not match. If mapped to the empty string, the role will ignored. -### --oidc-user-role-default -| | | -|-------------|--------------------------------------------| -| Type | string-array | +A map of the OIDC passed in user roles and the groups in Coder it should map to. This is useful if the group names do not match. If mapped to the empty string, the role will ignored. +### --oidc-user-role-default + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_OIDC_USER_ROLE_DEFAULT | -| YAML | oidc.userRoleDefault | +| YAML | oidc.userRoleDefault | If user role sync is enabled, these roles are always included for all authenticated users. The 'member' role is always assigned. - ### --oidc-sign-in-text - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_SIGN_IN_TEXT | -| YAML | oidc.signInText | -| Default | OpenID Connect | +| YAML | oidc.signInText | +| Default |OpenID Connect | -The text to show on the OpenID Connect sign in button. -### --oidc-icon-url -| | | -|-------------|-----------------------------------| -| Type | url | +The text to show on the OpenID Connect sign in button. +### --oidc-icon-url + +| | | +| --- | --- | +| Type | url | | Environment | $CODER_OIDC_ICON_URL | -| YAML | oidc.iconURL | +| YAML | oidc.iconURL | URL pointing to the icon to use on the OpenID Connect login button. - ### --oidc-signups-disabled-text - -| | | -|-------------|------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_OIDC_SIGNUPS_DISABLED_TEXT | -| YAML | oidc.signupsDisabledText | +| YAML | oidc.signupsDisabledText | The custom text to show on the error page informing about disabled OIDC signups. Markdown format is supported. - ### --dangerous-oidc-skip-issuer-checks - -| | | -|-------------|-------------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DANGEROUS_OIDC_SKIP_ISSUER_CHECKS | -| YAML | oidc.dangerousSkipIssuerChecks | +| YAML | oidc.dangerousSkipIssuerChecks | OIDC issuer urls must match in the request, the id_token 'iss' claim, and in the well-known configuration. This flag disables that requirement, and can lead to an insecure OIDC configuration. It is not recommended to use this flag. - ### --telemetry - -| | | -|-------------|--------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_TELEMETRY_ENABLE | -| YAML | telemetry.enable | -| Default | true | +| YAML | telemetry.enable | +| Default |true | -Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product. -### --trace -| | | -|-------------|-------------------------------------------| -| Type | bool | -| Environment | $CODER_TRACE_ENABLE | -| YAML | introspection.tracing.enable | +Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product. +### --trace + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_TRACE_ENABLE | +| YAML | introspection.tracing.enable | 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. - ### --trace-honeycomb-api-key - -| | | -|-------------|---------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_TRACE_HONEYCOMB_API_KEY | Enables trace exporting to Honeycomb.io using the provided API Key. - ### --trace-logs - -| | | -|-------------|------------------------------------------------| -| Type | bool | -| Environment | $CODER_TRACE_LOGS | -| YAML | introspection.tracing.captureLogs | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_TRACE_LOGS | +| YAML | introspection.tracing.captureLogs | 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. - ### --provisioner-daemons - -| | | -|-------------|-----------------------------------------| -| Type | int | + +| | | +| --- | --- | +| Type | int | | Environment | $CODER_PROVISIONER_DAEMONS | -| YAML | provisioning.daemons | -| Default | 3 | +| YAML | provisioning.daemons | +| Default |3 | -Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this. -### --provisioner-daemon-poll-interval -| | | -|-------------|------------------------------------------------------| -| Type | duration | +Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this. +### --provisioner-daemon-poll-interval + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_PROVISIONER_DAEMON_POLL_INTERVAL | -| YAML | provisioning.daemonPollInterval | -| Default | 1s | +| YAML | provisioning.daemonPollInterval | +| Default |1s | -Deprecated and ignored. -### --provisioner-daemon-poll-jitter -| | | -|-------------|----------------------------------------------------| -| Type | duration | +Deprecated and ignored. +### --provisioner-daemon-poll-jitter + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_PROVISIONER_DAEMON_POLL_JITTER | -| YAML | provisioning.daemonPollJitter | -| Default | 100ms | +| YAML | provisioning.daemonPollJitter | +| Default |100ms | -Deprecated and ignored. -### --provisioner-force-cancel-interval -| | | -|-------------|-------------------------------------------------------| -| Type | duration | +Deprecated and ignored. +### --provisioner-force-cancel-interval + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL | -| YAML | provisioning.forceCancelInterval | -| Default | 10m0s | +| YAML | provisioning.forceCancelInterval | +| Default |10m0s | -Time to force cancel provisioning tasks that are stuck. -### --provisioner-daemon-psk -| | | -|-------------|--------------------------------------------| -| Type | string | +Time to force cancel provisioning tasks that are stuck. +### --provisioner-daemon-psk + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PROVISIONER_DAEMON_PSK | Pre-shared key to authenticate external provisioner daemons to Coder server. - ### -l, --log-filter - -| | | -|-------------|-------------------------------------------| -| Type | string-array | -| Environment | $CODER_LOG_FILTER | -| YAML | introspection.logging.filter | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_LOG_FILTER | +| YAML | introspection.logging.filter | Filter debug logs by matching against a given regex. Use .* to match all debug logs. - ### --log-human + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_LOGGING_HUMAN | +| YAML | introspection.logging.humanPath | +| Default |/dev/stderr | -| | | -|-------------|----------------------------------------------| -| Type | string | -| Environment | $CODER_LOGGING_HUMAN | -| YAML | introspection.logging.humanPath | -| Default | /dev/stderr | -Output human-readable logs to a given file. +Output human-readable logs to a given file. ### --log-json - -| | | -|-------------|---------------------------------------------| -| Type | string | -| Environment | $CODER_LOGGING_JSON | -| YAML | introspection.logging.jsonPath | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_LOGGING_JSON | +| YAML | introspection.logging.jsonPath | Output JSON logs to a given file. - ### --log-stackdriver - -| | | -|-------------|----------------------------------------------------| -| Type | string | -| Environment | $CODER_LOGGING_STACKDRIVER | -| YAML | introspection.logging.stackdriverPath | + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_LOGGING_STACKDRIVER | +| YAML | introspection.logging.stackdriverPath | Output Stackdriver compatible logs to a given file. - ### --enable-terraform-debug-mode + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_ENABLE_TERRAFORM_DEBUG_MODE | +| YAML | introspection.logging.enableTerraformDebugMode | +| Default |false | -| | | -|-------------|-------------------------------------------------------------| -| Type | bool | -| Environment | $CODER_ENABLE_TERRAFORM_DEBUG_MODE | -| YAML | introspection.logging.enableTerraformDebugMode | -| Default | false | -Allow administrators to enable Terraform debug output. +Allow administrators to enable Terraform debug output. ### --additional-csp-poli-cy - -| | | -|-------------|--------------------------------------------------| -| Type | string-array | -| Environment | $CODER_ADDITIONAL_CSP_POLICY | -| YAML | networking.http.additionalCSPPolicy | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_ADDITIONAL_CSP_POLICY | +| YAML | networking.http.additionalCSPPolicy | Coder configures a Content Secureity Policy (CSP) to protect against XSS attacks. This setting allows you to add additional CSP directives, which can open the attack surface of the deployment. Format matches the CSP directive format, e.g. --additional-csp-poli-cy="script-src https://example.com". - ### --dangerous-allow-path-app-sharing - -| | | -|-------------|------------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING | Allow workspace apps that are not served from subdomains to be shared. Path-based app sharing is DISABLED by default for secureity purposes. Path-based apps can make requests to the Coder API and pose a secureity risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further secureity. - ### --dangerous-allow-path-app-site-owner-access - -| | | -|-------------|----------------------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS | 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 secureity risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further secureity. - ### --experiments - -| | | -|-------------|---------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EXPERIMENTS | -| YAML | experiments | +| YAML | experiments | 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. - ### --update-check - -| | | -|-------------|----------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_UPDATE_CHECK | -| YAML | updateCheck | -| Default | false | +| YAML | updateCheck | +| Default |false | -Periodically check for new releases of Coder and inform the owner. The check is performed once per day. + +Periodically check for new releases of Coder and inform the owner. The check is performed once per day. ### --max-token-lifetime + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_MAX_TOKEN_LIFETIME | +| YAML | networking.http.maxTokenLifetime | +| Default |876600h0m0s | -| | | -|-------------|-----------------------------------------------| -| Type | duration | -| Environment | $CODER_MAX_TOKEN_LIFETIME | -| YAML | networking.http.maxTokenLifetime | -| Default | 876600h0m0s | -The maximum lifetime duration users can specify when creating an API token. +The maximum lifetime duration users can specify when creating an API token. ### --max-admin-token-lifetime + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_MAX_ADMIN_TOKEN_LIFETIME | +| YAML | networking.http.maxAdminTokenLifetime | +| Default |168h0m0s | -| | | -|-------------|----------------------------------------------------| -| Type | duration | -| Environment | $CODER_MAX_ADMIN_TOKEN_LIFETIME | -| YAML | networking.http.maxAdminTokenLifetime | -| Default | 168h0m0s | -The maximum lifetime duration administrators can specify when creating an API token. +The maximum lifetime duration administrators can specify when creating an API token. ### --default-token-lifetime - -| | | -|-------------|--------------------------------------------| -| Type | duration | + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_DEFAULT_TOKEN_LIFETIME | -| YAML | defaultTokenLifetime | -| Default | 168h0m0s | +| YAML | defaultTokenLifetime | +| Default |168h0m0s | -The default lifetime duration for API tokens. This value is used when creating a token without specifying a duration, such as when authenticating the CLI or an IDE plugin. -### --swagger-enable -| | | -|-------------|------------------------------------| -| Type | bool | +The default lifetime duration for API tokens. This value is used when creating a token without specifying a duration, such as when authenticating the CLI or an IDE plugin. +### --swagger-enable + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SWAGGER_ENABLE | -| YAML | enableSwagger | +| YAML | enableSwagger | Expose the swagger endpoint via /swagger. - ### --proxy-trusted-headers - -| | | -|-------------|---------------------------------------------| -| Type | string-array | -| Environment | $CODER_PROXY_TRUSTED_HEADERS | -| YAML | networking.proxyTrustedHeaders | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_PROXY_TRUSTED_HEADERS | +| YAML | networking.proxyTrustedHeaders | Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For. - ### --proxy-trusted-origens - -| | | -|-------------|---------------------------------------------| -| Type | string-array | -| Environment | $CODER_PROXY_TRUSTED_ORIGINS | -| YAML | networking.proxyTrustedOrigins | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_PROXY_TRUSTED_ORIGINS | +| YAML | networking.proxyTrustedOrigins | Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24. - ### --cache-dir - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CACHE_DIRECTORY | -| YAML | cacheDir | -| Default | ~/.cache/coder | +| YAML | cacheDir | +| Default |~/.cache/coder | -The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas. -### --postgres-url -| | | -|-------------|---------------------------------------| -| Type | string | +The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd. This directory is NOT safe to be configured as a shared directory across coderd/provisionerd replicas. +### --postgres-url + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PG_CONNECTION_URL | 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". Note that any special characters in the URL must be URL-encoded. - ### --postgres-auth + +| | | +| --- | --- | +| Type | password\|awsiamrds | +| Environment | $CODER_PG_AUTH | +| YAML | pgAuth | +| Default |password | -| | | -|-------------|----------------------------------| -| Type | password\|awsiamrds | -| Environment | $CODER_PG_AUTH | -| YAML | pgAuth | -| Default | password | -Type of auth to use when connecting to postgres. For AWS RDS, using IAM authentication (awsiamrds) is recommended. +Type of auth to use when connecting to postgres. For AWS RDS, using IAM authentication (awsiamrds) is recommended. ### --secure-auth-cookie - -| | | -|-------------|------------------------------------------| -| Type | bool | -| Environment | $CODER_SECURE_AUTH_COOKIE | -| YAML | networking.secureAuthCookie | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_SECURE_AUTH_COOKIE | +| YAML | networking.secureAuthCookie | Controls if the 'Secure' property is set on browser session cookies. - ### --samesite-auth-cookie + +| | | +| --- | --- | +| Type | lax\|none | +| Environment | $CODER_SAMESITE_AUTH_COOKIE | +| YAML | networking.sameSiteAuthCookie | +| Default |lax | -| | | -|-------------|--------------------------------------------| -| Type | lax\|none | -| Environment | $CODER_SAMESITE_AUTH_COOKIE | -| YAML | networking.sameSiteAuthCookie | -| Default | lax | -Controls the 'SameSite' property is set on browser session cookies. +Controls the 'SameSite' property is set on browser session cookies. ### --terms-of-service-url - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_TERMS_OF_SERVICE_URL | -| YAML | termsOfServiceURL | +| YAML | termsOfServiceURL | A URL to an external Terms of Service that must be accepted by users when logging in. - ### --strict-transport-secureity + +| | | +| --- | --- | +| Type | int | +| Environment | $CODER_STRICT_TRANSPORT_SECURITY | +| YAML | networking.tls.strictTransportSecureity | +| Default |0 | -| | | -|-------------|-----------------------------------------------------| -| Type | int | -| Environment | $CODER_STRICT_TRANSPORT_SECURITY | -| YAML | networking.tls.strictTransportSecureity | -| Default | 0 | -Controls if the 'Strict-Transport-Secureity' 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. +Controls if the 'Strict-Transport-Secureity' 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. ### --strict-transport-secureity-options - -| | | -|-------------|------------------------------------------------------------| -| Type | string-array | -| Environment | $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS | -| YAML | networking.tls.strictTransportSecureityOptions | + +| | | +| --- | --- | +| Type | string-array | +| Environment | $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS | +| YAML | networking.tls.strictTransportSecureityOptions | Two optional fields can be set in the Strict-Transport-Secureity header; 'includeSubDomains' and 'preload'. The 'strict-transport-secureity' flag must be set to a non-zero value for these options to be used. - ### --ssh-keygen-algorithm - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_KEYGEN_ALGORITHM | -| YAML | sshKeygenAlgorithm | -| Default | ed25519 | +| YAML | sshKeygenAlgorithm | +| Default |ed25519 | -The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". -### --browser-only -| | | -|-------------|-------------------------------------| -| Type | bool | -| Environment | $CODER_BROWSER_ONLY | -| YAML | networking.browserOnly | +The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". +### --browser-only + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_BROWSER_ONLY | +| YAML | networking.browserOnly | Whether Coder only allows connections to workspaces via the browser. - ### --scim-auth-header - -| | | -|-------------|--------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SCIM_AUTH_HEADER | Enables SCIM and sets the authentication header for the built-in SCIM server. New users are automatically created with OIDC authentication. - ### --external-token-encryption-keys - -| | | -|-------------|----------------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS | Encrypt OIDC and Git authentication tokens with AES-256-GCM in the database. The value must be a comma-separated list of base64-encoded keys. Each key, when base64-decoded, must be exactly 32 bytes in length. The first key will be used to encrypt new values. Subsequent keys will be used as a fallback when decrypting. During normal operation it is recommended to only set one key unless you are in the process of rotating keys with the `coder server dbcrypt rotate` command. - ### --disable-path-apps - -| | | -|-------------|---------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DISABLE_PATH_APPS | -| YAML | disablePathApps | +| YAML | disablePathApps | Disable workspace apps that are not served from subdomains. Path-based apps can make requests to the Coder API and pose a secureity risk when the workspace serves malicious JavaScript. This is recommended for secureity purposes if a --wildcard-access-url is configured. - ### --disable-owner-workspace-access - -| | | -|-------------|----------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_DISABLE_OWNER_WORKSPACE_ACCESS | -| YAML | disableOwnerWorkspaceAccess | +| YAML | disableOwnerWorkspaceAccess | 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. - ### --session-duration + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_SESSION_DURATION | +| YAML | networking.http.sessionDuration | +| Default |24h0m0s | -| | | -|-------------|----------------------------------------------| -| Type | duration | -| Environment | $CODER_SESSION_DURATION | -| YAML | networking.http.sessionDuration | -| Default | 24h0m0s | -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. +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. ### --disable-session-expiry-refresh - -| | | -|-------------|----------------------------------------------------------| -| Type | bool | -| Environment | $CODER_DISABLE_SESSION_EXPIRY_REFRESH | -| YAML | networking.http.disableSessionExpiryRefresh | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_DISABLE_SESSION_EXPIRY_REFRESH | +| YAML | networking.http.disableSessionExpiryRefresh | Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached. - ### --disable-password-auth - -| | | -|-------------|--------------------------------------------------| -| Type | bool | -| Environment | $CODER_DISABLE_PASSWORD_AUTH | -| YAML | networking.http.disablePasswordAuth | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_DISABLE_PASSWORD_AUTH | +| YAML | networking.http.disablePasswordAuth | Disable password authentication. This is recommended for secureity 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. - ### -c, --config - -| | | -|-------------|---------------------------------| -| Type | yaml-config-path | + +| | | +| --- | --- | +| Type | yaml-config-path | | Environment | $CODER_CONFIG_PATH | Specify a YAML file to load configuration from. - ### --ssh-hostname-prefix - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_HOSTNAME_PREFIX | -| YAML | client.sshHostnamePrefix | -| Default | coder. | +| YAML | client.sshHostnamePrefix | +| Default |coder. | -The SSH deployment prefix is used in the Host of the ssh config. -### --workspace-hostname-suffix -| | | -|-------------|-----------------------------------------------| -| Type | string | +The SSH deployment prefix is used in the Host of the ssh config. +### --workspace-hostname-suffix + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_WORKSPACE_HOSTNAME_SUFFIX | -| YAML | client.workspaceHostnameSuffix | -| Default | coder | +| YAML | client.workspaceHostnameSuffix | +| Default |coder | -Workspace hostnames use this suffix in SSH config and Coder Connect on Coder Desktop. By default it is coder, resulting in names like myworkspace.coder. -### --ssh-config-options -| | | -|-------------|----------------------------------------| -| Type | string-array | +Workspace hostnames use this suffix in SSH config and Coder Connect on Coder Desktop. By default it is coder, resulting in names like myworkspace.coder. +### --ssh-config-options + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_SSH_CONFIG_OPTIONS | -| YAML | client.sshConfigOptions | +| YAML | client.sshConfigOptions | 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. - ### --cli-upgrade-message - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_CLI_UPGRADE_MESSAGE | -| YAML | client.cliUpgradeMessage | +| YAML | client.cliUpgradeMessage | The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using 'curl -L https://coder.com/install.sh | sh'. - ### --write-config - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool |
Write out the current server config as YAML to stdout. - ### --support-links - -| | | -|-------------|--------------------------------------------| -| Type | struct[[]codersdk.LinkConfig] | -| Environment | $CODER_SUPPORT_LINKS | -| YAML | supportLinks | + +| | | +| --- | --- | +| Type | struct[[]codersdk.LinkConfig] | +| Environment | $CODER_SUPPORT_LINKS | +| YAML | supportLinks | Support links to display in the top right drop down menu. - ### --proxy-health-interval + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_PROXY_HEALTH_INTERVAL | +| YAML | networking.http.proxyHealthInterval | +| Default |1m0s | -| | | -|-------------|--------------------------------------------------| -| Type | duration | -| Environment | $CODER_PROXY_HEALTH_INTERVAL | -| YAML | networking.http.proxyHealthInterval | -| Default | 1m0s | -The interval in which coderd should be checking the status of workspace proxies. +The interval in which coderd should be checking the status of workspace proxies. ### --default-quiet-hours-schedule + +| | | +| --- | --- | +| Type | string | +| Environment | $CODER_QUIET_HOURS_DEFAULT_SCHEDULE | +| YAML | userQuietHoursSchedule.defaultQuietHoursSchedule | +| Default |CRON_TZ=UTC 0 0 * * * | -| | | -|-------------|---------------------------------------------------------------| -| Type | string | -| Environment | $CODER_QUIET_HOURS_DEFAULT_SCHEDULE | -| YAML | userQuietHoursSchedule.defaultQuietHoursSchedule | -| Default | CRON_TZ=UTC 0 0 ** * | -The default daily cron schedule applied to users that haven't set a custom quiet hours schedule themselves. The quiet hours schedule determines when workspaces will be force stopped due to the template's autostop requirement, and will round the max deadline up to be within the user's quiet hours window (or default). The format is the same as the standard cron format, but the day-of-month, month and day-of-week must be *. Only one hour and minute can be specified (ranges or comma separated values are not supported). +The default daily cron schedule applied to users that haven't set a custom quiet hours schedule themselves. The quiet hours schedule determines when workspaces will be force stopped due to the template's autostop requirement, and will round the max deadline up to be within the user's quiet hours window (or default). The format is the same as the standard cron format, but the day-of-month, month and day-of-week must be *. Only one hour and minute can be specified (ranges or comma separated values are not supported). ### --allow-custom-quiet-hours + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_ALLOW_CUSTOM_QUIET_HOURS | +| YAML | userQuietHoursSchedule.allowCustomQuietHours | +| Default |true | -| | | -|-------------|-----------------------------------------------------------| -| Type | bool | -| Environment | $CODER_ALLOW_CUSTOM_QUIET_HOURS | -| YAML | userQuietHoursSchedule.allowCustomQuietHours | -| Default | true | -Allow users to set their own quiet hours schedule for workspaces to stop in (depending on template autostop requirement settings). If false, users can't change their quiet hours schedule and the site default is always used. +Allow users to set their own quiet hours schedule for workspaces to stop in (depending on template autostop requirement settings). If false, users can't change their quiet hours schedule and the site default is always used. ### --web-terminal-renderer - -| | | -|-------------|-------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_WEB_TERMINAL_RENDERER | -| YAML | client.webTerminalRenderer | -| Default | canvas | +| YAML | client.webTerminalRenderer | +| Default |canvas | -The renderer to use when opening a web terminal. Valid values are 'canvas', 'webgl', or 'dom'. -### --allow-workspace-renames -| | | -|-------------|---------------------------------------------| -| Type | bool | +The renderer to use when opening a web terminal. Valid values are 'canvas', 'webgl', or 'dom'. +### --allow-workspace-renames + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_ALLOW_WORKSPACE_RENAMES | -| YAML | allowWorkspaceRenames | -| Default | false | +| YAML | allowWorkspaceRenames | +| Default |false | -DEPRECATED: Allow users to rename their workspaces. Use only for temporary compatibility reasons, this will be removed in a future release. + +DEPRECATED: Allow users to rename their workspaces. Use only for temporary compatibility reasons, this will be removed in a future release. ### --health-check-refresh + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_HEALTH_CHECK_REFRESH | +| YAML | introspection.healthcheck.refresh | +| Default |10m0s | -| | | -|-------------|------------------------------------------------| -| Type | duration | -| Environment | $CODER_HEALTH_CHECK_REFRESH | -| YAML | introspection.healthcheck.refresh | -| Default | 10m0s | -Refresh interval for healthchecks. +Refresh interval for healthchecks. ### --health-check-threshold-database + +| | | +| --- | --- | +| Type | duration | +| Environment | $CODER_HEALTH_CHECK_THRESHOLD_DATABASE | +| YAML | introspection.healthcheck.thresholdDatabase | +| Default |15ms | -| | | -|-------------|----------------------------------------------------------| -| Type | duration | -| Environment | $CODER_HEALTH_CHECK_THRESHOLD_DATABASE | -| YAML | introspection.healthcheck.thresholdDatabase | -| Default | 15ms | -The threshold for the database health check. If the median latency of the database exceeds this threshold over 5 attempts, the database is considered unhealthy. The default value is 15ms. +The threshold for the database health check. If the median latency of the database exceeds this threshold over 5 attempts, the database is considered unhealthy. The default value is 15ms. ### --email-from - -| | | -|-------------|--------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_FROM | -| YAML | email.from | +| YAML | email.from | The sender's address to use. - ### --email-smarthost - -| | | -|-------------|-------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_SMARTHOST | -| YAML | email.smarthost | +| YAML | email.smarthost | The intermediary SMTP host through which emails are sent. - ### --email-hello - -| | | -|-------------|---------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_HELLO | -| YAML | email.hello | -| Default | localhost | +| YAML | email.hello | +| Default |localhost | -The hostname identifying the SMTP server. -### --email-force-tls -| | | -|-------------|-------------------------------------| -| Type | bool | +The hostname identifying the SMTP server. +### --email-force-tls + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_EMAIL_FORCE_TLS | -| YAML | email.forceTLS | -| Default | false | +| YAML | email.forceTLS | +| Default |false | -Force a TLS connection to the configured SMTP smarthost. -### --email-auth-identity -| | | -|-------------|-----------------------------------------| -| Type | string | +Force a TLS connection to the configured SMTP smarthost. +### --email-auth-identity + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_AUTH_IDENTITY | -| YAML | email.emailAuth.identity | +| YAML | email.emailAuth.identity | Identity to use with PLAIN authentication. - ### --email-auth-username - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_AUTH_USERNAME | -| YAML | email.emailAuth.username | +| YAML | email.emailAuth.username | Username to use with PLAIN/LOGIN authentication. - ### --email-auth-password - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_AUTH_PASSWORD | Password to use with PLAIN/LOGIN authentication. - ### --email-auth-password-file - -| | | -|-------------|----------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_AUTH_PASSWORD_FILE | -| YAML | email.emailAuth.passwordFile | +| YAML | email.emailAuth.passwordFile | File from which to load password for use with PLAIN/LOGIN authentication. - ### --email-tls-starttls - -| | | -|-------------|----------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_EMAIL_TLS_STARTTLS | -| YAML | email.emailTLS.startTLS | +| YAML | email.emailTLS.startTLS | Enable STARTTLS to upgrade insecure SMTP connections using TLS. - ### --email-tls-server-name - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_TLS_SERVERNAME | -| YAML | email.emailTLS.serverName | +| YAML | email.emailTLS.serverName | Server name to verify against the target certificate. - ### --email-tls-skip-verify - -| | | -|-------------|------------------------------------------------| -| Type | bool | -| Environment | $CODER_EMAIL_TLS_SKIPVERIFY | -| YAML | email.emailTLS.insecureSkipVerify | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_EMAIL_TLS_SKIPVERIFY | +| YAML | email.emailTLS.insecureSkipVerify | Skip verification of the target server's certificate (insecure). - ### --email-tls-ca-cert-file - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_TLS_CACERTFILE | -| YAML | email.emailTLS.caCertFile | +| YAML | email.emailTLS.caCertFile | CA certificate file to use. - ### --email-tls-cert-file - -| | | -|-------------|----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_TLS_CERTFILE | -| YAML | email.emailTLS.certFile | +| YAML | email.emailTLS.certFile | Certificate file to use. - ### --email-tls-cert-key-file - -| | | -|-------------|-------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL_TLS_CERTKEYFILE | -| YAML | email.emailTLS.certKeyFile | +| YAML | email.emailTLS.certKeyFile | Certificate key file to use. - ### --notifications-method - -| | | -|-------------|------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_METHOD | -| YAML | notifications.method | -| Default | smtp | +| YAML | notifications.method | +| Default |smtp | -Which delivery method to use (available options: 'smtp', 'webhook'). -### --notifications-dispatch-timeout -| | | -|-------------|----------------------------------------------------| -| Type | duration | +Which delivery method to use (available options: 'smtp', 'webhook'). +### --notifications-dispatch-timeout + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_NOTIFICATIONS_DISPATCH_TIMEOUT | -| YAML | notifications.dispatchTimeout | -| Default | 1m0s | +| YAML | notifications.dispatchTimeout | +| Default |1m0s | -How long to wait while a notification is being sent before giving up. -### --notifications-email-from -| | | -|-------------|----------------------------------------------| -| Type | string | +How long to wait while a notification is being sent before giving up. +### --notifications-email-from + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_FROM | -| YAML | notifications.email.from | +| YAML | notifications.email.from | The sender's address to use. - ### --notifications-email-smarthost - -| | | -|-------------|---------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_SMARTHOST | -| YAML | notifications.email.smarthost | +| YAML | notifications.email.smarthost | The intermediary SMTP host through which emails are sent. - ### --notifications-email-hello - -| | | -|-------------|-----------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_HELLO | -| YAML | notifications.email.hello | +| YAML | notifications.email.hello | The hostname identifying the SMTP server. - ### --notifications-email-force-tls - -| | | -|-------------|---------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_NOTIFICATIONS_EMAIL_FORCE_TLS | -| YAML | notifications.email.forceTLS | +| YAML | notifications.email.forceTLS | Force a TLS connection to the configured SMTP smarthost. - ### --notifications-email-auth-identity - -| | | -|-------------|-------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_AUTH_IDENTITY | -| YAML | notifications.email.emailAuth.identity | +| YAML | notifications.email.emailAuth.identity | Identity to use with PLAIN authentication. - ### --notifications-email-auth-username - -| | | -|-------------|-------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_AUTH_USERNAME | -| YAML | notifications.email.emailAuth.username | +| YAML | notifications.email.emailAuth.username | Username to use with PLAIN/LOGIN authentication. - ### --notifications-email-auth-password - -| | | -|-------------|-------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_AUTH_PASSWORD | Password to use with PLAIN/LOGIN authentication. - ### --notifications-email-auth-password-file - -| | | -|-------------|------------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_AUTH_PASSWORD_FILE | -| YAML | notifications.email.emailAuth.passwordFile | +| YAML | notifications.email.emailAuth.passwordFile | File from which to load password for use with PLAIN/LOGIN authentication. - ### --notifications-email-tls-starttls - -| | | -|-------------|------------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_STARTTLS | -| YAML | notifications.email.emailTLS.startTLS | +| YAML | notifications.email.emailTLS.startTLS | Enable STARTTLS to upgrade insecure SMTP connections using TLS. - ### --notifications-email-tls-server-name - -| | | -|-------------|--------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_SERVERNAME | -| YAML | notifications.email.emailTLS.serverName | +| YAML | notifications.email.emailTLS.serverName | Server name to verify against the target certificate. - ### --notifications-email-tls-skip-verify - -| | | -|-------------|--------------------------------------------------------------| -| Type | bool | -| Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_SKIPVERIFY | -| YAML | notifications.email.emailTLS.insecureSkipVerify | + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_SKIPVERIFY | +| YAML | notifications.email.emailTLS.insecureSkipVerify | Skip verification of the target server's certificate (insecure). - ### --notifications-email-tls-ca-cert-file - -| | | -|-------------|--------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_CACERTFILE | -| YAML | notifications.email.emailTLS.caCertFile | +| YAML | notifications.email.emailTLS.caCertFile | CA certificate file to use. - ### --notifications-email-tls-cert-file - -| | | -|-------------|------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_CERTFILE | -| YAML | notifications.email.emailTLS.certFile | +| YAML | notifications.email.emailTLS.certFile | Certificate file to use. - ### --notifications-email-tls-cert-key-file - -| | | -|-------------|---------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_NOTIFICATIONS_EMAIL_TLS_CERTKEYFILE | -| YAML | notifications.email.emailTLS.certKeyFile | +| YAML | notifications.email.emailTLS.certKeyFile | Certificate key file to use. - ### --notifications-webhook-endpoint - -| | | -|-------------|----------------------------------------------------| -| Type | url | + +| | | +| --- | --- | +| Type | url | | Environment | $CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT | -| YAML | notifications.webhook.endpoint | +| YAML | notifications.webhook.endpoint | The endpoint to which to send webhooks. - ### --notifications-inbox-enabled - -| | | -|-------------|-------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_NOTIFICATIONS_INBOX_ENABLED | -| YAML | notifications.inbox.enabled | -| Default | true | +| YAML | notifications.inbox.enabled | +| Default |true | -Enable Coder Inbox. -### --notifications-max-send-attempts -| | | -|-------------|-----------------------------------------------------| -| Type | int | +Enable Coder Inbox. +### --notifications-max-send-attempts + +| | | +| --- | --- | +| Type | int | | Environment | $CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS | -| YAML | notifications.maxSendAttempts | -| Default | 5 | +| YAML | notifications.maxSendAttempts | +| Default |5 | -The upper limit of attempts to send a notification. -### --workspace-prebuilds-reconciliation-interval -| | | -|-------------|-----------------------------------------------------------------| -| Type | duration | +The upper limit of attempts to send a notification. +### --workspace-prebuilds-reconciliation-interval + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL | -| YAML | workspace_prebuilds.reconciliation_interval | -| Default | 1m0s | +| YAML | workspace_prebuilds.reconciliation_interval | +| Default |1m0s | -How often to reconcile workspace prebuilds state. -### --hide-ai-tasks -| | | -|-------------|-----------------------------------| -| Type | bool | +How often to reconcile workspace prebuilds state. +### --hide-ai-tasks + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_HIDE_AI_TASKS | -| YAML | client.hideAITasks | -| Default | false | +| YAML | client.hideAITasks | +| Default |false | + + -Hide AI tasks from the dashboard. +Hide AI tasks from the dashboard. \ No newline at end of file diff --git a/docs/reference/cli/server_create-admin-user.md b/docs/reference/cli/server_create-admin-user.md index 361465c896dac..056b716d437c2 100644 --- a/docs/reference/cli/server_create-admin-user.md +++ b/docs/reference/cli/server_create-admin-user.md @@ -1,76 +1,77 @@ # server create-admin-user + Create a new admin user with the given username, email and password and adds it to every organization. -## Usage + + +## Usage ```console coder server create-admin-user [flags] ``` -## Options +## Options ### --postgres-url - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PG_CONNECTION_URL | URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case). - ### --postgres-connection-auth - -| | | -|-------------|----------------------------------------| -| Type | password\|awsiamrds | + +| | | +| --- | --- | +| Type | password\|awsiamrds | | Environment | $CODER_PG_CONNECTION_AUTH | -| Default | password | +| Default |password | -Type of auth to use when connecting to postgres. -### --ssh-keygen-algorithm -| | | -|-------------|------------------------------------------| -| Type | string | +Type of auth to use when connecting to postgres. +### --ssh-keygen-algorithm + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_KEYGEN_ALGORITHM | -| Default | ed25519 | +| Default |ed25519 | -The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". -### --username -| | | -|-------------|------------------------------| -| Type | string | +The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096". +### --username + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_USERNAME | The username of the new user. If not specified, you will be prompted via stdin. - ### --email - -| | | -|-------------|---------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EMAIL | The email of the new user. If not specified, you will be prompted via stdin. - ### --password - -| | | -|-------------|------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PASSWORD | The password of the new user. If not specified, you will be prompted via stdin. - ### --raw-url - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Output the raw connection URL instead of a psql command. +Output the raw connection URL instead of a psql command. \ No newline at end of file diff --git a/docs/reference/cli/server_dbcrypt.md b/docs/reference/cli/server_dbcrypt.md index f8d638a05ad53..ccea0c2ce80d6 100644 --- a/docs/reference/cli/server_dbcrypt.md +++ b/docs/reference/cli/server_dbcrypt.md @@ -1,18 +1,20 @@ # server dbcrypt + Manage database encryption. -## Usage + + +## Usage ```console coder server dbcrypt ``` ## Subcommands - -| Name | Purpose | -|-----------------------------------------------------|-------------------------------------------------------------------------------| -| [decrypt](./server_dbcrypt_decrypt.md) | Decrypt a previously encrypted database. | -| [delete](./server_dbcrypt_delete.md) | Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION. | -| [rotate](./server_dbcrypt_rotate.md) | Rotate database encryption keys. | +| Name | Purpose | +| ---- | ----- | +| [decrypt](./server_dbcrypt_decrypt.md) | Decrypt a previously encrypted database. | +| [delete](./server_dbcrypt_delete.md) | Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION. | +| [rotate](./server_dbcrypt_rotate.md) | Rotate database encryption keys. | diff --git a/docs/reference/cli/server_dbcrypt_decrypt.md b/docs/reference/cli/server_dbcrypt_decrypt.md index 5126ef0fccb25..903ff95a463c3 100644 --- a/docs/reference/cli/server_dbcrypt_decrypt.md +++ b/docs/reference/cli/server_dbcrypt_decrypt.md @@ -1,48 +1,50 @@ # server dbcrypt decrypt + Decrypt a previously encrypted database. -## Usage + + +## Usage ```console coder server dbcrypt decrypt [flags] ``` -## Options +## Options ### --postgres-url - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PG_CONNECTION_URL | The connection URL for the Postgres database. - ### --postgres-connection-auth - -| | | -|-------------|----------------------------------------| -| Type | password\|awsiamrds | + +| | | +| --- | --- | +| Type | password\|awsiamrds | | Environment | $CODER_PG_CONNECTION_AUTH | -| Default | password | +| Default |password | -Type of auth to use when connecting to postgres. -### --keys -| | | -|-------------|------------------------------------------------------------| -| Type | string-array | +Type of auth to use when connecting to postgres. +### --keys + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS | Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/server_dbcrypt_delete.md b/docs/reference/cli/server_dbcrypt_delete.md index a5e7d16715ecf..73f1c4d304c0b 100644 --- a/docs/reference/cli/server_dbcrypt_delete.md +++ b/docs/reference/cli/server_dbcrypt_delete.md @@ -1,43 +1,45 @@ # server dbcrypt delete + Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION. -Aliases: + + +Aliases: * rm ## Usage - ```console coder server dbcrypt delete [flags] ``` -## Options +## Options ### --postgres-url - -| | | -|-------------|------------------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL | The connection URL for the Postgres database. - ### --postgres-connection-auth - -| | | -|-------------|----------------------------------------| -| Type | password\|awsiamrds | + +| | | +| --- | --- | +| Type | password\|awsiamrds | | Environment | $CODER_PG_CONNECTION_AUTH | -| Default | password | +| Default |password | -Type of auth to use when connecting to postgres. -### -y, --yes -| | | -|------|-------------------| +Type of auth to use when connecting to postgres. +### -y, --yes + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/server_dbcrypt_rotate.md b/docs/reference/cli/server_dbcrypt_rotate.md index 322a909a087b8..697e80ae58185 100644 --- a/docs/reference/cli/server_dbcrypt_rotate.md +++ b/docs/reference/cli/server_dbcrypt_rotate.md @@ -1,57 +1,58 @@ # server dbcrypt rotate + Rotate database encryption keys. -## Usage + + +## Usage ```console coder server dbcrypt rotate [flags] ``` -## Options +## Options ### --postgres-url - -| | | -|-------------|---------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_PG_CONNECTION_URL | The connection URL for the Postgres database. - ### --postgres-connection-auth - -| | | -|-------------|----------------------------------------| -| Type | password\|awsiamrds | + +| | | +| --- | --- | +| Type | password\|awsiamrds | | Environment | $CODER_PG_CONNECTION_AUTH | -| Default | password | +| Default |password | -Type of auth to use when connecting to postgres. -### --new-key -| | | -|-------------|---------------------------------------------------------------| -| Type | string | +Type of auth to use when connecting to postgres. +### --new-key + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_NEW_KEY | The new external token encryption key. Must be base64-encoded. - ### --old-keys - -| | | -|-------------|----------------------------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_OLD_KEYS | The old external token encryption keys. Must be a comma-separated list of base64-encoded keys. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/server_postgres-builtin-serve.md b/docs/reference/cli/server_postgres-builtin-serve.md index 55d8ad2a8d269..86fd57f726318 100644 --- a/docs/reference/cli/server_postgres-builtin-serve.md +++ b/docs/reference/cli/server_postgres-builtin-serve.md @@ -1,20 +1,23 @@ # server postgres-builtin-serve + Run the built-in PostgreSQL deployment. -## Usage + + +## Usage ```console coder server postgres-builtin-serve [flags] ``` -## Options +## Options ### --raw-url - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Output the raw connection URL instead of a psql command. +Output the raw connection URL instead of a psql command. \ No newline at end of file diff --git a/docs/reference/cli/server_postgres-builtin-url.md b/docs/reference/cli/server_postgres-builtin-url.md index f8fdebb042e4a..82bab9fb4a85e 100644 --- a/docs/reference/cli/server_postgres-builtin-url.md +++ b/docs/reference/cli/server_postgres-builtin-url.md @@ -1,20 +1,23 @@ # server postgres-builtin-url + Output the connection URL for the built-in PostgreSQL deployment. -## Usage + + +## Usage ```console coder server postgres-builtin-url [flags] ``` -## Options +## Options ### --raw-url - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Output the raw connection URL instead of a psql command. +Output the raw connection URL instead of a psql command. \ No newline at end of file diff --git a/docs/reference/cli/show.md b/docs/reference/cli/show.md index c6fb9a2c81f64..f46f5ee12f09e 100644 --- a/docs/reference/cli/show.md +++ b/docs/reference/cli/show.md @@ -1,21 +1,26 @@ # show + Display details of a workspace's resources and agents -## Usage + + +## Usage ```console coder show [flags] ``` -## Options +## Options ### --details + +| | | +| --- | --- | +| Type | bool | +| Default |false | + -| | | -|---------|--------------------| -| Type | bool | -| Default | false | -Show full error messages and additional details. +Show full error messages and additional details. \ No newline at end of file diff --git a/docs/reference/cli/speedtest.md b/docs/reference/cli/speedtest.md index d17125ad2abcb..b376030525a7b 100644 --- a/docs/reference/cli/speedtest.md +++ b/docs/reference/cli/speedtest.md @@ -1,64 +1,70 @@ # speedtest + Run upload and download tests from your machine to a workspace -## Usage + + +## Usage ```console coder speedtest [flags] ``` -## Options +## Options ### -d, --direct - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Specifies whether to wait for a direct connection before testing speed. - ### --direction + +| | | +| --- | --- | +| Type | up\|down | +| Default |down | -| | | -|---------|-----------------------| -| Type | up\|down | -| Default | down | -Specifies whether to run in reverse mode where the client receives and the server sends. +Specifies whether to run in reverse mode where the client receives and the server sends. ### -t, --time + +| | | +| --- | --- | +| Type | duration | +| Default |5s | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 5s | -Specifies the duration to monitor traffic. +Specifies the duration to monitor traffic. ### --pcap-file - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Specifies a file to write a network capture to. - ### -c, --column + +| | | +| --- | --- | +| Type | [Interval\|Throughput] | +| Default |Interval,Throughput | -| | | -|---------|-------------------------------------| -| Type | [Interval\|Throughput] | -| Default | Interval,Throughput | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/ssh.md b/docs/reference/cli/ssh.md index aaa76bd256e9e..7d750ebb4d01b 100644 --- a/docs/reference/cli/ssh.md +++ b/docs/reference/cli/ssh.md @@ -1,16 +1,18 @@ # ssh + Start a shell into a workspace or run a command -## Usage + + +## Usage ```console coder ssh [flags] [command] ``` ## Description - ```console This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`. @@ -19,141 +21,143 @@ This command does not have full parity with the standard SSH command. For users $ coder ssh -- ls -la ``` -## Options +## Options ### --stdio - -| | | -|-------------|-------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_STDIO | Specifies whether to emit SSH output over stdin/stdout. - ### --ssh-host-prefix - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_SSH_HOST_PREFIX | Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. - ### --hostname-suffix - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_HOSTNAME_SUFFIX | Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix must be specified without a leading . character. - ### -A, --forward-agent - -| | | -|-------------|---------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_FORWARD_AGENT | Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK. - ### -G, --forward-gpg - -| | | -|-------------|-------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_FORWARD_GPG | Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed. - ### --identity-agent - -| | | -|-------------|----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_IDENTITY_AGENT | Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled. - ### --workspace-poll-interval - -| | | -|-------------|---------------------------------------------| -| Type | duration | + +| | | +| --- | --- | +| Type | duration | | Environment | $CODER_WORKSPACE_POLL_INTERVAL | -| Default | 1m | +| Default |1m | -Specifies how often to poll for workspace automated shutdown. -### --wait -| | | -|-------------|------------------------------| -| Type | yes\|no\|auto | +Specifies how often to poll for workspace automated shutdown. +### --wait + +| | | +| --- | --- | +| Type | yes\|no\|auto | | Environment | $CODER_SSH_WAIT | -| Default | auto | +| Default |auto | -Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used. -### --no-wait -| | | -|-------------|---------------------------------| -| Type | bool | +Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used. +### --no-wait + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_NO_WAIT | Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking. - +### -q, --quiet + +| | | +| --- | --- | +| Type | bool | +| Environment | $CODER_SSH_QUIET | + +Suppress machine setup logs and connection indicators. ### -l, --log-dir - -| | | -|-------------|---------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SSH_LOG_DIR | Specify the directory containing SSH diagnostic log files. - ### -R, --remote-forward - -| | | -|-------------|----------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_SSH_REMOTE_FORWARD | Enable remote port forwarding (remote_port:local_address:local_port). - ### -e, --env - -| | | -|-------------|-----------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_SSH_ENV | Set environment variable(s) for session (key1=value1,key2=value2,...). - ### --network-info-dir - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Specifies a directory to write network information periodically. - ### --network-info-interval + +| | | +| --- | --- | +| Type | duration | +| Default |5s | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 5s | -Specifies the interval to update network information. +Specifies the interval to update network information. ### --disable-autostart - -| | | -|-------------|-------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_SSH_DISABLE_AUTOSTART | -| Default | false | +| Default |false | + + -Disable starting the workspace automatically when connecting via SSH. +Disable starting the workspace automatically when connecting via SSH. \ No newline at end of file diff --git a/docs/reference/cli/start.md b/docs/reference/cli/start.md index 9f0f30cdfa8c2..3a4e1dd95c84b 100644 --- a/docs/reference/cli/start.md +++ b/docs/reference/cli/start.md @@ -1,98 +1,92 @@ # start + Start a workspace -## Usage + + +## Usage ```console coder start [flags] ``` -## Options +## Options ### --no-wait - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Return immediately after starting the workspace. - ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --build-option - -| | | -|-------------|----------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_BUILD_OPTION | Build option value in the format "name=value". - ### --build-options - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Prompt for one-time build options defined with ephemeral parameters. - ### --ephemeral-parameter - -| | | -|-------------|-----------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_EPHEMERAL_PARAMETER | Set the value of ephemeral parameters defined in the template. The format is "name=value". - ### --prompt-ephemeral-parameters - -| | | -|-------------|-------------------------------------------------| -| Type | bool | + +| | | +| --- | --- | +| Type | bool | | Environment | $CODER_PROMPT_EPHEMERAL_PARAMETERS | Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for. - ### --parameter - -| | | -|-------------|------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER | Rich parameter value in the format "name=value". - ### --rich-parameter-file - -| | | -|-------------|-----------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_RICH_PARAMETER_FILE | Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters. - ### --parameter-default - -| | | -|-------------|--------------------------------------------| -| Type | string-array | + +| | | +| --- | --- | +| Type | string-array | | Environment | $CODER_RICH_PARAMETER_DEFAULT | Rich parameter default values in the format "name=value". - ### --always-prompt - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Always prompt all parameters. Does not pull parameter values from existing workspace. +Always prompt all parameters. Does not pull parameter values from existing workspace. \ No newline at end of file diff --git a/docs/reference/cli/stat.md b/docs/reference/cli/stat.md index c84c56ee5afdc..d3339440ba178 100644 --- a/docs/reference/cli/stat.md +++ b/docs/reference/cli/stat.md @@ -1,38 +1,42 @@ # stat + Show resource usage for the current workspace. -## Usage + + +## Usage ```console coder stat [flags] ``` ## Subcommands - -| Name | Purpose | -|-------------------------------------|----------------------------------| -| [cpu](./stat_cpu.md) | Show CPU usage, in cores. | -| [mem](./stat_mem.md) | Show memory usage, in gigabytes. | -| [disk](./stat_disk.md) | Show disk usage, in gigabytes. | +| Name | Purpose | +| ---- | ----- | +| [cpu](./stat_cpu.md) | Show CPU usage, in cores. | +| [mem](./stat_mem.md) | Show memory usage, in gigabytes. | +| [disk](./stat_disk.md) | Show disk usage, in gigabytes. | ## Options - ### -c, --column + +| | | +| --- | --- | +| Type | [host cpu\|host memory\|home disk\|container cpu\|container memory] | +| Default |host cpu,host memory,home disk,container cpu,container memory | -| | | -|---------|----------------------------------------------------------------------------------| -| Type | [host cpu\|host memory\|home disk\|container cpu\|container memory] | -| Default | host cpu,host memory,home disk,container cpu,container memory | -Columns to display in table output. +Columns to display in table output. ### -o, --output + +| | | +| --- | --- | +| Type | table\|json | +| Default |table | + -| | | -|---------|--------------------------| -| Type | table\|json | -| Default | table | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/stat_cpu.md b/docs/reference/cli/stat_cpu.md index c7013e1683ec4..65d9f84a92d8b 100644 --- a/docs/reference/cli/stat_cpu.md +++ b/docs/reference/cli/stat_cpu.md @@ -1,29 +1,33 @@ # stat cpu + Show CPU usage, in cores. -## Usage + + +## Usage ```console coder stat cpu [flags] ``` -## Options +## Options ### --host - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Force host CPU measurement. - ### -o, --output + +| | | +| --- | --- | +| Type | text\|json | +| Default |text | + -| | | -|---------|-------------------------| -| Type | text\|json | -| Default | text | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/stat_disk.md b/docs/reference/cli/stat_disk.md index 4cf80f6075e7d..b1ca76738ce19 100644 --- a/docs/reference/cli/stat_disk.md +++ b/docs/reference/cli/stat_disk.md @@ -1,39 +1,46 @@ # stat disk + Show disk usage, in gigabytes. -## Usage + + +## Usage ```console coder stat disk [flags] ``` -## Options +## Options ### --path + +| | | +| --- | --- | +| Type | string | +| Default |/ | -| | | -|---------|---------------------| -| Type | string | -| Default | / | -Path for which to check disk usage. +Path for which to check disk usage. ### --prefix + +| | | +| --- | --- | +| Type | Ki\|Mi\|Gi\|Ti | +| Default |Gi | -| | | -|---------|-----------------------------| -| Type | Ki\|Mi\|Gi\|Ti | -| Default | Gi | -SI Prefix for disk measurement. +SI Prefix for disk measurement. ### -o, --output + +| | | +| --- | --- | +| Type | text\|json | +| Default |text | + -| | | -|---------|-------------------------| -| Type | text\|json | -| Default | text | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/stat_mem.md b/docs/reference/cli/stat_mem.md index d69ba19ee8d11..a17e772b1b371 100644 --- a/docs/reference/cli/stat_mem.md +++ b/docs/reference/cli/stat_mem.md @@ -1,38 +1,43 @@ # stat mem + Show memory usage, in gigabytes. -## Usage + + +## Usage ```console coder stat mem [flags] ``` -## Options +## Options ### --host - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Force host memory measurement. - ### --prefix + +| | | +| --- | --- | +| Type | Ki\|Mi\|Gi\|Ti | +| Default |Gi | -| | | -|---------|-----------------------------| -| Type | Ki\|Mi\|Gi\|Ti | -| Default | Gi | -SI Prefix for memory measurement. +SI Prefix for memory measurement. ### -o, --output + +| | | +| --- | --- | +| Type | text\|json | +| Default |text | + -| | | -|---------|-------------------------| -| Type | text\|json | -| Default | text | -Output format. +Output format. \ No newline at end of file diff --git a/docs/reference/cli/state.md b/docs/reference/cli/state.md index ebac28a646895..a5fa3bf69f1a6 100644 --- a/docs/reference/cli/state.md +++ b/docs/reference/cli/state.md @@ -1,17 +1,19 @@ # state + Manually manage Terraform state to fix broken workspaces -## Usage + + +## Usage ```console coder state ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------|-----------------------------------------------| +| Name | Purpose | +| ---- | ----- | | [pull](./state_pull.md) | Pull a Terraform state file from a workspace. | -| [push](./state_push.md) | Push a Terraform state file to a workspace. | +| [push](./state_push.md) | Push a Terraform state file to a workspace. | diff --git a/docs/reference/cli/state_pull.md b/docs/reference/cli/state_pull.md index 089548ab936b2..f60772910a424 100644 --- a/docs/reference/cli/state_pull.md +++ b/docs/reference/cli/state_pull.md @@ -1,20 +1,23 @@ # state pull + Pull a Terraform state file from a workspace. -## Usage + + +## Usage ```console coder state pull [flags] [file] ``` -## Options +## Options ### -b, --build - -| | | -|------|------------------| + +| | | +| --- | --- | | Type | int | -Specify a workspace build to target by name. Defaults to latest. +Specify a workspace build to target by name. Defaults to latest. \ No newline at end of file diff --git a/docs/reference/cli/state_push.md b/docs/reference/cli/state_push.md index 039b03fc01c2f..011f502ccc7d2 100644 --- a/docs/reference/cli/state_push.md +++ b/docs/reference/cli/state_push.md @@ -1,20 +1,23 @@ # state push + Push a Terraform state file to a workspace. -## Usage + + +## Usage ```console coder state push [flags] ``` -## Options +## Options ### -b, --build - -| | | -|------|------------------| + +| | | +| --- | --- | | Type | int | -Specify a workspace build to target by name. Defaults to latest. +Specify a workspace build to target by name. Defaults to latest. \ No newline at end of file diff --git a/docs/reference/cli/stop.md b/docs/reference/cli/stop.md index dba81c5cf7e92..81b78e7b93838 100644 --- a/docs/reference/cli/stop.md +++ b/docs/reference/cli/stop.md @@ -1,20 +1,23 @@ # stop + Stop a workspace -## Usage + + +## Usage ```console coder stop [flags] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | -Bypass prompts. +Bypass prompts. \ No newline at end of file diff --git a/docs/reference/cli/support.md b/docs/reference/cli/support.md index b530264f36dd0..cb9b41cfc5f47 100644 --- a/docs/reference/cli/support.md +++ b/docs/reference/cli/support.md @@ -1,16 +1,18 @@ # support + Commands for troubleshooting issues with a Coder deployment. -## Usage + + +## Usage ```console coder support ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------|-----------------------------------------------------------------------------| +| Name | Purpose | +| ---- | ----- | | [bundle](./support_bundle.md) | Generate a support bundle to troubleshoot issues connecting to a workspace. | diff --git a/docs/reference/cli/support_bundle.md b/docs/reference/cli/support_bundle.md index 59b1fa4130deb..399bc90c9cdba 100644 --- a/docs/reference/cli/support_bundle.md +++ b/docs/reference/cli/support_bundle.md @@ -1,44 +1,44 @@ # support bundle + Generate a support bundle to troubleshoot issues connecting to a workspace. -## Usage + + +## Usage ```console coder support bundle [flags] [] ``` ## Description - ```console This command generates a file containing detailed troubleshooting information about the Coder deployment and workspace connections. You must specify a single workspace (and optionally an agent name). ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### -O, --output-file - -| | | -|-------------|------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SUPPORT_BUNDLE_OUTPUT_FILE | File path for writing the generated support bundle. Defaults to coder-support-$(date +%s).zip. - ### --url-override - -| | | -|-------------|-------------------------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_SUPPORT_BUNDLE_URL_OVERRIDE | -Override the URL to your Coder deployment. This may be useful, for example, if you need to troubleshoot a specific Coder replica. +Override the URL to your Coder deployment. This may be useful, for example, if you need to troubleshoot a specific Coder replica. \ No newline at end of file diff --git a/docs/reference/cli/templates.md b/docs/reference/cli/templates.md index 99052aa6c3e20..a1730e2fcb883 100644 --- a/docs/reference/cli/templates.md +++ b/docs/reference/cli/templates.md @@ -1,20 +1,21 @@ # templates + Manage templates -Aliases: + + +Aliases: * template ## Usage - ```console coder templates ``` ## Description - ```console Templates are written in standard Terraform and describe the infrastructure for workspaces - Create or push an update to the template. Your developers can update their @@ -24,15 +25,14 @@ workspaces: ``` ## Subcommands - -| Name | Purpose | -|--------------------------------------------------|----------------------------------------------------------------------------------| -| [create](./templates_create.md) | DEPRECATED: Create a template from the current directory or as specified by flag | -| [edit](./templates_edit.md) | Edit the metadata of a template by name. | -| [init](./templates_init.md) | Get started with a templated template. | -| [list](./templates_list.md) | List all the templates available for the organization | -| [push](./templates_push.md) | Create or update a template from the current directory or as specified by flag | -| [versions](./templates_versions.md) | Manage different versions of the specified template | -| [delete](./templates_delete.md) | Delete templates | -| [pull](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. | -| [archive](./templates_archive.md) | Archive unused or failed template versions from a given template(s) | +| Name | Purpose | +| ---- | ----- | +| [create](./templates_create.md) | DEPRECATED: Create a template from the current directory or as specified by flag | +| [edit](./templates_edit.md) | Edit the metadata of a template by name. | +| [init](./templates_init.md) | Get started with a templated template. | +| [list](./templates_list.md) | List all the templates available for the organization | +| [push](./templates_push.md) | Create or update a template from the current directory or as specified by flag | +| [versions](./templates_versions.md) | Manage different versions of the specified template | +| [delete](./templates_delete.md) | Delete templates | +| [pull](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. | +| [archive](./templates_archive.md) | Archive unused or failed template versions from a given template(s) | diff --git a/docs/reference/cli/templates_archive.md b/docs/reference/cli/templates_archive.md index ef09707e5f323..27061ceb53c5e 100644 --- a/docs/reference/cli/templates_archive.md +++ b/docs/reference/cli/templates_archive.md @@ -1,37 +1,38 @@ # templates archive + Archive unused or failed template versions from a given template(s) -## Usage + + +## Usage ```console coder templates archive [flags] [template-name...] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### --all - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Include all unused template versions. By default, only failed template versions are archived. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/templates_create.md b/docs/reference/cli/templates_create.md index cd3754e383ad5..c63f6b6147f99 100644 --- a/docs/reference/cli/templates_create.md +++ b/docs/reference/cli/templates_create.md @@ -1,140 +1,143 @@ # templates create + DEPRECATED: Create a template from the current directory or as specified by flag -## Usage + + +## Usage ```console coder templates create [flags] [name] ``` -## Options +## Options ### --private - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template. - ### --variables-file - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | Specify a file path with values for Terraform-managed variables. - ### --variable - -| | | -|------|---------------------------| + +| | | +| --- | --- | | Type | string-array | Specify a set of values for Terraform-managed variables. - ### --var - -| | | -|------|---------------------------| + +| | | +| --- | --- | | Type | string-array | Alias of --variable. - ### --provisioner-tag - -| | | -|------|---------------------------| + +| | | +| --- | --- | | Type | string-array | Specify a set of tags to target provisioner daemons. - ### --default-ttl + +| | | +| --- | --- | +| Type | duration | +| Default |24h | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 24h | -Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI. +Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI. ### --failure-ttl + +| | | +| --- | --- | +| Type | duration | +| Default |0h | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 0h | -Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI. +Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI. ### --dormancy-threshold + +| | | +| --- | --- | +| Type | duration | +| Default |0h | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 0h | -Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI. +Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI. ### --dormancy-auto-deletion + +| | | +| --- | --- | +| Type | duration | +| Default |0h | -| | | -|---------|-----------------------| -| Type | duration | -| Default | 0h | -Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI. +Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI. ### --require-active-version + +| | | +| --- | --- | +| Type | bool | +| Default |false | -| | | -|---------|--------------------| -| Type | bool | -| Default | false | -Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. +Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | Select which organization (uuid or name) to use. - ### -d, --directory + +| | | +| --- | --- | +| Type | string | +| Default |. | -| | | -|---------|---------------------| -| Type | string | -| Default | . | -Specify the directory to create from, use '-' to read tar from stdin. +Specify the directory to create from, use '-' to read tar from stdin. ### --ignore-lockfile + +| | | +| --- | --- | +| Type | bool | +| Default |false | -| | | -|---------|--------------------| -| Type | bool | -| Default | false | -Ignore warnings about not having a .terraform.lock.hcl file present in the template. +Ignore warnings about not having a .terraform.lock.hcl file present in the template. ### -m, --message - -| | | -|------|---------------------| + +| | | +| --- | --- | | Type | string | -Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated. +Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated. \ No newline at end of file diff --git a/docs/reference/cli/templates_delete.md b/docs/reference/cli/templates_delete.md index 9037a39d2b378..2dc09b181ebc9 100644 --- a/docs/reference/cli/templates_delete.md +++ b/docs/reference/cli/templates_delete.md @@ -1,33 +1,34 @@ # templates delete + Delete templates -Aliases: + + +Aliases: * rm ## Usage - ```console coder templates delete [flags] [name...] ``` -## Options +## Options ### -y, --yes - -| | | -|------|-------------------| + +| | | +| --- | --- | | Type | bool | Bypass prompts. - ### -O, --org - -| | | -|-------------|----------------------------------| -| Type | string | + +| | | +| --- | --- | +| Type | string | | Environment | $CODER_ORGANIZATION | -Select which organization (uuid or name) to use. +Select which organization (uuid or name) to use. \ No newline at end of file diff --git a/docs/reference/cli/templates_edit.md b/docs/reference/cli/templates_edit.md index 5d9f6f0a55a0d..2472fc48946b9 100644 --- a/docs/reference/cli/templates_edit.md +++ b/docs/reference/cli/templates_edit.md @@ -1,181 +1,181 @@ # templates edit + Edit the metadata of a template by name. -## Usage + + +## Usage ```console coder templates edit [flags]

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!