Skip to content

Commit 79a2f85

Browse files
BrunoQuaresmabpmct
authored andcommitted
docs: Add initial docs to groups and rbac
1 parent 6235708 commit 79a2f85

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

docs/admin/groups.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# User Groups
2+
3+
Groups are helpful to define a set of common permissions for a group of users. It can be used with [RBAC](../rbac.md) to have a better access control.
4+
5+
## Enabling this feature
6+
7+
This feature is auto enabled for all enterprise deployments. Admins may contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).

docs/admin/rbac.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Role Based Access Control (RBAC)
2+
3+
RBAC helps admins to control what their users and [groups](./groups.md) can access.
4+
5+
> **Note**:
6+
> Right now, the only resource type where an admin can use RBAC is [Template](../templates.md) but we are planning to extend this capability to other resource types as well.
7+
8+
## Permissions
9+
10+
You can set the following permissions:
11+
12+
- **Admin**. Can edit and remove the resource including the permissions.
13+
- **View**. Can only read and access the resource.
14+
15+
## Enabling this feature
16+
17+
This feature is auto enabled for all enterprise deployments. Admins may contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).

site/src/pages/GroupsPage/GroupsPageView.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export const GroupsPageView: React.FC<GroupsPageViewProps> = ({
6060
</Link>
6161
<Link
6262
underline="none"
63-
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
63+
href="https://coder.com/docs/coder-oss/latest/admin/groups"
6464
target="_blank"
6565
rel="noreferrer"
6666
>

site/src/pages/TemplatePage/TemplatePermissionsPage/TemplatePermissionsPage.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export const TemplatePermissionsPage: FC<
5555
</Link>
5656
<Link
5757
underline="none"
58-
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
58+
href="https://coder.com/docs/coder-oss/latest/admin/rbac"
5959
target="_blank"
6060
rel="noreferrer"
6161
>

0 commit comments

Comments
 (0)