{ "versions": ["main"], "routes": [ { "title": "About", "description": "About Coder", "path": "./README.md", "icon_path": "./images/icons/home.svg", "children": [ { "title": "Architecture", "description": "Learn how Coder works", "path": "./about/architecture.md", "icon_path": "./images/icons/protractor.svg" } ] }, { "title": "Installation", "description": "How to install and deploy Coder", "path": "./install/index.md", "icon_path": "./images/icons/download.svg", "children": [ { "title": "Install script", "description": "One-line install script for macOS and Linux", "path": "./install/install.sh.md" }, { "title": "System packages", "description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine", "path": "./install/packages.md" }, { "title": "Kubernetes", "description": "Install Coder with Kubernetes via Helm", "path": "./install/kubernetes.md" }, { "title": "Docker", "description": "Install Coder with Docker / docker-compose", "path": "./install/docker.md" }, { "title": "Standalone binaries", "description": "Download binaries for macOS, Windows, and Linux", "path": "./install/binary.md" }, { "title": "Offline deployments", "description": "Run Coder in offline / air-gapped environments", "path": "./install/offline.md" }, { "title": "External database", "description": "Use external PostgreSQL database", "path": "./install/database.md" }, { "title": "Uninstall", "description": "Learn how to uninstall Coder", "path": "./install/uninstall.md" } ] }, { "title": "Quickstart", "description": "Create your first template and workspace", "path": "./quickstart.md", "icon_path": "./images/icons/star.svg", "children": [ { "title": "Docker", "description": "Setup Coder with Docker", "path": "./quickstart/docker.md", "icon_path": "./images/icons/docker.svg" }, { "title": "Google Cloud Platform", "description": "Setup Coder on a GCP Compute Engine VM", "path": "./quickstart/google-cloud-platform.md", "icon_path": "./images/google-cloud.svg" }, { "title": "AWS", "description": "Setup Coder on an AWS EC2 VM", "path": "./quickstart/aws.md", "icon_path": "./images/aws.svg" }, { "title": "Azure", "description": "Setup Coder on an Azure VM", "path": "./quickstart/azure.md", "icon_path": "./images/azure.svg" } ] }, { "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces", "path": "./templates.md", "icon_path": "./images/icons/picture.svg", "children": [ { "title": "Resource Persistence", "description": "Learn how resource persistence works in Coder", "path": "./templates/resource-persistence.md", "icon_path": "./images/icons/infinity.svg" }, { "title": "Provider Authentication", "description": "Learn how to authenticate the provisioner", "path": "./templates/authentication.md", "icon_path": "./images/icons/key.svg" }, { "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" }, { "title": "Resource Metadata", "description": "Learn how to expose resource data to users", "path": "./templates/resource-metadata.md", "icon_path": "./images/icons/table-rows.svg" }, { "title": "Docker in Docker", "description": "Use docker inside containerized templates", "path": "./templates/docker-in-docker.md", "icon_path": "./images/icons/docker.svg" } ] }, { "title": "Workspaces", "description": "Learn about Coder workspaces.", "path": "./workspaces.md", "icon_path": "./images/icons/layers.svg" }, { "title": "IDEs", "description": "Learn how to use your IDE of choice with Coder", "path": "./ides.md", "icon_path": "./images/icons/code.svg", "children": [ { "title": "Web IDEs", "description": "Learn how to configure web IDEs in your templates", "path": "./ides/web-ides.md" }, { "title": "JetBrains Gateway", "description": "Learn how to configure JetBrains Gateway for your workspaces", "path": "./ides/gateway.md" }, { "title": "Emacs", "description": "Learn how to configure Emacs with TRAMP in Coder", "path": "./ides/emacs-tramp.md" }, { "title": "Remote Desktops", "description": "Learn how to use Remote Desktops with Coder", "path": "./ides/remote-desktops.md" } ] }, { "title": "Networking", "description": "Learn about networking in Coder", "path": "./networking.md", "icon_path": "./images/icons/networking.svg", "children": [ { "title": "Port Forwarding", "description": "Learn how to forward ports in Coder", "path": "./networking/port-forwarding.md" } ] }, { "title": "Dotfiles", "description": "Learn how to personalize your workspace", "path": "./dotfiles.md", "icon_path": "./images/icons/art-pad.svg" }, { "title": "Secrets", "description": "Learn how to use secrets in your workspace", "path": "./secrets.md", "icon_path": "./images/icons/secrets.svg" }, { "title": "Administration", "description": "How to install and deploy Coder", "path": "./admin/index.md", "icon_path": "./images/icons/wrench.svg", "children": [ { "title": "Authentication", "description": "Learn how to set up authentication using GitHub or OpenID Connect", "path": "./admin/auth.md", "icon_path": "./images/icons/key.svg" }, { "title": "Users", "description": "Learn about user roles available in Coder and how to create and manage users", "path": "./admin/users.md", "icon_path": "./images/icons/users.svg" }, { "title": "Groups", "description": "Learn how to manage user groups", "path": "./admin/groups.md", "icon_path": "./images/icons/group.svg", "state": "enterprise" }, { "title": "RBAC", "description": "Learn how to use the role based access control", "path": "./admin/rbac.md", "icon_path": "./images/icons/rbac.svg", "state": "enterprise" }, { "title": "Configuration", "description": "Learn how to configure Coder", "path": "./admin/configure.md", "icon_path": "./images/icons/toggle_on.svg" }, { "title": "Git Providers", "description": "Learn how connect Coder with external git providers", "path": "./admin/git-providers.md", "icon_path": "./images/icons/git.svg" }, { "title": "Upgrading", "description": "Learn how to upgrade Coder", "path": "./admin/upgrade.md", "icon_path": "./images/icons/upgrade.svg" }, { "title": "Automation", "description": "Learn how to automate Coder with the CLI and API", "path": "./admin/automation.md", "icon_path": "./images/icons/plug.svg" }, { "title": "Scaling Coder", "description": "Reference architecture and load testing tools", "path": "./admin/scale.md", "icon_path": "./images/icons/scale.svg" }, { "title": "Audit Logs", "description": "Learn how to use Audit Logs in your Coder deployment", "path": "./admin/audit-logs.md", "icon_path": "./images/icons/radar.svg", "state": "enterprise" }, { "title": "Quotas", "description": "Learn how to use Workspace Quotas in Coder", "path": "./admin/quotas.md", "icon_path": "./images/icons/dollar.svg", "state": "enterprise" }, { "title": "High Availability", "description": "Learn how to configure Coder for High Availability", "path": "./admin/high-availability.md", "icon_path": "./images/icons/hydra.svg", "state": "enterprise" }, { "title": "Prometheus", "description": "Learn how to collect Prometheus metrics", "path": "./admin/prometheus.md", "icon_path": "./images/icons/speed.svg" }, { "title": "Service Banners", "description": "Learn how to configure Service Banners", "path": "./admin/service-banners.md", "icon_path": "./images/icons/info.svg", "state": "enterprise" }, { "title": "Telemetry", "description": "Learn what usage telemetry Coder collects", "path": "./admin/telemetry.md", "icon_path": "./images/icons/science.svg" } ] }, { "title": "Enterprise", "description": "Learn how to enable Enterprise features", "path": "./enterprise.md", "icon_path": "./images/icons/group.svg" }, { "title": "Contributing", "description": "Learn how to contribute to Coder", "path": "./CONTRIBUTING.md", "icon_path": "./images/icons/contributing.svg", "children": [ { "title": "Code of Conduct", "description": "See the code of conduct for contributing to Coder", "path": "./contributing/CODE_OF_CONDUCT.md" }, { "title": "Documentation", "description": "Our style guide for use when authoring documentation", "path": "./contributing/documentation.md" }, { "title": "Security", "description": "How to report vulnerabilities in Coder", "path": "./contributing/SECURITY.md" }, { "title": "Frontend", "description": "Our guide for frontend development", "path": "./contributing/frontend.md" } ] }, { "title": "API", "description": "Learn how to use Coderd API", "path": "./api/index.md", "icon_path": "./images/icons/api.svg", "children": [ { "title": "General", "path": "./api/general.md" }, { "title": "Agents", "path": "./api/agents.md" }, { "title": "Applications", "path": "./api/applications.md" }, { "title": "Audit", "path": "./api/audit.md" }, { "title": "Authentication", "path": "./api/authentication.md" }, { "title": "Authorization", "path": "./api/authorization.md" }, { "title": "Builds", "path": "./api/builds.md" }, { "title": "Debug", "path": "./api/debug.md" }, { "title": "Enterprise", "path": "./api/enterprise.md" }, { "title": "Files", "path": "./api/files.md" }, { "title": "Insights", "path": "./api/insights.md" }, { "title": "Members", "path": "./api/members.md" }, { "title": "Organizations", "path": "./api/organizations.md" }, { "title": "Parameters", "path": "./api/parameters.md" }, { "title": "Schemas", "path": "./api/schemas.md" }, { "title": "Templates", "path": "./api/templates.md" }, { "title": "Users", "path": "./api/users.md" }, { "title": "Workspaces", "path": "./api/workspaces.md" } ] }, { "title": "Command Line", "description": "Learn how to use Coder CLI", "path": "./cli/coder.md", "icon_path": "./images/icons/terminal.svg", "children": [ { "title": "coder", "path": "./cli/coder.md" }, { "title": "config-ssh", "path": "./cli/coder_config-ssh.md" }, { "title": "create", "path": "./cli/coder_create.md" }, { "title": "delete", "path": "./cli/coder_delete.md" }, { "title": "dotfiles", "path": "./cli/coder_dotfiles.md" }, { "title": "list", "path": "./cli/coder_list.md" }, { "title": "login", "path": "./cli/coder_login.md" }, { "title": "logout", "path": "./cli/coder_logout.md" }, { "title": "port-forward", "path": "./cli/coder_port-forward.md" }, { "title": "publickey", "path": "./cli/coder_publickey.md" }, { "title": "rename", "path": "./cli/coder_rename.md" }, { "title": "reset-password", "path": "./cli/coder_reset-password.md" }, { "title": "restart", "path": "./cli/coder_restart.md" }, { "title": "scaletest", "path": "./cli/coder_scaletest.md" }, { "title": "scaletest cleanup", "path": "./cli/coder_scaletest_cleanup.md" }, { "title": "scaletest create-workspaces", "path": "./cli/coder_scaletest_create-workspaces.md" }, { "title": "schedule", "path": "./cli/coder_schedule.md" }, { "title": "schedule override-stop", "path": "./cli/coder_schedule_override-stop.md" }, { "title": "schedule show", "path": "./cli/coder_schedule_show.md" }, { "title": "schedule start", "path": "./cli/coder_schedule_start.md" }, { "title": "schedule stop", "path": "./cli/coder_schedule_stop.md" }, { "title": "server", "path": "./cli/coder_server.md" }, { "title": "server postgres-builtin-serve", "path": "./cli/coder_server_postgres-builtin-serve.md" }, { "title": "server postgres-builtin-url", "path": "./cli/coder_server_postgres-builtin-url.md" }, { "title": "show", "path": "./cli/coder_show.md" }, { "title": "speedtest", "path": "./cli/coder_speedtest.md" }, { "title": "ssh", "path": "./cli/coder_ssh.md" }, { "title": "start", "path": "./cli/coder_start.md" }, { "title": "state", "path": "./cli/coder_state.md" }, { "title": "state pull", "path": "./cli/coder_state_pull.md" }, { "title": "state push", "path": "./cli/coder_state_push.md" }, { "title": "stop", "path": "./cli/coder_stop.md" }, { "title": "templates", "path": "./cli/coder_templates.md" }, { "title": "templates create", "path": "./cli/coder_templates_create.md" }, { "title": "templates delete", "path": "./cli/coder_templates_delete.md" }, { "title": "templates edit", "path": "./cli/coder_templates_edit.md" }, { "title": "templates init", "path": "./cli/coder_templates_init.md" }, { "title": "templates list", "path": "./cli/coder_templates_list.md" }, { "title": "templates plan", "path": "./cli/coder_templates_plan.md" }, { "title": "templates pull", "path": "./cli/coder_templates_pull.md" }, { "title": "templates push", "path": "./cli/coder_templates_push.md" }, { "title": "templates versions", "path": "./cli/coder_templates_versions.md" }, { "title": "templates versions list", "path": "./cli/coder_templates_versions_list.md" }, { "title": "tokens", "path": "./cli/coder_tokens.md" }, { "title": "tokens create", "path": "./cli/coder_tokens_create.md" }, { "title": "tokens list", "path": "./cli/coder_tokens_list.md" }, { "title": "tokens remove", "path": "./cli/coder_tokens_remove.md" }, { "title": "update", "path": "./cli/coder_update.md" }, { "title": "users", "path": "./cli/coder_users.md" }, { "title": "users activate", "path": "./cli/coder_users_activate.md" }, { "title": "users create", "path": "./cli/coder_users_create.md" }, { "title": "users list", "path": "./cli/coder_users_list.md" }, { "title": "users show", "path": "./cli/coder_users_show.md" }, { "title": "users suspend", "path": "./cli/coder_users_suspend.md" }, { "title": "version", "path": "./cli/coder_version.md" } ] } ] }