mirror of
https://github.com/coder/coder.git
synced 2026-10-16 14:48:56 +08:00
Spell out each abbreviation where it first appears on a page, in the form "Expanded Form (ABBR)", so every page in docs/ passes the Coder.AbbreviationFirstUse rule that the next commit enables. Where the first use is a UI label in bold, the label stays as the UI shows it and the expansion goes elsewhere in the same paragraph or list item. Reversed forms such as "PKCE (Proof Key for Code Exchange)" are flipped to the expanded-first form. A few sentences needed a small rewording to take the expansion: glossary entries that said "abbreviated CVA" and "abbreviated PAT", hyphenated compounds such as "EKS-specific", and a parenthetical about SSDs that would otherwise nest parentheses. Other changes on touched lines: "IDES" becomes "IDEs", "DERP MAP" becomes "DERP map", and an em dash in a table row that the table formatter re-padded becomes a comma, because the em-dash check reads changed lines. Assisted-by: AI
3.0 KiB
3.0 KiB
title
| title |
|---|
| Administration |
These guides contain information on managing the Coder control plane and authoring templates.
First time viewers looking to set up control plane access can start with the configuration guide. If you're a team lead looking to design environments for your developers, check out our templates guides. If you are a developer using Coder, we recommend the user guides.
For automation and scripting workflows, see our CLI and API docs.
For any information not strictly contained in these sections, check out our Tutorials and frequently asked questions (FAQs).
What is an image, template, dev container, or workspace
Image
- A base image contains OS-level packages and utilities that the Coder workspace is built on. It can be an example image, custom image in your registry, or one from Docker Hub. It is defined in each template.
- Managed by: Externally to Coder.
Template
- Templates include infrastructure-level dependencies for the workspace. For example, a template can include Kubernetes PersistentVolumeClaims, Docker containers, or Amazon Elastic Compute Cloud (EC2) virtual machines (VMs).
- Managed by: Template administrators from within the Coder deployment.
Startup scripts
- Agent startup scripts apply to all users of a template. This is an intentionally flexible area that template authors have at their disposal to manage the "last mile" of workspace creation.
- Managed by: Coder template administrators.
Workspace
- A workspace is the environment that a developer works in. Developers on a team each work from their own workspace and can use multiple IDEs.
- Managed by: Developers
Development containers (dev containers)
- A Development Container is an open-source specification for defining development environments (called dev containers). It is generally stored in version control system (VCS) alongside associated source code. It can reference an existing base image, or a custom Dockerfile that will be built on-demand.
- Managed by: Dev Teams
Dotfiles / personalization
- Users may have their own specific preferences relating to shell prompt, custom keybindings, color schemes, and more. Users can leverage Coder's dotfiles support or create their own script to personalize their workspace. Be aware that users with root permissions in their workspace can override almost all of the previous configuration.
- Managed by: Individual Users
