manifest.json

{
  "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": "OpenShift",
          "description": "Install Coder on OpenShift",
          "path": "./install/openshift.md"
        },
        {
          "title": "Docker",
          "description": "Install Coder with Docker / docker-compose",
          "path": "./install/docker.md"
        },
        {
          "title": "Windows",
          "description": "Install Coder on Windows",
          "path": "./install/windows.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": "Platforms",
      "description": "Platform-specific guides using Coder",
      "path": "./platforms/README.md",
      "icon_path": "./images/icons/star.svg",
      "children": [
        {
          "title": "AWS",
          "description": "Set up Coder on an AWS EC2 VM",
          "path": "./platforms/aws.md",
          "icon_path": "./images/aws.svg"
        },
        {
          "title": "GCP",
          "description": "Set up Coder on a GCP Compute Engine VM",
          "path": "./platforms/google-cloud-platform.md",
          "icon_path": "./images/google-cloud.svg"
        },
        {
          "title": "Azure",
          "description": "Set up Coder on an Azure VM",
          "path": "./platforms/azure.md",
          "icon_path": "./images/azure.svg"
        },
        {
          "title": "Kubernetes",
          "description": "Set up Coder on Kubernetes",
          "path": "./platforms/kubernetes/index.md",
          "children": [
            {
              "title": "Additional clusters",
              "description": "Deploy workspaces on additional Kubernetes clusters",
              "path": "./platforms/kubernetes/additional-clusters.md"
            }
          ]
        },
        {
          "title": "Docker",
          "description": "Set up Coder with Docker",
          "path": "./platforms/docker.md",
          "icon_path": "./images/icons/docker.svg"
        },
        {
          "title": "Other platforms",
          "description": "Set up Coder on an another provider",
          "path": "./platforms/other.md"
        }
      ]
    },
    {
      "title": "Templates",
      "description": "Learn about templates, which define the infrastructure underlying workspaces",
      "path": "./templates/index.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": "Agent Metadata",
          "description": "Learn how to expose live agent information to users",
          "path": "./templates/agent-metadata.md",
          "icon_path": "./images/icons/table-rows.svg"
        },
        {
          "title": "Parameters",
          "description": "Use parameters to customize templates",
          "path": "./templates/parameters.md",
          "icon_path": "./images/icons/code.svg"
        },
        {
          "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"
        },
        {
          "title": "Docker in Workspaces",
          "description": "Use docker inside containerized templates",
          "path": "./templates/docker-in-workspaces.md",
          "icon_path": "./images/icons/docker.svg"
        },
        {
          "title": "Devcontainers",
          "description": "Use devcontainers in workspaces",
          "path": "./templates/devcontainers.md",
          "state": "alpha"
        },
        {
          "title": "Terraform Modules",
          "description": "Reuse code across Coder templates",
          "path": "./templates/modules.md"
        }
      ]
    },
    {
      "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/index.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/README.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": "Provisioners",
          "description": "Run provisioners isolated from the Coder server",
          "path": "./admin/provisioners.md",
          "icon_path": "./images/icons/queue.svg",
          "state": "enterprise"
        },
        {
          "title": "Workspace Proxies",
          "description": "Run geo distributed workspace proxies",
          "path": "./admin/workspace-proxies.md",
          "icon_path": "./images/icons/networking.svg",
          "state": "enterprise"
        },
        {
          "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"
        },
        {
          "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": "Appearance",
          "description": "Learn how to configure the appearance of Coder",
          "path": "./admin/appearance.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": "Feature stages",
          "description": "Policies for Alpha and Experimental features.",
          "path": "./contributing/feature-stages.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": "Applications Enterprise",
          "path": "./api/applications enterprise.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": "Git",
          "path": "./api/git.md"
        },
        {
          "title": "Insights",
          "path": "./api/insights.md"
        },
        {
          "title": "Members",
          "path": "./api/members.md"
        },
        {
          "title": "Organizations",
          "path": "./api/organizations.md"
        },
        {
          "title": "Schemas",
          "path": "./api/schemas.md"
        },
        {
          "title": "Templates",
          "path": "./api/templates.md"
        },
        {
          "title": "Users",
          "path": "./api/users.md"
        },
        {
          "title": "WorkspaceProxies",
          "path": "./api/workspaceproxies.md"
        },
        {
          "title": "Workspaces",
          "path": "./api/workspaces.md"
        }
      ]
    },
    {
      "title": "Command Line",
      "description": "Learn how to use Coder CLI",
      "path": "./cli.md",
      "icon_path": "./images/icons/terminal.svg",
      "children": [
        {
          "title": "coder",
          "path": "cli.md"
        },
        {
          "title": "config-ssh",
          "description": "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",
          "path": "cli/config-ssh.md"
        },
        {
          "title": "create",
          "description": "Create a workspace",
          "path": "cli/create.md"
        },
        {
          "title": "delete",
          "description": "Delete a workspace",
          "path": "cli/delete.md"
        },
        {
          "title": "dotfiles",
          "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"
        },
        {
          "title": "list",
          "description": "List workspaces",
          "path": "cli/list.md"
        },
        {
          "title": "login",
          "description": "Authenticate with Coder deployment",
          "path": "cli/login.md"
        },
        {
          "title": "logout",
          "description": "Unauthenticate your local session",
          "path": "cli/logout.md"
        },
        {
          "title": "netcheck",
          "description": "Print network debug information for DERP and STUN",
          "path": "cli/netcheck.md"
        },
        {
          "title": "ping",
          "description": "Ping a workspace",
          "path": "cli/ping.md"
        },
        {
          "title": "port-forward",
          "description": "Forward ports from a workspace to the local machine. Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".",
          "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"
        },
        {
          "title": "publickey",
          "description": "Output your Coder public key used for Git operations",
          "path": "cli/publickey.md"
        },
        {
          "title": "rename",
          "description": "Rename a workspace",
          "path": "cli/rename.md"
        },
        {
          "title": "reset-password",
          "description": "Directly connect to the database to reset a user's password",
          "path": "cli/reset-password.md"
        },
        {
          "title": "restart",
          "description": "Restart a workspace",
          "path": "cli/restart.md"
        },
        {
          "title": "schedule",
          "description": "Schedule automated start and stop times for workspaces",
          "path": "cli/schedule.md"
        },
        {
          "title": "schedule override-stop",
          "description": "Override the stop time of a currently running workspace instance.",
          "path": "cli/schedule_override-stop.md"
        },
        {
          "title": "schedule show",
          "description": "Show workspace schedule",
          "path": "cli/schedule_show.md"
        },
        {
          "title": "schedule start",
          "description": "Edit workspace start schedule",
          "path": "cli/schedule_start.md"
        },
        {
          "title": "schedule stop",
          "description": "Edit workspace stop schedule",
          "path": "cli/schedule_stop.md"
        },
        {
          "title": "server",
          "description": "Start a Coder server",
          "path": "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": "cli/server_create-admin-user.md"
        },
        {
          "title": "server postgres-builtin-serve",
          "description": "Run the built-in PostgreSQL deployment.",
          "path": "cli/server_postgres-builtin-serve.md"
        },
        {
          "title": "server postgres-builtin-url",
          "description": "Output the connection URL for the built-in PostgreSQL deployment.",
          "path": "cli/server_postgres-builtin-url.md"
        },
        {
          "title": "show",
          "description": "Display details of a workspace's resources and agents",
          "path": "cli/show.md"
        },
        {
          "title": "speedtest",
          "description": "Run upload and download tests from your machine to a workspace",
          "path": "cli/speedtest.md"
        },
        {
          "title": "ssh",
          "description": "Start a shell into a workspace",
          "path": "cli/ssh.md"
        },
        {
          "title": "start",
          "description": "Start a workspace",
          "path": "cli/start.md"
        },
        {
          "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"
        },
        {
          "title": "state",
          "description": "Manually manage Terraform state to fix broken workspaces",
          "path": "cli/state.md"
        },
        {
          "title": "state pull",
          "description": "Pull a Terraform state file from a workspace.",
          "path": "cli/state_pull.md"
        },
        {
          "title": "state push",
          "description": "Push a Terraform state file to a workspace.",
          "path": "cli/state_push.md"
        },
        {
          "title": "stop",
          "description": "Stop a workspace",
          "path": "cli/stop.md"
        },
        {
          "title": "templates",
          "description": "Manage templates",
          "path": "cli/templates.md"
        },
        {
          "title": "templates create",
          "description": "Create a template from the current directory or as specified by flag",
          "path": "cli/templates_create.md"
        },
        {
          "title": "templates delete",
          "description": "Delete templates",
          "path": "cli/templates_delete.md"
        },
        {
          "title": "templates edit",
          "description": "Edit the metadata of a template by name.",
          "path": "cli/templates_edit.md"
        },
        {
          "title": "templates init",
          "description": "Get started with a templated template.",
          "path": "cli/templates_init.md"
        },
        {
          "title": "templates list",
          "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"
        },
        {
          "title": "templates pull",
          "description": "Download the latest version of a template to a path.",
          "path": "cli/templates_pull.md"
        },
        {
          "title": "templates push",
          "description": "Push a new template version from the current directory or as specified by flag",
          "path": "cli/templates_push.md"
        },
        {
          "title": "templates versions",
          "description": "Manage different versions of the specified template",
          "path": "cli/templates_versions.md"
        },
        {
          "title": "templates versions list",
          "description": "List all the versions of the specified template",
          "path": "cli/templates_versions_list.md"
        },
        {
          "title": "tokens",
          "description": "Manage personal access tokens",
          "path": "cli/tokens.md"
        },
        {
          "title": "tokens create",
          "description": "Create a token",
          "path": "cli/tokens_create.md"
        },
        {
          "title": "tokens list",
          "description": "List tokens",
          "path": "cli/tokens_list.md"
        },
        {
          "title": "tokens remove",
          "description": "Delete a token",
          "path": "cli/tokens_remove.md"
        },
        {
          "title": "update",
          "description": "Will update and start a given workspace if it is out of date",
          "path": "cli/update.md"
        },
        {
          "title": "users",
          "description": "Manage users",
          "path": "cli/users.md"
        },
        {
          "title": "users activate",
          "description": "Update a user's status to 'active'. Active users can fully interact with the platform",
          "path": "cli/users_activate.md"
        },
        {
          "title": "users create",
          "path": "cli/users_create.md"
        },
        {
          "title": "users list",
          "path": "cli/users_list.md"
        },
        {
          "title": "users show",
          "description": "Show a single user. Use 'me' to indicate the currently authenticated user.",
          "path": "cli/users_show.md"
        },
        {
          "title": "users suspend",
          "description": "Update a user's status to 'suspended'. A suspended user cannot log into the platform",
          "path": "cli/users_suspend.md"
        },
        {
          "title": "version",
          "description": "Show coder version",
          "path": "cli/version.md"
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ]
}