Skip to content

docs: document additional roles #3496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 12, 2022
Merged

docs: document additional roles #3496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fedab95
docs: document more additional roles
ammario Aug 12, 2022
6d8530f
Merge remote-tracking branch 'origin/main' into more-roles
Emyrk Aug 12, 2022
8e0ad9a
Update link on FE
Emyrk Aug 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"path": "./secrets.md"
},
{
"title": "User Management",
"title": "Users",
"description": "Learn about user roles available in Coder and how to create and manage users",
"icon_path": "./images/icons/users.svg",
"path": "./users.md"
Expand Down
24 changes: 15 additions & 9 deletions docs/users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# User management
# Users

This article walks you through the user roles available in Coder and creating and managing users.

## User roles
## Roles

Coder offers three user roles:
Coder offers these user roles in the community edition:

* **Admin**: Has full access to the Coder system, including all workspaces, users, organizations, and templates
* **Member**: Has limited access to Coder; can create workspaces using the templates and resources they have access to
* **Auditor**: Has the same access rights as a **member**, as well as access to
audit logs
| | User Admin | Template Admin | Admin |
| ------------------------------------------ | ---------- | -------------- | ----- |
| Add and remove Users | ✅ | | ✅ |
| Change User roles | | | ✅ |
| Manage Templates | | ✅ | ✅ |
| View, update and delete **ALL** Workspaces | | ✅ | ✅ |
| Execute and use **ALL** Workspaces | | | ✅ |

A user may have one or more roles. All users have an implicit Member role
that may use personal workspaces.

## Create a user

Expand Down Expand Up @@ -42,8 +48,8 @@ https://github.com/coder/coder/releases

Run coder login https://<accessURL>.coder.app to authenticate.

Your email is: email@exampleCo.com
Your password is: <redacted>
Your email is: email@exampleCo.com
Your password is: <redacted>

Create a workspace coder create !
```
Expand Down
2 changes: 1 addition & 1 deletion site/src/components/Tooltips/UserRoleHelpTooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const UserRoleHelpTooltip: FC = () => {
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
<HelpTooltipText>{Language.text}</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/users">
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/users#user-roles">
{Language.link}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down