mirror of
https://github.com/coder/coder.git
synced 2026-10-16 14:48:56 +08:00
Nick Vigilante
6dd2e95692
## Summary The roles reference documented deployment-wide roles only. Organization-scoped roles were named in passing on three other pages but defined nowhere, and two statements on the page contradicted the RBAC code. Closes [DOCS-891](https://linear.app/codercom/issue/DOCS-891/organization-scoped-roles-are-defined-only-in-code-not-in-the-docs) ## Problem `coderd/rbac/roles.go` and `coderd/rbac/rolestore/rolestore.go` define eight organization-scoped roles. `docs/` defined none of them. Searching `docs/` for `organization-auditor`, `organization-user-admin`, `organization-service-account`, and `organization-workspace-creation-ban` returns nothing, and `organization-admin` appears only inside an IdP sync JSON example. That produced three concrete defects: - **Dead-end cross-reference.** The AI Gateway group budget prerequisite named the Organization Admin and Organization User Admin roles and linked to a page that defines neither. - **Incorrect Member claim.** The page said all users hold an implicit Member role "that may use personal workspaces." The site `member` role grants no workspace permissions, and `OrgMemberPermissions` grants none either. Workspace access comes from `organization-workspace-access`, which organizations attach through their default member roles. - **Unqualified Owner row.** The table asserts Owner can execute and use all workspaces. `CODER_DISABLE_OWNER_WORKSPACE_ACCESS` removes SSH and application access from the role, and the flag was documented only in the generated CLI and configuration references. ## Fix Adds an Organization roles section to the roles page covering the six assignable organization roles, where to assign them, and the implicit membership role the dashboard doesn't display. It also records that Organization Admin excludes SSH, application, and terminal access to other members' workspaces, which is the least discoverable part of the model. Corrects the Member and Owner statements, retargets the group budget prerequisite at the new section, notes that the Disabled workspace sharing policy overrides the sharing permission of any role an organization member holds, and fixes the built-in roles and custom roles glossary entries. The deployment roles table is deliberately untouched. [ENG-873](https://linear.app/codercom/issue/ENG-873/autogenerate-roles-documentation) replaces it with a generated table, so correcting the Auditor row or adding an organization matrix by hand now would be churn. The new section is prose a generator won't emit, so the two changes compose. <details> <summary>Verification and scope notes</summary> **Claims verified against source, not assumed:** | Claim | Source | |---|---| | Six assignable organization roles and their display names | `builtInRoles` in `coderd/rbac/roles.go` | | Organization Admin lacks `ssh` and `application_connect` | `orgAdmin` role, `slice.Omit(ResourceWorkspace.AvailableActions(), ...)` | | Member role grants no workspace permissions | `memberRole.User` excludes `ResourceWorkspace` with no add-back | | Workspace access comes from the default member roles | `DefaultOrgMemberRoles()` and `orgWorkspaceAccessMemberPerms()` | | `organization-member` and `organization-service-account` have no display name, so the dashboard never shows them | `systemRoles` in `rolestore.go`, `DisplayName: ""` | | Disabled sharing overrides other roles | org-level negative `workspace:share` permission in `OrgMemberPermissions` | | Roles are assigned on the organization Members page | `Edit roles` action in `OrganizationMembersTable.tsx` | | Flag, environment variable, and YAML names | `codersdk/deployment.go` | **Scoped out deliberately:** - The Disabled-sharing note says "any role held by a member of that organization" rather than naming Owner. The negation rides on the organization membership role, so it doesn't reach an Owner who isn't a member of that organization. - Pre-existing gerund headings on the touched pages (`Creating custom roles`, `Getting Started`, `Sharing your Workspace`, `Using a shared workspace`, `Accessing workspace apps in shared workspaces`) are left alone to keep the diff scoped. Vale reports them as warnings on `main` today. - `## Custom Roles` is retitled to sentence case. The GitHub anchor slug is unchanged, so inbound links still resolve. **Checks run:** `make fmt/markdown`, `make lint/markdown`, `make lint/emdash`, and `vale` on the four changed files. Vale reports zero findings from the new text. Every link added or changed was resolved to its file and heading anchor. **Also worth knowing:** three en dashes in the workspace sharing policy list are replaced with colons. `scripts/check_emdash.sh` only scans changed files, so they survived on `main` and would have failed this PR's CI once the surrounding lines were touched. </details> --- Opened by Coder Agents on behalf of @nickvigilante.
Coder is a self-hosted platform for cloud development environments and AI coding agents. Workspaces are defined with Terraform, connected through a secure Wireguard® tunnel, and automatically shut down when not used. Coder Agents runs a native AI coding agent whose loop executes in the control plane on your infrastructure, with no API keys in workspaces.
- Define cloud development environments in Terraform
- EC2 VMs, Kubernetes Pods, Docker Containers, etc.
- Automatically shutdown idle resources to save on costs
- Onboard developers in seconds instead of days
- Delegate coding work to AI agents on your infrastructure
- Bring any model (Anthropic, OpenAI, Google, Bedrock, self-hosted)
- No LLM credentials in workspaces, user identity on every action
- Centralized model governance, cost tracking, and audit logging
Quickstart
Check out our install guides for other methods and a complete tutorial.
Try Coder with the install script on Linux and macOS, or grab the latest binary or installer from GitHub Releases on Windows:
curl -L https://coder.com/install.sh | sh
Start the server and open http://localhost:3000 to create your initial user, create a Docker template, and provision your first workspace:
coder server
For a production deployment, add a PostgreSQL database (version 13 or later) and an external access URL, and see our validated architectures for sizing and infrastructure guidance:
coder server --postgres-url <url> --access-url <url>
Without these flags, Coder uses a built-in database and sets up a *.try.coder.app access URL for evaluation. Use coder --help for the full list of flags and environment variables.
Documentation
Browse the documentation or visit a specific section below:
- Workspaces: Workspaces contain the IDEs, dependencies, and configuration information needed for software development
- Templates: Templates are written in Terraform and describe the infrastructure for workspaces
- Coder Agents: Delegate coding work to AI agents running on your self-hosted infrastructure
- AI Gateway: Centralize authentication, auditing, and cost controls for AI tooling
- Administration: Learn how to operate Coder
- Premium: Learn about paid features built for large teams
- IDEs: Connect your existing editor to a workspace
Support
Open an issue for bugs and feature requests.
For community support, showcasing what you built, and feedback on in-progress features, join our Discord or GitHub Discussions.
Dedicated support is included in Coder Premium. For more information, visit coder.com/pricing.
Integrations
New integrations are always in progress. Open an issue to request one. Contributions are welcome in any official or community repository.
Official
- Coder Registry: Templates, modules, and integrations for common development environments
- Coding Agents: Run agents like Claude Code, Codex, and OpenCode isolated in Coder workspaces
- coderd Terraform Provider: Declaratively manage your Coder deployment configuration as code
- VS Code Extension: Open any Coder workspace in VS Code with a single click
- JetBrains Toolbox Plugin: Open any Coder workspace from JetBrains Toolbox with a single click
- Dev Containers: Build development environments using
devcontainer.jsonon Docker, Kubernetes, and OpenShift - Kubernetes Log Stream: Stream Kubernetes Pod events to the Coder startup logs
- Self-Hosted VS Code Extension Marketplace: A private extension marketplace that works in restricted or airgapped networks integrating with code-server.
- GitHub Actions: An action to set up the Coder CLI in GitHub workflows
Community
- Coder Discord: Chat with the community, get support, and hear about new product updates first
- Community Templates: Community-contributed workspace templates in the Coder Registry
- Community Modules: Community-contributed modules to extend Coder templates
- Coder Template GitHub Action: A GitHub Action that updates Coder templates
- Coder Agents Chat Action: A GitHub Action that starts a Coder Agents chat against a GitHub issue or pull request
Contributing
New contributors are always welcome. If you are new to the Coder codebase, see the contribution guide to get started.
Hiring
Apply on the careers page if you are interested in joining the team.