Skip to content

Commit 5b9925a

Browse files
SiumauricioSiumauricio
committed
feat: introduce Custom Roles and Audit Logs for Enterprise users
- Added documentation for Custom Roles, allowing Enterprise users to create tailored roles with granular permissions. - Introduced a new Audit Logs section, detailing how to track actions performed by organization members for security and compliance. - Updated meta.json to include references to the new features. These enhancements provide greater control and visibility for Enterprise users, improving overall user management and compliance capabilities.
1 parent 01e06f2 commit 5b9925a

6 files changed

Lines changed: 306 additions & 46 deletions

File tree

‎apps/docs/content/docs/core/(Users)/permissions.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,11 @@ You can also grant permissions to specific users for accessing particular projec
5353
#### Project Permissions
5454

5555
Based on your projects and services, you can assign permissions to specific users to give them access to particular projects or services. You can also select specific environments within projects, allowing you to grant granular access control at the environment level.
56+
57+
## Enterprise: Custom Roles & Additional Permissions
58+
59+
With an **Enterprise** license, you can go beyond the default roles and create **Custom Roles** with granular permissions. This gives you full control over what each team member can do — covering areas like deployments, environment variables, servers, certificates, backups, monitoring, audit logs, and more.
60+
61+
Enterprise permissions include over 25 permission categories with fine-grained actions (Read, Create, Update, Delete, Deploy, Cancel, Restore, Write) across all resources.
62+
63+
[Learn more about Custom Roles →](/docs/core/enterprise/custom-roles)

‎apps/docs/content/docs/core/enterprise/audit-logs.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Audit Logs
3+
description: Track all actions performed by members in your organization
4+
---
5+
6+
Audit Logs give Enterprise users complete visibility into every action performed within the organization. Every create, update, delete, login, logout, deployment, and configuration change is recorded — giving you a full trail for security, compliance, and debugging.
7+
8+
## Overview
9+
10+
Audit Logs are available in **Settings → Audit Logs**. Each entry captures:
11+
12+
| Field | Description |
13+
| --- | --- |
14+
| **Timestamp** | When the action occurred. |
15+
| **User** | The email of the user who performed the action. |
16+
| **Action** | The type of action — `Created`, `Updated`, `Deleted`, `Deployed`, `Login`, `Logout`. |
17+
| **Resource** | The type of resource affected (e.g. `application`, `Custom Role`, `Settings`, `Session`, `Domain`). |
18+
| **Name** | The name or identifier of the resource. |
19+
| **Role** | The role of the user at the time of the action (e.g. `owner`, `developer`, `member`). |
20+
| **Metadata** | Additional context when available. |
21+
22+
## What is Logged
23+
24+
Audit Logs track every meaningful action in your organization:
25+
26+
- **Authentication** — User logins, logouts, and session events.
27+
- **User Management** — Creating, updating, or removing users and changing role assignments.
28+
- **Custom Roles** — Creating, updating, or deleting custom roles.
29+
- **Projects & Services** — Creating, updating, deploying, and deleting applications, databases, and compose stacks.
30+
- **Domains** — Adding or removing custom domains.
31+
- **Environment Variables** — Changes to service, project, and environment-level variables.
32+
- **Settings** — Updates to organization settings, whitelabel configuration, and version updates.
33+
- **Infrastructure** — Changes to servers, registries, certificates, SSH keys, and S3 destinations.
34+
- **Backups & Schedules** — Creating, updating, or deleting backups, volume backups, and scheduled jobs.
35+
- **Notifications** — Changes to notification providers.
36+
37+
## Filtering
38+
39+
You can filter audit log entries to quickly find what you're looking for:
40+
41+
- **By user** — Search for actions performed by a specific user.
42+
- **By name** — Search for actions on a specific resource name.
43+
- **By action** — Filter by action type (Created, Updated, Deleted, etc.).
44+
- **By resource** — Filter by resource type (application, Settings, Custom Role, etc.).
45+
46+
## Use Cases
47+
48+
- **Security investigations** — Identify who made a specific change and when.
49+
- **Compliance** — Maintain evidence of access control and change management for SOC 2, GDPR, and internal policies.
50+
- **Debugging** — Trace deployment failures or configuration issues back to the change that caused them.
51+
- **Team visibility** — Understand what actions team members are performing across the organization.
52+
53+
For questions about audit log retention or integration with external logging systems, [contact us](https://dokploy.com/contact).

‎apps/docs/content/docs/core/enterprise/audit-logs.txt‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎apps/docs/content/docs/core/enterprise/custom-roles.mdx‎

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
---
2+
title: Custom Roles
3+
description: Create custom roles with granular permissions for your organization members
4+
---
5+
6+
Custom Roles let Enterprise users go beyond the default **Owner**, **Admin**, and **Member** roles by creating tailored roles with fine-grained permissions. Assign exactly the access each team member needs — no more, no less.
7+
8+
## Overview
9+
10+
In the free version, Dokploy provides three built-in roles: **Owner**, **Admin**, and **Member**. Members have a limited, fixed set of permissions. With Enterprise, you can create **custom roles** that combine any of the available permissions below, then assign those roles to users in your organization.
11+
12+
To manage custom roles, go to **Settings → Custom Roles**.
13+
14+
## Available Permissions
15+
16+
Custom roles are built by combining permissions from the following categories:
17+
18+
### Users
19+
20+
Manage organization members, invitations, and roles.
21+
22+
- **Read** — View the list of users and their roles.
23+
- **Create** — Invite new members to the organization.
24+
- **Update** — Edit user details and role assignments.
25+
- **Delete** — Remove members from the organization.
26+
27+
### Projects
28+
29+
Manage project creation and deletion.
30+
31+
- **Create** — Create new projects.
32+
- **Delete** — Delete existing projects.
33+
34+
### Services
35+
36+
Manage services (applications, databases, compose) within projects.
37+
38+
- **Create** — Create new services inside projects.
39+
- **Read** — View services and their configurations.
40+
- **Delete** — Remove services from projects.
41+
42+
### Environments
43+
44+
Manage environment creation, viewing, and deletion.
45+
46+
- **Create** — Create new environments within projects.
47+
- **Read** — View environments and their settings.
48+
- **Delete** — Remove environments.
49+
50+
### Docker
51+
52+
Access to Docker containers, images, and volumes management.
53+
54+
- **Read** — View Docker containers, images, and volumes.
55+
56+
### SSH Keys
57+
58+
Manage SSH key configurations for servers and repositories.
59+
60+
- **Read** — View existing SSH keys.
61+
- **Create** — Add new SSH keys.
62+
- **Delete** — Remove SSH keys.
63+
64+
### Git Providers
65+
66+
Access to Git providers (GitHub, GitLab, Bitbucket, Gitea).
67+
68+
- **Read** — View connected Git providers.
69+
- **Create** — Connect new Git providers.
70+
- **Delete** — Remove Git provider connections.
71+
72+
### Traefik Files
73+
74+
Access to the Traefik file system configuration.
75+
76+
- **Read** — View Traefik configuration files.
77+
- **Write** — Edit Traefik configuration files.
78+
79+
### API / CLI
80+
81+
Access to API keys and CLI usage.
82+
83+
- **Read** — View and use API keys and CLI.
84+
85+
### Volumes
86+
87+
Manage persistent volumes and mounts attached to services.
88+
89+
- **Read** — View volumes and their configurations.
90+
- **Create** — Create new volumes.
91+
- **Delete** — Remove volumes.
92+
93+
### Deployments
94+
95+
Trigger, view, and cancel service deployments.
96+
97+
- **Read** — View deployment history and status.
98+
- **Deploy** — Trigger new deployments.
99+
- **Cancel** — Cancel running deployments.
100+
101+
### Service Environment Variables
102+
103+
View and edit environment variables of services.
104+
105+
- **Read** — View service environment variables.
106+
- **Write** — Edit service environment variables.
107+
108+
### Project Shared Environment Variables
109+
110+
View and edit shared environment variables at the project level.
111+
112+
- **Read** — View project-level shared environment variables.
113+
- **Write** — Edit project-level shared environment variables.
114+
115+
### Environment Shared Environment Variables
116+
117+
View and edit shared environment variables at the environment level.
118+
119+
- **Read** — View environment-level shared environment variables.
120+
- **Write** — Edit environment-level shared environment variables.
121+
122+
### Servers
123+
124+
Manage remote servers and nodes.
125+
126+
- **Read** — View server details and status.
127+
- **Create** — Add new servers.
128+
- **Delete** — Remove servers.
129+
130+
### Registries
131+
132+
Manage Docker image registries.
133+
134+
- **Read** — View configured registries.
135+
- **Create** — Add new registries.
136+
- **Delete** — Remove registries.
137+
138+
### Certificates
139+
140+
Manage SSL/TLS certificates.
141+
142+
- **Read** — View certificates.
143+
- **Create** — Add new certificates.
144+
- **Delete** — Remove certificates.
145+
146+
### Backups
147+
148+
Manage database backups and restores.
149+
150+
- **Read** — View existing backups.
151+
- **Create** — Create new backups.
152+
- **Update** — Modify backup configurations.
153+
- **Delete** — Remove backups.
154+
- **Restore** — Restore from a backup.
155+
156+
### Volume Backups
157+
158+
Manage Docker volume backups and restores.
159+
160+
- **Read** — View volume backups.
161+
- **Create** — Create new volume backups.
162+
- **Update** — Modify volume backup configurations.
163+
- **Delete** — Remove volume backups.
164+
- **Restore** — Restore from a volume backup.
165+
166+
### Schedules
167+
168+
Manage scheduled jobs (commands, deployments, scripts).
169+
170+
- **Read** — View scheduled jobs.
171+
- **Create** — Create new scheduled jobs.
172+
- **Update** — Modify existing scheduled jobs.
173+
- **Delete** — Remove scheduled jobs.
174+
175+
### Domains
176+
177+
Manage custom domains assigned to services.
178+
179+
- **Read** — View configured domains.
180+
- **Create** — Add new domains.
181+
- **Delete** — Remove domains.
182+
183+
### S3 Destinations
184+
185+
Manage S3-compatible backup destinations (AWS, Cloudflare R2, etc.).
186+
187+
- **Read** — View configured S3 destinations.
188+
- **Create** — Add new S3 destinations.
189+
- **Delete** — Remove S3 destinations.
190+
191+
### Notifications
192+
193+
Manage notification providers (Slack, Discord, Telegram, etc.).
194+
195+
- **Read** — View notification providers.
196+
- **Create** — Add new notification providers.
197+
- **Update** — Modify notification configurations.
198+
- **Delete** — Remove notification providers.
199+
200+
### Logs
201+
202+
View service and deployment logs.
203+
204+
- **Read** — View logs.
205+
206+
### Monitoring
207+
208+
View server and service metrics (CPU, RAM, disk).
209+
210+
- **Read** — View monitoring metrics.
211+
212+
### Audit Logs
213+
214+
View the audit log of actions performed in the organization.
215+
216+
- **Read** — View audit log entries.
217+
218+
## Creating a Custom Role
219+
220+
1. Go to **Settings → Custom Roles**.
221+
2. Click **Create Role**.
222+
3. Enter a name for the role (e.g. `developer`, `viewer`, `deployer`).
223+
4. Select the permissions you want to assign to this role.
224+
5. Click **Save**.
225+
226+
## Assigning a Custom Role
227+
228+
1. Go to **Settings → Users**.
229+
2. Select the user you want to update.
230+
3. Change their role to the custom role you created.
231+
4. Click **Save**.
232+
233+
The user will immediately have access based on the permissions defined in their new role.
234+
235+
## Best Practices
236+
237+
- **Principle of least privilege** — Give each role only the permissions it needs. A developer who only deploys doesn't need access to manage users or certificates.
238+
- **Name roles clearly** — Use descriptive names like `deployer`, `viewer`, or `project-admin` so it's easy to understand what each role can do.
239+
- **Review roles regularly** — As your team and workflows evolve, revisit custom roles to ensure they still match your needs.
240+
241+
For help configuring custom roles, [contact us](https://dokploy.com/contact).

‎apps/docs/content/docs/core/enterprise/index.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ description: Enterprise features for SSO, whitelabeling, and audit logs
88

99
- **Single Sign-On (SSO)** — Integrate with Auth0, Keycloak, or other OIDC/SAML providers.
1010
- **Whitelabeling** — Rebrand the UI with your logo, colors, and domain (self-hosted only).
11-
{/* - **Audit logs** — Track user actions and changes for compliance and security. */}
11+
- **Custom Roles** — Create custom roles with granular permissions beyond the default Owner, Admin, and Member roles. [Read more →](/docs/core/enterprise/custom-roles)
12+
- **Audit Logs** — Track every action performed by members in your organization for security and compliance. [Read more →](/docs/core/enterprise/audit-logs)
1213

1314
More Enterprise features are on the way. [Contact us](https://dokploy.com/contact) if you want early access or have specific requirements.
1415

@@ -18,4 +19,4 @@ For pricing and to enable Enterprise features on your instance, get in touch wit
1819

1920
**[Contact us →](https://dokploy.com/contact)**
2021

21-
We'll help you configure SSO, whitelabeling, and audit logs for your organization.
22+
We'll help you configure SSO, whitelabeling, custom roles, and audit logs for your organization.

‎apps/docs/content/docs/core/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"enterprise/license-keys",
5757
"enterprise/sso",
5858
"enterprise/whitelabeling",
59+
"enterprise/custom-roles",
5960
"enterprise/audit-logs",
6061
"---Guides---",
6162
"guides/cloudflare-tunnels",

0 commit comments

Comments
 (0)