-
Notifications
You must be signed in to change notification settings - Fork 11
docs: add Cloud user management guide #515
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.
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
Copilot
wants to merge
3
commits into
main
Choose a base branch
from
copilot/add-guide-to-db-user-management
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+80
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -201,6 +201,7 @@ dotenv | |
| Dovizioso | ||
| drivine | ||
| dropConstraint | ||
| dropdown | ||
| Dropzone | ||
| DT | ||
| Ducati | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| title: "User Management" | ||
| parent: "Cloud DBaaS" | ||
| nav_order: 7 | ||
| description: "Guide to managing database users on a FalkorDB Cloud instance. Learn how to create, update, and delete users, assign roles, and apply custom Redis ACL rules." | ||
| --- | ||
|
|
||
| # User Management | ||
|
|
||
| FalkorDB Cloud lets you manage database users directly from the instance page. You can create additional users, assign them predefined roles or custom Redis ACL rules, update their credentials or permissions, and delete users you no longer need. | ||
|
|
||
| > **Prerequisite:** The instance must be in a **running** state before you can manage its users. | ||
|
|
||
| --- | ||
|
|
||
| ## Opening the User Access Tab | ||
|
|
||
| 1. Go to [app.falkordb.cloud](https://app.falkordb.cloud) and sign in. | ||
| 2. Select your instance from the list. | ||
| 3. Click the **User Access** tab on the instance detail page. | ||
|
|
||
| The tab shows a table of all users configured on the instance, along with their assigned role or ACL rule. | ||
|
|
||
| --- | ||
|
|
||
| ## Default User | ||
|
|
||
| Every instance has a **default user** that is created automatically during deployment. This user cannot be deleted — its credentials can only be changed by modifying the instance configuration. | ||
|
|
||
| --- | ||
|
|
||
| ## Creating a User | ||
|
|
||
| 1. From the **User Access** tab, click **Add User**. | ||
| 2. Fill in the required fields: | ||
| - **Username** — the login name for the new user. | ||
| - **Password** — a secure password for the user. | ||
| 3. Assign permissions using one of the two options: | ||
| - **Predefined role** — select one of the built-in roles from the dropdown: | ||
| - `Admin` — full read/write access and user management. | ||
| - `Read-Write` — full read/write access to graphs. | ||
| - `Read-Only` — read-only access to graphs. | ||
| - **Custom ACL** — enter a Redis ACL rule string directly to define fine-grained access control. See [ACL](/commands/acl) for available rule syntax. | ||
| 4. Click **Save** to create the user. | ||
|
|
||
| --- | ||
|
|
||
| ## Updating a User | ||
|
|
||
| 1. From the **User Access** tab, locate the user you want to update in the table. | ||
| 2. Click the **Edit** (pencil) icon next to the user. | ||
| 3. Modify the **password**, **role**, or **custom ACL** as needed. | ||
| 4. Click **Save** to apply the changes. | ||
|
|
||
| --- | ||
|
|
||
| ## Deleting a User | ||
|
|
||
| 1. From the **User Access** tab, locate the user you want to remove. | ||
| 2. Click the **Delete** (trash) icon next to the user. | ||
| 3. Confirm the deletion in the dialog that appears. | ||
|
|
||
| > The **default user** cannot be deleted. | ||
|
|
||
| --- | ||
|
|
||
| {% include faq_accordion.html | ||
| title="Frequently Asked Questions" | ||
| q1="Can I delete the default user?" | ||
| a1="No. The default user is created during deployment and cannot be deleted. Its credentials can only be changed by modifying the instance configuration." | ||
| q2="What predefined roles are available?" | ||
| a2="Three predefined roles are available: **Admin** (full access including user management), **Read-Write** (full graph read/write), and **Read-Only** (graph read access only)." | ||
| q3="How do I apply fine-grained access control?" | ||
| a3="Select **Custom ACL** when creating or editing a user and enter a Redis ACL rule string. See the [ACL command reference](/commands/acl) for the full rule syntax." | ||
| q4="Does the instance need to be running to manage users?" | ||
| a4="Yes. The instance must be in a **running** state before you can open the User Access tab and make changes." | ||
| q5="Can I change a user's password after creation?" | ||
| a5="Yes. Click the **Edit** icon next to the user in the User Access tab, enter a new password, and save." | ||
| %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dudizimber Recommend removing Redis and just leaving ACL from this doc altogether, other than that, this is good - or maybe saying FalkorDB as if we move to ValKey or just have our own we will not need to touch this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we dont have ACL doc yet, do we?