2022-06-07 14:30:34 +00:00
{
2023-01-16 22:37:31 +00:00
"versions" : [ "main" ] ,
2022-06-07 15:56:05 +00:00
"routes" : [
{
"title" : "About" ,
"description" : "About Coder" ,
2022-06-15 19:03:13 +00:00
"path" : "./README.md" ,
2022-08-01 16:57:51 +00:00
"icon_path" : "./images/icons/home.svg" ,
2022-06-17 04:46:02 +00:00
"children" : [
{
"title" : "Architecture" ,
"description" : "Learn how Coder works" ,
2022-12-19 17:43:46 +00:00
"path" : "./about/architecture.md" ,
"icon_path" : "./images/icons/protractor.svg"
2022-06-17 04:46:02 +00:00
}
]
2022-06-07 15:56:05 +00:00
} ,
{
"title" : "Installation" ,
2022-06-09 18:46:16 +00:00
"description" : "How to install and deploy Coder" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/index.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/download.svg" ,
2022-06-16 22:54:15 +00:00
"children" : [
2022-06-22 20:25:06 +00:00
{
2022-09-08 19:41:00 +00:00
"title" : "Install script" ,
2022-10-17 19:27:38 +00:00
"description" : "One-line install script for macOS and Linux" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/install.sh.md"
2022-08-10 22:56:21 +00:00
} ,
{
2022-09-08 19:41:00 +00:00
"title" : "System packages" ,
2022-10-17 19:27:38 +00:00
"description" : "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/packages.md"
2022-08-10 22:56:21 +00:00
} ,
{
2022-09-08 19:41:00 +00:00
"title" : "Kubernetes" ,
2022-10-17 19:27:38 +00:00
"description" : "Install Coder with Kubernetes via Helm" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/kubernetes.md"
} ,
2023-03-20 08:48:53 +00:00
{
"title" : "OpenShift" ,
"description" : "Install Coder on OpenShift" ,
"path" : "./install/openshift.md"
} ,
2022-09-08 19:41:00 +00:00
{
"title" : "Docker" ,
2022-09-12 19:07:03 +00:00
"description" : "Install Coder with Docker / docker-compose" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/docker.md"
} ,
2023-01-31 17:26:37 +00:00
{
"title" : "Windows" ,
"description" : "Install Coder on Windows" ,
"path" : "./install/windows.md"
} ,
2022-09-08 19:41:00 +00:00
{
"title" : "Standalone binaries" ,
2022-10-17 19:27:38 +00:00
"description" : "Download binaries for macOS, Windows, and Linux" ,
2022-09-08 19:41:00 +00:00
"path" : "./install/binary.md"
2022-09-09 00:31:29 +00:00
} ,
2022-10-19 11:12:43 +00:00
{
"title" : "Offline deployments" ,
"description" : "Run Coder in offline / air-gapped environments" ,
"path" : "./install/offline.md"
} ,
2022-11-04 20:15:03 +00:00
{
"title" : "External database" ,
"description" : "Use external PostgreSQL database" ,
"path" : "./install/database.md"
} ,
2022-09-09 00:31:29 +00:00
{
"title" : "Uninstall" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to uninstall Coder" ,
2022-09-09 00:31:29 +00:00
"path" : "./install/uninstall.md"
2022-07-30 22:29:05 +00:00
}
2022-06-16 22:54:15 +00:00
]
2022-06-07 15:56:05 +00:00
} ,
2022-06-09 18:46:16 +00:00
{
2023-04-03 14:51:07 +00:00
"title" : "Platforms" ,
"description" : "Platform-specific guides using Coder" ,
2023-04-12 21:47:25 +00:00
"path" : "./platforms/README.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/star.svg" ,
2022-07-11 17:05:05 +00:00
"children" : [
2022-10-03 21:15:52 +00:00
{
"title" : "AWS" ,
2023-04-03 14:51:07 +00:00
"description" : "Set up Coder on an AWS EC2 VM" ,
"path" : "./platforms/aws.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/aws.svg"
2022-10-03 21:15:52 +00:00
} ,
2023-04-03 14:51:07 +00:00
{
"title" : "GCP" ,
"description" : "Set up Coder on a GCP Compute Engine VM" ,
"path" : "./platforms/google-cloud-platform.md" ,
"icon_path" : "./images/google-cloud.svg"
} ,
2022-10-03 21:15:52 +00:00
{
"title" : "Azure" ,
2023-04-03 14:51:07 +00:00
"description" : "Set up Coder on an Azure VM" ,
"path" : "./platforms/azure.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/azure.svg"
2023-04-03 14:51:07 +00:00
} ,
{
"title" : "Kubernetes" ,
"description" : "Set up Coder on Kubernetes" ,
2023-04-05 19:03:36 +00:00
"path" : "./platforms/kubernetes/index.md" ,
"children" : [
{
"title" : "Additional clusters" ,
"description" : "Deploy workspaces on additional Kubernetes clusters" ,
"path" : "./platforms/kubernetes/additional-clusters.md"
}
]
2023-04-03 14:51:07 +00:00
} ,
2023-04-12 21:47:25 +00:00
{
"title" : "Docker" ,
"description" : "Set up Coder with Docker" ,
"path" : "./platforms/docker.md" ,
"icon_path" : "./images/icons/docker.svg"
} ,
2023-04-03 14:51:07 +00:00
{
"title" : "Other platforms" ,
"description" : "Set up Coder on an another provider" ,
"path" : "./platforms/other.md"
2022-07-11 17:05:05 +00:00
}
]
2022-06-09 18:46:16 +00:00
} ,
2022-06-07 15:56:05 +00:00
{
"title" : "Templates" ,
2022-06-22 13:36:48 +00:00
"description" : "Learn about templates, which define the infrastructure underlying workspaces" ,
2023-06-02 20:56:06 +00:00
"path" : "./templates/index.md" ,
2022-08-01 16:57:51 +00:00
"icon_path" : "./images/icons/picture.svg" ,
2022-06-16 17:47:10 +00:00
"children" : [
2022-10-24 19:59:27 +00:00
{
"title" : "Resource Persistence" ,
"description" : "Learn how resource persistence works in Coder" ,
"path" : "./templates/resource-persistence.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/infinity.svg"
2022-10-24 19:59:27 +00:00
} ,
2022-06-19 20:45:14 +00:00
{
2022-07-20 12:31:33 +00:00
"title" : "Provider Authentication" ,
2022-06-19 20:45:14 +00:00
"description" : "Learn how to authenticate the provisioner" ,
2022-08-10 01:21:26 +00:00
"path" : "./templates/authentication.md" ,
"icon_path" : "./images/icons/key.svg"
} ,
2022-10-12 15:43:59 +00:00
{
"title" : "Change Management" ,
"description" : "Learn how to source-control templates with git and CI" ,
"path" : "./templates/change-management.md" ,
"icon_path" : "./images/icons/git.svg"
} ,
2022-08-10 01:21:26 +00:00
{
"title" : "Resource Metadata" ,
"description" : "Learn how to expose resource data to users" ,
"path" : "./templates/resource-metadata.md" ,
"icon_path" : "./images/icons/table-rows.svg"
2022-09-19 16:33:31 +00:00
} ,
2023-03-31 20:26:19 +00:00
{
"title" : "Agent Metadata" ,
"description" : "Learn how to expose live agent information to users" ,
"path" : "./templates/agent-metadata.md" ,
2023-06-27 11:35:01 +00:00
"icon_path" : "./images/icons/table-rows.svg"
2023-03-31 20:26:19 +00:00
} ,
2023-03-09 16:19:48 +00:00
{
"title" : "Parameters" ,
"description" : "Use parameters to customize templates" ,
"path" : "./templates/parameters.md" ,
"icon_path" : "./images/icons/code.svg"
2023-03-30 16:12:47 +00:00
} ,
{
"title" : "Open in Coder" ,
"description" : "Learn how to add an \"Open in Coder\" button to your repos" ,
"path" : "./templates/open-in-coder.md" ,
"icon_path" : "./images/icons/key.svg"
2023-04-12 21:47:25 +00:00
} ,
{
"title" : "Docker in Workspaces" ,
"description" : "Use docker inside containerized templates" ,
"path" : "./templates/docker-in-workspaces.md" ,
"icon_path" : "./images/icons/docker.svg"
2022-06-19 20:45:14 +00:00
}
]
2022-06-07 15:56:05 +00:00
} ,
{
"title" : "Workspaces" ,
"description" : "Learn about Coder workspaces." ,
2022-12-19 17:43:46 +00:00
"path" : "./workspaces.md" ,
"icon_path" : "./images/icons/layers.svg"
2022-06-07 15:56:05 +00:00
} ,
2022-06-16 23:09:40 +00:00
{
"title" : "IDEs" ,
2022-06-22 13:36:48 +00:00
"description" : "Learn how to use your IDE of choice with Coder" ,
2022-06-19 20:45:14 +00:00
"path" : "./ides.md" ,
2022-08-10 01:07:51 +00:00
"icon_path" : "./images/icons/code.svg" ,
2022-06-19 20:45:14 +00:00
"children" : [
{
2022-08-10 01:10:09 +00:00
"title" : "Web IDEs" ,
2022-06-19 20:45:14 +00:00
"description" : "Learn how to configure web IDEs in your templates" ,
2022-08-10 01:10:09 +00:00
"path" : "./ides/web-ides.md"
2022-07-30 22:29:05 +00:00
} ,
{
2022-08-10 01:10:09 +00:00
"title" : "JetBrains Gateway" ,
2022-07-31 20:06:05 +00:00
"description" : "Learn how to configure JetBrains Gateway for your workspaces" ,
2022-08-10 01:10:09 +00:00
"path" : "./ides/gateway.md"
2022-08-01 21:47:22 +00:00
} ,
{
2022-08-10 01:10:09 +00:00
"title" : "Emacs" ,
2022-08-01 21:47:22 +00:00
"description" : "Learn how to configure Emacs with TRAMP in Coder" ,
2022-08-10 01:10:09 +00:00
"path" : "./ides/emacs-tramp.md"
2022-08-21 01:59:40 +00:00
} ,
{
"title" : "Remote Desktops" ,
"description" : "Learn how to use Remote Desktops with Coder" ,
"path" : "./ides/remote-desktops.md"
2022-06-19 20:45:14 +00:00
}
]
2022-06-16 23:09:40 +00:00
} ,
2022-08-07 22:22:47 +00:00
{
2022-09-12 19:07:03 +00:00
"title" : "Networking" ,
"description" : "Learn about networking in Coder" ,
2023-06-02 20:56:06 +00:00
"path" : "./networking/index.md" ,
2022-09-12 19:07:03 +00:00
"icon_path" : "./images/icons/networking.svg" ,
"children" : [
{
"title" : "Port Forwarding" ,
"description" : "Learn how to forward ports in Coder" ,
"path" : "./networking/port-forwarding.md"
}
]
2022-08-07 22:22:47 +00:00
} ,
2022-06-16 23:48:18 +00:00
{
"title" : "Dotfiles" ,
"description" : "Learn how to personalize your workspace" ,
2022-12-19 17:43:46 +00:00
"path" : "./dotfiles.md" ,
"icon_path" : "./images/icons/art-pad.svg"
2022-06-16 23:48:18 +00:00
} ,
2022-06-22 13:36:48 +00:00
{
2022-07-20 12:31:33 +00:00
"title" : "Secrets" ,
2022-12-19 17:43:46 +00:00
"description" : "Learn how to use secrets in your workspace" ,
"path" : "./secrets.md" ,
"icon_path" : "./images/icons/secrets.svg"
2022-07-20 12:31:33 +00:00
} ,
{
2022-09-08 19:41:00 +00:00
"title" : "Administration" ,
"description" : "How to install and deploy Coder" ,
2023-04-12 21:47:25 +00:00
"path" : "./admin/README.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/wrench.svg" ,
2022-09-08 19:41:00 +00:00
"children" : [
2022-10-11 18:34:41 +00:00
{
"title" : "Authentication" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to set up authentication using GitHub or OpenID Connect" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/auth.md" ,
"icon_path" : "./images/icons/key.svg"
2022-10-11 18:34:41 +00:00
} ,
2022-09-08 19:41:00 +00:00
{
"title" : "Users" ,
"description" : "Learn about user roles available in Coder and how to create and manage users" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/users.md" ,
"icon_path" : "./images/icons/users.svg"
2022-09-08 19:41:00 +00:00
} ,
{
2022-10-11 18:34:41 +00:00
"title" : "Groups" ,
"description" : "Learn how to manage user groups" ,
"path" : "./admin/groups.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/group.svg" ,
2022-10-11 18:34:41 +00:00
"state" : "enterprise"
} ,
{
"title" : "RBAC" ,
"description" : "Learn how to use the role based access control" ,
"path" : "./admin/rbac.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/rbac.svg" ,
2022-10-11 18:34:41 +00:00
"state" : "enterprise"
2022-09-08 19:41:00 +00:00
} ,
{
"title" : "Configuration" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to configure Coder" ,
2022-09-28 15:12:31 +00:00
"path" : "./admin/configure.md" ,
"icon_path" : "./images/icons/toggle_on.svg"
2022-09-08 19:41:00 +00:00
} ,
2022-11-07 19:04:00 +00:00
{
"title" : "Git Providers" ,
"description" : "Learn how connect Coder with external git providers" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/git-providers.md" ,
"icon_path" : "./images/icons/git.svg"
2022-11-07 19:04:00 +00:00
} ,
2022-09-08 19:41:00 +00:00
{
"title" : "Upgrading" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to upgrade Coder" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/upgrade.md" ,
"icon_path" : "./images/icons/upgrade.svg"
2022-09-09 20:10:39 +00:00
} ,
2022-10-12 15:43:59 +00:00
{
"title" : "Automation" ,
"description" : "Learn how to automate Coder with the CLI and API" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/automation.md" ,
"icon_path" : "./images/icons/plug.svg"
2022-10-12 15:43:59 +00:00
} ,
2023-01-19 15:12:39 +00:00
{
"title" : "Scaling Coder" ,
"description" : "Reference architecture and load testing tools" ,
2023-01-19 18:16:36 +00:00
"path" : "./admin/scale.md" ,
"icon_path" : "./images/icons/scale.svg"
2023-01-19 15:12:39 +00:00
} ,
2023-03-03 23:49:03 +00:00
{
2023-05-15 18:38:49 +00:00
"title" : "Provisioners" ,
2023-03-03 23:49:03 +00:00
"description" : "Run provisioners isolated from the Coder server" ,
"path" : "./admin/provisioners.md" ,
"icon_path" : "./images/icons/queue.svg" ,
"state" : "enterprise"
} ,
2023-05-04 18:30:06 +00:00
{
2023-05-15 18:38:49 +00:00
"title" : "Workspace Proxies" ,
2023-05-04 18:30:06 +00:00
"description" : "Run geo distributed workspace proxies" ,
"path" : "./admin/workspace-proxies.md" ,
"icon_path" : "./images/icons/networking.svg" ,
"state" : "enterprise"
} ,
2023-06-22 21:25:17 +00:00
{
"title" : "Application Logs" ,
"description" : "Learn how to use Application Logs in your Coder deployment" ,
"path" : "./admin/app-logs.md" ,
"icon_path" : "./images/icons/notes.svg"
} ,
2022-09-12 01:04:56 +00:00
{
"title" : "Audit Logs" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to use Audit Logs in your Coder deployment" ,
2022-10-08 04:44:41 +00:00
"path" : "./admin/audit-logs.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/radar.svg" ,
2022-10-08 04:44:41 +00:00
"state" : "enterprise"
2022-09-12 01:04:56 +00:00
} ,
2022-10-04 20:55:43 +00:00
{
"title" : "Quotas" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn how to use Workspace Quotas in Coder" ,
2022-10-08 04:44:41 +00:00
"path" : "./admin/quotas.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/dollar.svg" ,
2022-10-08 04:44:41 +00:00
"state" : "enterprise"
2022-10-04 20:55:43 +00:00
} ,
2022-10-17 19:27:38 +00:00
{
"title" : "High Availability" ,
"description" : "Learn how to configure Coder for High Availability" ,
"path" : "./admin/high-availability.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/hydra.svg" ,
2022-10-17 19:27:38 +00:00
"state" : "enterprise"
} ,
2022-11-30 16:39:51 +00:00
{
"title" : "Prometheus" ,
"description" : "Learn how to collect Prometheus metrics" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/prometheus.md" ,
"icon_path" : "./images/icons/speed.svg"
2022-11-30 16:39:51 +00:00
} ,
2022-12-06 18:38:38 +00:00
{
2023-04-14 17:28:34 +00:00
"title" : "Appearance" ,
"description" : "Learn how to configure the appearance of Coder" ,
"path" : "./admin/appearance.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/info.svg" ,
2022-12-06 18:38:38 +00:00
"state" : "enterprise"
} ,
2022-10-04 04:03:46 +00:00
{
"title" : "Telemetry" ,
2022-10-17 19:27:38 +00:00
"description" : "Learn what usage telemetry Coder collects" ,
2022-12-19 17:43:46 +00:00
"path" : "./admin/telemetry.md" ,
"icon_path" : "./images/icons/science.svg"
2022-10-04 04:03:46 +00:00
}
]
} ,
2022-10-24 18:10:06 +00:00
{
"title" : "Enterprise" ,
"description" : "Learn how to enable Enterprise features" ,
2022-12-19 17:43:46 +00:00
"path" : "./enterprise.md" ,
"icon_path" : "./images/icons/group.svg"
2022-10-24 18:10:06 +00:00
} ,
2022-06-07 15:56:05 +00:00
{
"title" : "Contributing" ,
2022-06-22 13:36:48 +00:00
"description" : "Learn how to contribute to Coder" ,
2022-06-07 15:56:05 +00:00
"path" : "./CONTRIBUTING.md" ,
2022-12-19 17:43:46 +00:00
"icon_path" : "./images/icons/contributing.svg" ,
2022-06-07 15:56:05 +00:00
"children" : [
2022-06-07 14:30:34 +00:00
{
2022-06-07 15:56:05 +00:00
"title" : "Code of Conduct" ,
2022-06-22 13:36:48 +00:00
"description" : "See the code of conduct for contributing to Coder" ,
2022-06-16 17:47:10 +00:00
"path" : "./contributing/CODE_OF_CONDUCT.md"
2022-06-07 14:30:34 +00:00
} ,
2023-02-15 21:51:31 +00:00
{
"title" : "Feature stages" ,
"description" : "Policies for Alpha and Experimental features." ,
"path" : "./contributing/feature-stages.md"
} ,
2022-10-10 23:33:25 +00:00
{
"title" : "Documentation" ,
"description" : "Our style guide for use when authoring documentation" ,
"path" : "./contributing/documentation.md"
} ,
2022-06-07 14:30:34 +00:00
{
2022-06-16 12:30:56 +00:00
"title" : "Security" ,
2022-06-09 18:46:16 +00:00
"description" : "How to report vulnerabilities in Coder" ,
2022-06-16 17:47:10 +00:00
"path" : "./contributing/SECURITY.md"
2023-01-25 16:15:06 +00:00
} ,
{
"title" : "Frontend" ,
"description" : "Our guide for frontend development" ,
"path" : "./contributing/frontend.md"
2022-06-07 14:30:34 +00:00
}
2022-06-07 15:56:05 +00:00
]
2022-12-19 17:43:46 +00:00
} ,
{
"title" : "API" ,
"description" : "Learn how to use Coderd API" ,
"path" : "./api/index.md" ,
"icon_path" : "./images/icons/api.svg" ,
"children" : [
2022-12-22 14:53:14 +00:00
{
"title" : "General" ,
"path" : "./api/general.md"
} ,
2023-01-11 15:05:42 +00:00
{
"title" : "Agents" ,
"path" : "./api/agents.md"
} ,
2022-12-21 14:37:30 +00:00
{
"title" : "Applications" ,
"path" : "./api/applications.md"
} ,
2023-04-20 23:59:45 +00:00
{
"title" : "Applications Enterprise" ,
"path" : "./api/applications enterprise.md"
} ,
2023-01-03 18:21:10 +00:00
{
"title" : "Audit" ,
"path" : "./api/audit.md"
} ,
2023-01-11 15:05:42 +00:00
{
"title" : "Authentication" ,
"path" : "./api/authentication.md"
} ,
2022-12-21 14:37:30 +00:00
{
"title" : "Authorization" ,
"path" : "./api/authorization.md"
} ,
2023-01-03 18:21:10 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Builds" ,
"path" : "./api/builds.md"
2023-01-03 18:21:10 +00:00
} ,
2023-01-25 21:27:36 +00:00
{
"title" : "Debug" ,
"path" : "./api/debug.md"
} ,
2022-12-19 17:43:46 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Enterprise" ,
"path" : "./api/enterprise.md"
2023-01-11 11:16:09 +00:00
} ,
{
2023-01-11 15:05:42 +00:00
"title" : "Files" ,
"path" : "./api/files.md"
2022-12-19 17:43:46 +00:00
} ,
2023-06-29 18:58:01 +00:00
{
"title" : "Git" ,
"path" : "./api/git.md"
} ,
2023-01-26 01:03:47 +00:00
{
"title" : "Insights" ,
"path" : "./api/insights.md"
} ,
2022-12-19 17:43:46 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Members" ,
"path" : "./api/members.md"
2022-12-19 17:43:46 +00:00
} ,
2023-01-11 11:16:09 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Organizations" ,
"path" : "./api/organizations.md"
2023-01-11 11:16:09 +00:00
} ,
2023-01-05 14:27:10 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Schemas" ,
"path" : "./api/schemas.md"
2023-01-05 14:27:10 +00:00
} ,
{
2023-01-11 15:05:42 +00:00
"title" : "Templates" ,
"path" : "./api/templates.md"
2023-01-05 14:27:10 +00:00
} ,
2023-01-11 13:08:04 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Users" ,
"path" : "./api/users.md"
2023-01-11 13:08:04 +00:00
} ,
2023-04-25 14:37:52 +00:00
{
"title" : "WorkspaceProxies" ,
"path" : "./api/workspaceproxies.md"
} ,
2022-12-19 17:43:46 +00:00
{
2023-01-11 15:05:42 +00:00
"title" : "Workspaces" ,
"path" : "./api/workspaces.md"
2022-12-19 17:43:46 +00:00
}
]
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "Command Line" ,
"description" : "Learn how to use Coder CLI" ,
2023-02-23 01:53:21 +00:00
"path" : "./cli.md" ,
2023-01-27 18:10:40 +00:00
"icon_path" : "./images/icons/terminal.svg" ,
"children" : [
2023-03-23 22:42:20 +00:00
{
"title" : "coder" ,
"path" : "cli.md"
} ,
2023-01-27 18:10:40 +00:00
{
"title" : "config-ssh" ,
2023-03-23 22:42:20 +00:00
"description" : "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"" ,
"path" : "cli/config-ssh.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "create" ,
2023-03-23 22:42:20 +00:00
"description" : "Create a workspace" ,
"path" : "cli/create.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "delete" ,
2023-03-23 22:42:20 +00:00
"description" : "Delete a workspace" ,
"path" : "cli/delete.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "dotfiles" ,
2023-03-23 22:42:20 +00:00
"description" : "Personalize your workspace by applying a canonical dotfiles repository" ,
"path" : "cli/dotfiles.md"
} ,
{
"title" : "features" ,
"description" : "List Enterprise features" ,
"path" : "cli/features.md"
} ,
{
"title" : "features list" ,
"path" : "cli/features_list.md"
} ,
{
"title" : "groups" ,
"description" : "Manage groups" ,
"path" : "cli/groups.md"
} ,
{
"title" : "groups create" ,
"description" : "Create a user group" ,
"path" : "cli/groups_create.md"
} ,
{
"title" : "groups delete" ,
"description" : "Delete a user group" ,
"path" : "cli/groups_delete.md"
} ,
{
"title" : "groups edit" ,
"description" : "Edit a user group" ,
"path" : "cli/groups_edit.md"
} ,
{
"title" : "groups list" ,
"description" : "List user groups" ,
"path" : "cli/groups_list.md"
} ,
{
"title" : "licenses" ,
"description" : "Add, delete, and list licenses" ,
"path" : "cli/licenses.md"
} ,
{
"title" : "licenses add" ,
"description" : "Add license to Coder deployment" ,
"path" : "cli/licenses_add.md"
} ,
{
"title" : "licenses delete" ,
"description" : "Delete license by ID" ,
"path" : "cli/licenses_delete.md"
} ,
{
"title" : "licenses list" ,
"description" : "List licenses (including expired)" ,
"path" : "cli/licenses_list.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "list" ,
2023-03-23 22:42:20 +00:00
"description" : "List workspaces" ,
"path" : "cli/list.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "login" ,
2023-03-23 22:42:20 +00:00
"description" : "Authenticate with Coder deployment" ,
"path" : "cli/login.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "logout" ,
2023-03-23 22:42:20 +00:00
"description" : "Unauthenticate your local session" ,
"path" : "cli/logout.md"
2023-01-27 18:10:40 +00:00
} ,
2023-02-13 16:38:00 +00:00
{
"title" : "ping" ,
2023-03-23 22:42:20 +00:00
"description" : "Ping a workspace" ,
"path" : "cli/ping.md"
2023-02-13 16:38:00 +00:00
} ,
2023-01-27 18:10:40 +00:00
{
"title" : "port-forward" ,
2023-03-23 22:42:20 +00:00
"description" : "Forward ports from machine to a workspace" ,
"path" : "cli/port-forward.md"
} ,
{
"title" : "provisionerd" ,
"description" : "Manage provisioner daemons" ,
"path" : "cli/provisionerd.md"
} ,
{
"title" : "provisionerd start" ,
"description" : "Run a provisioner daemon" ,
"path" : "cli/provisionerd_start.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "publickey" ,
2023-03-23 22:42:20 +00:00
"description" : "Output your Coder public key used for Git operations" ,
"path" : "cli/publickey.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "rename" ,
2023-03-23 22:42:20 +00:00
"description" : "Rename a workspace" ,
"path" : "cli/rename.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "reset-password" ,
2023-03-23 22:42:20 +00:00
"description" : "Directly connect to the database to reset a user's password" ,
"path" : "cli/reset-password.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "restart" ,
2023-03-23 22:42:20 +00:00
"description" : "Restart a workspace" ,
"path" : "cli/restart.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "scaletest" ,
2023-03-23 22:42:20 +00:00
"description" : "Run a scale test against the Coder API" ,
"path" : "cli/scaletest.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "scaletest cleanup" ,
2023-03-23 22:42:20 +00:00
"description" : "Cleanup scaletest workspaces, then cleanup scaletest users." ,
"path" : "cli/scaletest_cleanup.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "scaletest create-workspaces" ,
2023-03-23 22:42:20 +00:00
"description" : "Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard." ,
"path" : "cli/scaletest_create-workspaces.md"
2023-01-27 18:10:40 +00:00
} ,
2023-05-05 09:34:58 +00:00
{
"title" : "scaletest workspace-traffic" ,
"description" : "Generate traffic to scaletest workspaces through coderd" ,
"path" : "cli/scaletest_workspace-traffic.md"
} ,
2023-01-27 18:10:40 +00:00
{
"title" : "schedule" ,
2023-03-23 22:42:20 +00:00
"description" : "Schedule automated start and stop times for workspaces" ,
"path" : "cli/schedule.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "schedule override-stop" ,
2023-03-23 22:42:20 +00:00
"description" : "Override the stop time of a currently running workspace instance." ,
"path" : "cli/schedule_override-stop.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "schedule show" ,
2023-03-23 22:42:20 +00:00
"description" : "Show workspace schedule" ,
"path" : "cli/schedule_show.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "schedule start" ,
2023-03-23 22:42:20 +00:00
"description" : "Edit workspace start schedule" ,
"path" : "cli/schedule_start.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "schedule stop" ,
2023-03-23 22:42:20 +00:00
"description" : "Edit workspace stop schedule" ,
"path" : "cli/schedule_stop.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "server" ,
2023-03-23 22:42:20 +00:00
"description" : "Start a Coder server" ,
"path" : "cli/server.md"
2023-01-27 18:10:40 +00:00
} ,
2023-02-06 14:58:21 +00:00
{
"title" : "server create-admin-user" ,
2023-03-23 22:42:20 +00:00
"description" : "Create a new admin user with the given username, email and password and adds it to every organization." ,
"path" : "cli/server_create-admin-user.md"
2023-02-06 14:58:21 +00:00
} ,
2023-01-27 18:10:40 +00:00
{
"title" : "server postgres-builtin-serve" ,
2023-03-23 22:42:20 +00:00
"description" : "Run the built-in PostgreSQL deployment." ,
"path" : "cli/server_postgres-builtin-serve.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "server postgres-builtin-url" ,
2023-03-23 22:42:20 +00:00
"description" : "Output the connection URL for the built-in PostgreSQL deployment." ,
"path" : "cli/server_postgres-builtin-url.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "show" ,
2023-03-23 22:42:20 +00:00
"description" : "Display details of a workspace's resources and agents" ,
"path" : "cli/show.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "speedtest" ,
2023-03-23 22:42:20 +00:00
"description" : "Run upload and download tests from your machine to a workspace" ,
"path" : "cli/speedtest.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "ssh" ,
2023-03-23 22:42:20 +00:00
"description" : "Start a shell into a workspace" ,
"path" : "cli/ssh.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "start" ,
2023-03-23 22:42:20 +00:00
"description" : "Start a workspace" ,
"path" : "cli/start.md"
2023-01-27 18:10:40 +00:00
} ,
2023-06-20 09:16:57 +00:00
{
"title" : "stat" ,
"description" : "Show resource usage for the current workspace." ,
"path" : "cli/stat.md"
} ,
{
"title" : "stat cpu" ,
"description" : "Show CPU usage, in cores." ,
"path" : "cli/stat_cpu.md"
} ,
{
"title" : "stat disk" ,
"description" : "Show disk usage, in gigabytes." ,
"path" : "cli/stat_disk.md"
} ,
{
"title" : "stat mem" ,
"description" : "Show memory usage, in gigabytes." ,
"path" : "cli/stat_mem.md"
} ,
2023-01-27 18:10:40 +00:00
{
"title" : "state" ,
2023-03-23 22:42:20 +00:00
"description" : "Manually manage Terraform state to fix broken workspaces" ,
"path" : "cli/state.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "state pull" ,
2023-03-23 22:42:20 +00:00
"description" : "Pull a Terraform state file from a workspace." ,
"path" : "cli/state_pull.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "state push" ,
2023-03-23 22:42:20 +00:00
"description" : "Push a Terraform state file to a workspace." ,
"path" : "cli/state_push.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "stop" ,
2023-03-23 22:42:20 +00:00
"description" : "Stop a workspace" ,
"path" : "cli/stop.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates" ,
2023-03-23 22:42:20 +00:00
"description" : "Manage templates" ,
"path" : "cli/templates.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates create" ,
2023-03-23 22:42:20 +00:00
"description" : "Create a template from the current directory or as specified by flag" ,
"path" : "cli/templates_create.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates delete" ,
2023-03-23 22:42:20 +00:00
"description" : "Delete templates" ,
"path" : "cli/templates_delete.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates edit" ,
2023-03-23 22:42:20 +00:00
"description" : "Edit the metadata of a template by name." ,
"path" : "cli/templates_edit.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates init" ,
2023-03-23 22:42:20 +00:00
"description" : "Get started with a templated template." ,
"path" : "cli/templates_init.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates list" ,
2023-03-23 22:42:20 +00:00
"description" : "List all the templates available for the organization" ,
"path" : "cli/templates_list.md"
} ,
{
"title" : "templates plan" ,
"description" : "Plan a template push from the current directory" ,
"path" : "cli/templates_plan.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates pull" ,
2023-03-23 22:42:20 +00:00
"description" : "Download the latest version of a template to a path." ,
"path" : "cli/templates_pull.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates push" ,
2023-03-23 22:42:20 +00:00
"description" : "Push a new template version from the current directory or as specified by flag" ,
"path" : "cli/templates_push.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates versions" ,
2023-03-23 22:42:20 +00:00
"description" : "Manage different versions of the specified template" ,
"path" : "cli/templates_versions.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "templates versions list" ,
2023-03-23 22:42:20 +00:00
"description" : "List all the versions of the specified template" ,
"path" : "cli/templates_versions_list.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "tokens" ,
2023-03-23 22:42:20 +00:00
"description" : "Manage personal access tokens" ,
"path" : "cli/tokens.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "tokens create" ,
2023-03-23 22:42:20 +00:00
"description" : "Create a token" ,
"path" : "cli/tokens_create.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "tokens list" ,
2023-03-23 22:42:20 +00:00
"description" : "List tokens" ,
"path" : "cli/tokens_list.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "tokens remove" ,
2023-03-23 22:42:20 +00:00
"description" : "Delete a token" ,
"path" : "cli/tokens_remove.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "update" ,
2023-03-23 22:42:20 +00:00
"description" : "Will update and start a given workspace if it is out of date" ,
"path" : "cli/update.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users" ,
2023-03-23 22:42:20 +00:00
"description" : "Manage users" ,
"path" : "cli/users.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users activate" ,
2023-03-23 22:42:20 +00:00
"description" : "Update a user's status to 'active'. Active users can fully interact with the platform" ,
"path" : "cli/users_activate.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users create" ,
2023-03-23 22:42:20 +00:00
"path" : "cli/users_create.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users list" ,
2023-03-23 22:42:20 +00:00
"path" : "cli/users_list.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users show" ,
2023-03-23 22:42:20 +00:00
"description" : "Show a single user. Use 'me' to indicate the currently authenticated user." ,
"path" : "cli/users_show.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "users suspend" ,
2023-03-23 22:42:20 +00:00
"description" : "Update a user's status to 'suspended'. A suspended user cannot log into the platform" ,
"path" : "cli/users_suspend.md"
2023-01-27 18:10:40 +00:00
} ,
{
"title" : "version" ,
2023-03-23 22:42:20 +00:00
"description" : "Show coder version" ,
"path" : "cli/version.md"
2023-01-27 18:10:40 +00:00
}
]
2023-04-25 15:56:09 +00:00
} ,
{
"title" : "Security" ,
"description" : "Security advisories" ,
"path" : "./security/index.md" ,
"icon_path" : "./images/icons/security.svg" ,
"children" : [
{
"title" : "API tokens of deleted users not invalidated" ,
"description" : "Fixed in v0.23.0 (Apr 25, 2023)" ,
"path" : "./security/0001_user_apikeys_invalidation.md"
}
]
2022-06-07 15:56:05 +00:00
}
]
2022-06-07 14:30:34 +00:00
}