dfa72df9aa
## Summary Coder doesn't support SAML, but a few docs pages implied it did. This PR removes those mentions. Resolves [DOCS-1194](https://linear.app/codercom/issue/DOCS-1194/remove-saml-mentions-from-docs-coder-doesnt-support-saml). ## Changes - `docs/install/index.md` and `docs/install/prepare/index.md`: "OIDC or SAML application" is now "OIDC application". - `docs/.style/style-guide/audience-and-scope.md`: the example snippets no longer mention SAML or link to a `./saml.md` page that doesn't exist. The hub-page example now lists headless authentication instead, and the persona "Coder surface" lines say "OIDC" in place of "OIDC/SAML". <details> <summary>Evidence that Coder doesn't support SAML</summary> Checked against `main`: - No SAML library in `go.mod`, `go.sum`, or `site/package.json`. - The `login_type` enum in `coderd/database/dump.sql` and `codersdk.LoginType` only cover `password`, `github`, `oidc`, `token`, `none`, and `oauth2_provider_app`. - No SAML handlers, endpoints, or deployment options in `coderd/` or `enterprise/`. - The only code mention is a comment in `coderd/userauth.go` about SAML-to-OIDC bridges sending `email_verified` as a string. </details> ## Testing - `pnpm run lint-docs`: 0 errors. - The pre-commit hook passed. - `git grep -i saml -- docs` returns nothing. --- *Generated by Coder Agents on behalf of @nickvigilante.* --------- Co-authored-by: Ben Potter <me@bpmct.net> Co-authored-by: Ben Potter <ben@coder.com>
4.5 KiB
title
| title |
|---|
| Install Coder in your infrastructure |
This section describes how to plan, install, and configure a Coder deployment, from the initial decisions you need to make in order to successfully run Coder to a steady-state operating environment. The five phases are meant to be read in order: each phase produces the required information for the next phase.
Tip
If you only need the
codercommand-line client on your own machine, refer to Coder CLI. You don't need the rest of this section.If you want a Coder deployment on a single machine as quickly as possible, follow the Quickstart instead. It installs Coder and launches a first workspace without the planning and preparation work described here. Come back to this section when you want an expanded Coder deployment.
The five phases
| Phase | What it answers | What you finish with |
|---|---|---|
| 1. Plan your deployment | Which components run where, how large they need to be, who operates them | A deployment shape and a size target you can hand to an infrastructure team |
| 2. Prepare prerequisites | What must exist before installation starts, and who owns each piece | DNS, certificates, a database, a license, and an identity provider application |
| 3. Install the control plane | How to install Coder on the platform your team operates | A running Coder deployment you can sign in to |
| 4. Validate your deployment | Whether the deployment is hardened, works, and holds up under load | Evidence that the deployment is ready for real users |
| 5. Operate and maintain | How to keep the deployment healthy, upgraded, and correctly sized | An upgrade and scaling routine, plus a removal path |
Phases 1 and 2 are advisory rather than a gate. Nothing stops you from installing the control plane first, but the recommendations in those phases are what keep a deployment from needing to be rebuilt later. Don't know where to start? Read Plan your deployment and Prepare prerequisites first.
Who does the work
A Coder deployment usually crosses team boundaries. The following actors appear throughout this section, so you can anticipate which conversations you need to start and how long they're likely to take.
| Actor | Responsible for | Appears in phase |
|---|---|---|
| Coder platform owner | The deployment itself: installation, configuration, upgrades, and support | 1 to 5 |
| Infrastructure team | Clusters, virtual machines, networking, load balancers, and egress rules | 1 to 4 |
| DNS and TLS owner | The Coder hostname, the wildcard record for workspace apps, and certificates | 2 |
| Database administrator | PostgreSQL provisioning, sizing, backups, and restore tests | 2, 4, 5 |
| Identity provider administrator | The OIDC application, claims, and group mappings | 2 |
| Security and compliance reviewer | Audit requirements, network policy, data handling, and sign-off | 2, 4 |
| Licensing contact | Purchasing and renewing the Coder license | 2 |
| Template author | The workspace templates developers use once the deployment is running | 4, 5 |
These are roles, not people. One person may serve as several actors, which is common for a proof of concept run by a single platform engineer. Several people may also serve as one actor, which is common for an infrastructure team that splits networking and compute ownership. Use the table to identify who has to agree, not to count headcount.