Files
coder/docs/tutorials/persistent-shared-workspaces.md
T
Nick Vigilante 7846490770 docs: reconcile H1/label mismatches into front-matter titles (Phase 3) (#28036)
## Summary

**Batch B of Phase 3** of the H1 → front-matter migration (`DOCS-484`;
parent `DOCS-477`), the editorial follow-up to Batch A (#28030). For the
**124** hand-authored pages whose leading body H1 differed from the
manifest nav label, this promotes the richer body H1 to the front-matter
**page title** and drops the duplicate H1, while keeping the short
manifest **label** as the sidebar entry.

Policy agreed with the docs owner:
- Short sidebar labels win. Duplicate sidebar labels are acceptable.
- Identical **page titles** across two pages are not. On a collision,
rename the non-generated page's title.

## Page-title collisions resolved

Promoting the H1 created 4 page-title collisions; each is disambiguated
by renaming the non-generated / secondary page (sidebar labels left
unchanged):

| page | sidebar label | body H1 | → page title |
|------|---------------|---------|--------------|
| `install/index.md` | Install | Installing Coder | **Install Coder in
your infrastructure** |
| `install/cli.md` | Coder CLI | Installing Coder | **Install the Coder
CLI** |
| `ai-gateway/clients/jetbrains.md` | JetBrains | JetBrains IDEs |
**JetBrains** |
| `workspace-access/web-ides.md` | Web IDEs and Coder Apps | Web IDEs |
Web IDEs *(kept — primary user guide)* |
| `extending-templates/web-ides.md` | Web IDEs and Coder Apps | Web IDEs
| **Web IDEs in templates** |
| `workspace-management.md` | Workspace Management | Workspaces |
**Manage workspaces** *(vs generated `api/workspaces.md`)* |

These titles are the only non-mechanical editorial calls in this PR.

## Deliberately excluded: generated pages

`admin/security/audit-logs.md` and
`admin/setup/configuration-reference.md` are `make gen` outputs
(`auditdocgen` / `configdocgen`) that Phase 2 did **not** update, so a
hand-added title would be reverted on the next generation. They're
excluded here and need their generators taught to emit front matter
first (Phase 2 pattern), tracked as `DOCS-631`. Batch A (#28030) had the
same issue for three other generated pages; it has been corrected there
too.

## Verification

AI was the primary author of this PR (see disclosure below); per the [AI
Contribution
Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING)
here is the manual verification.

- Promote = set front-matter `title` to the body H1 (or the
disambiguated title above) and remove that one duplicate H1. No other
body prose is reflowed.
- Every added front-matter block parses as YAML; all files pass `pnpm
check-docs` (markdownlint-cli2 + table formatter): `Summary: 0
error(s)`.
- Removing the H1 orphaned one in-page fragment (`[MCP](#mcp)` in
`ai-gateway/mcp.md`), now repointed. A cross-file fragment audit into
the retitled pages found no real breakage.


Anchor-change note

Unlike Batch A (title unchanged, a rendered no-op), Batch B changes each
page's effective title from the manifest label to the body H1, so the
rendered H1 **anchor slug changes**. An audit of cross-file
`.md#fragment` links into these pages surfaced no links that break as a
result (the only hits were false positives against a still-present `##
TLS & Reverse Proxy` heading). Same-file fragments are enforced by
markdownlint MD051, which is green.

## Title casing (follow-up, DOCS-742)

A follow-up commit puts the promoted titles into sentence case and
removes leading gerunds (for example, `Managing workspace schedules` →
`Manage workspace schedules`): 57 of the 120 titles changed, the other
63 were already compliant. Proper nouns and branded names (Coder
Validated Architecture, JetBrains, File Browser, Dev Containers,
Island), acronyms (API, CLI, IDE, MCP, OIDC, URL, UI, CI/CD), the
Premium license tier, and maturity labels (Beta, Experimental) are
preserved. The four `Nk-users` pages become `Reference architecture: up
to N users` (lowercase, matching the CVA landing page's own usage); the
CVA landing page keeps its branded title. `pnpm check-docs`: `Summary: 0
error(s)`.

Linear: DOCS-484, DOCS-742

> This PR was created with AI assistance (Coder Agents).
2026-09-08 16:34:00 +00:00

264 lines
8.7 KiB
Markdown

---
title: Persistent shared workspaces with service accounts
---
> [!NOTE]
> This guide requires a
> [Premium license](https://coder.com/pricing#compare-plans) because service
> accounts are a Premium feature. For more details,
> [contact your account team](https://coder.com/contact).
This guide walks through setting up a long-lived workspace that is owned by a
service account and shared with a rotating set of users. Because no single
person owns the workspace, it persists across team changes and every user
authenticates as themselves.
This pattern is useful for any scenario where a workspace outlives the people
who use it:
- **On-call rotations** — Engineers share a workspace pre-loaded with runbooks,
dashboards, and monitoring tools. Access rotates with the shift schedule.
- **Shared staging or QA** — A team workspace hosts a persistent staging
environment. Testers and reviewers are added and removed as sprints change.
- **Pair programming** — A service-account-owned workspace gives two or more
developers a shared environment without either one owning (and accidentally
deleting) it.
- **Contractor onboarding** — An external team gets scoped access to a workspace
for the duration of an engagement, then access is revoked.
The steps below use an **on-call SRE workspace** as a running example, but the
same commands apply to any of the scenarios above. Substitute the usernames,
group names, and template to match your use case.
## Prerequisites
- A running Coder deployment (v2.32+) with workspace sharing enabled. Sharing
is on by default for OSS; Premium deployments may require
[admin configuration](../user-guides/shared-workspaces.md#policies).
- The [Coder CLI](../install/index.md) installed and authenticated.
- An account with the `Owner` or `User Admin` role.
- [OIDC authentication](../admin/users/oidc-auth/index.md) configured so
shared users log in with their corporate SSO identity. Configure
[refresh tokens](../admin/users/oidc-auth/refresh-tokens.md) to prevent
session timeouts during long work sessions.
- A [wildcard access URL](../admin/networking/wildcard-access-url.md) configured
(e.g. `*.coder.example.com`) so that shared users can access workspace apps
without a 404.
- (Recommended) [IdP Group Sync](../admin/users/idp-sync.md#group-sync)
configured if your identity provider manages group membership for the teams
that will share the workspace.
## 1. Create a service account
Create a dedicated service account that will own the shared workspace. Service
accounts are non-human accounts intended for automation and shared ownership.
Because no individual user owns the workspace, there are no personal
credentials to expose and the shared environment is not affected when any user
leaves the team or the organization.
```sh
# On-call example — substitute a name that fits your use case
coder users create \
--username oncall-sre \
--service-account
```
## 2. Generate an API token for the service account
Generate a long-lived API token so you can create and manage workspaces on
behalf of the service account:
```sh
coder tokens create \
--user oncall-sre \
--name oncall-automation \
--lifetime 8760h
```
Store this token securely (e.g. in a secrets manager like Vault or AWS Secrets
Manager).
> [!IMPORTANT]
> Never distribute this token to end users. The token is for workspace
> administration only. Shared users authenticate as themselves and reach the
> workspace through sharing.
## 3. Create the workspace
Authenticate as the service account and create the workspace:
```sh
export CODER_SESSION_TOKEN="<token-from-step-2>"
coder create oncall-sre/oncall-workspace \
--template your-oncall-template \
--use-parameter-defaults \
--yes
```
> [!TIP]
> Design a dedicated template for the workspace with the tools your team
> needs pre-installed (e.g. monitoring dashboards for on-call, test runners
> for QA). Set `subdomain = true` on workspace apps so that shared users can
> access web-based tools without a 404. See
> [Accessing workspace apps in shared workspaces](../user-guides/shared-workspaces.md#accessing-workspace-apps-in-shared-workspaces).
## 4. Share the workspace
Use `coder sharing share` to grant access to users who need the workspace:
```sh
coder sharing share oncall-sre/oncall-workspace --user alice
```
This gives `alice` the default `use` role, which allows connection via SSH and
workspace apps, starting and stopping the workspace, and viewing logs and stats.
To grant `admin` permissions (which includes all `use` permissions as well as renaming, updating, and inviting
others to join with the `use` role):
```sh
coder sharing share oncall-sre/oncall-workspace --user alice:admin
```
To share with multiple users at once:
```sh
coder sharing share oncall-sre/oncall-workspace --user alice:admin,bob
```
To share with an entire Coder group:
```sh
coder sharing share oncall-sre/oncall-workspace --group sre-oncall
```
> [!NOTE]
> Groups can be synced from your identity provider using
> [IdP Sync](../admin/users/idp-sync.md#group-sync). If your IdP already
> manages team membership, sharing with a group is the simplest approach.
## 5. Rotate access
When team membership changes, remove outgoing users and add incoming ones:
```sh
# Remove outgoing user
coder sharing remove oncall-sre/oncall-workspace --user alice
# Add incoming user
coder sharing share oncall-sre/oncall-workspace --user carol
```
> [!IMPORTANT]
> The workspace must be restarted for user removal to take effect.
Verify current sharing status at any time:
```sh
coder sharing status oncall-sre/oncall-workspace
```
## 6. Automate access changes (optional)
For use cases with frequent rotation (such as on-call shifts), you can integrate
the share/remove commands into external tooling like PagerDuty, Opsgenie, or a
cron job.
### Rotation script
```sh
#!/bin/bash
# rotate-access.sh
# Usage: ./rotate-access.sh <outgoing-user> <incoming-user>
WORKSPACE="oncall-sre/oncall-workspace"
OUTGOING="$1"
INCOMING="$2"
if [ -n "$OUTGOING" ]; then
echo "Removing access for $OUTGOING..."
coder sharing remove "$WORKSPACE" --user "$OUTGOING"
fi
echo "Granting access to $INCOMING..."
coder sharing share "$WORKSPACE" --user "$INCOMING"
echo "Restarting workspace to apply changes..."
coder restart "$WORKSPACE" --yes
echo "Current sharing status:"
coder sharing status "$WORKSPACE"
```
### Group-based rotation with IdP Sync
If your identity provider manages group membership (e.g. an `sre-oncall` group
in Okta or Azure AD), you can skip manual share/remove commands entirely:
1. Configure [Group Sync](../admin/users/idp-sync.md#group-sync) to
synchronize the group from your IdP to Coder.
1. Share the workspace with the group once:
```sh
coder sharing share oncall-sre/oncall-workspace --group sre-oncall
```
1. When your IdP rotates group membership, Coder group membership updates on
next login. All current members have access; removed members lose access
after a workspace restart.
## Finding shared workspaces
Shared users can find workspaces shared with them:
```sh
# List all shared workspaces you can access, including your own
coder list --search shared:true
# List workspaces shared with you
coder list --search shared_with_user:me
# List workspaces shared with a specific user
coder list --search shared_with_user:alice
# List workspaces shared with a specific group
coder list --search shared_with_group:sre-oncall
```
## Troubleshooting
### Shared user sees 404 on workspace apps
Workspace apps using path-based routing block non-owners by default. Configure a
[wildcard access URL](../admin/networking/wildcard-access-url.md) and set
`subdomain = true` on the workspace app in your template.
### Removed user still has access
Access removal requires a workspace restart. Run
`coder restart <workspace>` after removing a user or group.
### Group sync not updating membership
Group membership changes in your IdP are not reflected until the user logs out
and back in. Group sync runs at login time, not on a polling schedule. Check the
Coder server logs with
`CODER_LOG_FILTER=".*userauth.*|.*groups returned.*"` for details. See
[Troubleshooting group sync](../admin/users/idp-sync.md#troubleshooting-grouproleorganization-sync)
for more information.
## Next steps
- [Shared Workspaces](../user-guides/shared-workspaces.md) — full reference
for workspace sharing features and UI
- [IdP Sync](../admin/users/idp-sync.md) — group, role, and organization
sync configuration
- [Configuring Okta](./configuring-okta.md) — Okta-specific OIDC setup with
custom claims and scopes
- [Security Best Practices](./best-practices/security-best-practices.md) —
deployment-wide security hardening
- [Sessions and Tokens](../admin/users/sessions-tokens.md) — API token
management and scoping