Skip to content

feat: system role docs #499

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

Open
mittalyashu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: system role docs #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0015dca
feat(guide): create System role page
mittalyashu Mar 26, 2026
aadb2bc
docs: add `LOGCHIMP_EVERYONE_SYSTEM_ROLE` variable as experimental in…
mittalyashu Mar 26, 2026
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
15 changes: 15 additions & 0 deletions content/guide/dashboard/system-roles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: System roles
description: Experimental
icon: Computer
---

System roles is part of [Roles and Permission](/guide/dashboard/role-permission) feature.

<Alert type="warning">
System roles are still experimental and in early stage, please use it with caution.
</Alert>

System roles is available from `v0.9.0` release onward.

System roles are pre-defined roles in the LogChimp with set permissions. These roles cannot be modified or deleted.
1 change: 1 addition & 0 deletions content/guide/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"---Dashboard---",
"dashboard/index",
"dashboard/role-permission",
"dashboard/system-roles",
"dashboard/settings",
"dashboard/labs"
],
Expand Down
15 changes: 8 additions & 7 deletions content/self-hosting/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ Deployment with [one-click deploy](/self-hosting/installation#one-click-deployme

### API

| Variable | Description | Default value |
| ------------------------------ | -------------------------------------------------------------------- | ----------------------- |
| `API_PORT` | | `8000` |
| `NODE_ENV` | | `production` |
| `LOGCHIMP_WEB_URL` | The complete base URL for the web application including protocol. | `http://localhost:3000` |
| `LOGCHIMP_IS_SELF_HOSTED` | | `true` |
| `LOGCHIMP_BLACKLISTED_DOMAINS` | This environment variable is available from `v0.8.0` release onward. | |
| Variable | Description | Default value |
| ------------------------------- | -------------------------------------------------------------------------------------- | ----------------------- |
| `API_PORT` | | `8000` |
| `NODE_ENV` | | `production` |
| `LOGCHIMP_WEB_URL` | The complete base URL for the web application including protocol. | `http://localhost:3000` |
| `LOGCHIMP_IS_SELF_HOSTED` | | `true` |
| `LOGCHIMP_BLACKLISTED_DOMAINS` | This environment variable is available from `v0.8.0` release onward. | |
| `LOGCHIMP_EVERYONE_SYSTEM_ROLE` | **EXPERIMENTAL:** This environment variable is available from `v0.9.0` release onward. | `0` |
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Find all references and nearby parsing/default logic for this env var
rg -n -C3 'LOGCHIMP_EVERYONE_SYSTEM_ROLE|EVERYONE_SYSTEM_ROLE' --type-add 'mdx:*.mdx' -tmdx -tts -tjs -ttsx

Repository: logchimp/docs

Length of output: 84

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Search for the environment variable in all code files
rg -n -C3 'LOGCHIMP_EVERYONE_SYSTEM_ROLE|EVERYONE_SYSTEM_ROLE' -tts -tjs -tjson

Repository: logchimp/docs

Length of output: 39

🏁 Script executed:

#!/bin/bash
# Read the environment variables documentation file
cat content/self-hosting/environment-variables.mdx

Repository: logchimp/docs

Length of output: 7944

🏁 Script executed:

#!/bin/bash
# Search for any reference to EVERYONE_SYSTEM_ROLE in all files
rg 'EVERYONE_SYSTEM_ROLE' -i

Repository: logchimp/docs

Length of output: 254

🌐 Web query:

LogChimp LOGCHIMP_EVERYONE_SYSTEM_ROLE environment variable documentation

💡 Result:

No documentation found for the LOGCHIMP_EVERYONE_SYSTEM_ROLE environment variable in LogChimp's official documentation or source code repositories. LogChimp's environment variables are listed in the official docs at https://docs.logchimp.codecarrot.net/self-hosting/environment-variables, which include variables for general configuration, API, theme, database, and mail settings, but do not mention LOGCHIMP_EVERYONE_SYSTEM_ROLE. LogChimp uses Role-Based Access Control (RBAC) as noted in https://docs.logchimp.app/guide/dashboard/role-permission, but no environment variable matching this name appears in the listed sources. It may be an undocumented, deprecated, or internal variable, or possibly from a different project.

Citations:

Document the behavior and accepted values for LOGCHIMP_EVERYONE_SYSTEM_ROLE.

The current description only mentions experimental status and version availability. Add documentation explaining what this variable controls, the list of accepted values, and the meaning of the default value 0 to prevent misconfiguration.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@content/self-hosting/environment-variables.mdx` at line 36, Update the
documentation for the environment variable LOGCHIMP_EVERYONE_SYSTEM_ROLE to
explain its behavior (controls the default system role assigned to the built‑in
"everyone" user/group), enumerate accepted values (e.g., numeric or named role
IDs such as 0 = no role/disabled, 1 = reader, 2 = writer, 3 = admin — replace
with your actual role set), and clarify that the default value `0` means no
system role is assigned (i.e., the everyone identity has no elevated
privileges). Modify the table entry for LOGCHIMP_EVERYONE_SYSTEM_ROLE to include
this summary and add a short bullet or footnote describing the accepted values
and the effect of `0`, referencing the symbol LOGCHIMP_EVERYONE_SYSTEM_ROLE and
the code/config that consumes it (e.g., the role-assignment logic in the
authentication/authorization initialization) so readers can find the
implementation if needed.


<Alert type="warning">
Be very careful when adding domains to the `LOGCHIMP_BLACKLISTED_DOMAINS` environment variable.
Expand Down
Loading