Skip to content

docs(operations): add Security guide#456

Open
gkorland wants to merge 3 commits intomainfrom
docs/add-security-guide
Open

docs(operations): add Security guide#456
gkorland wants to merge 3 commits intomainfrom
docs/add-security-guide

Conversation

@gkorland
Copy link
Copy Markdown
Contributor

@gkorland gkorland commented May 2, 2026

Summary

Create a comprehensive Security guide consolidating scattered security information into a single reference page.

Changes

  • New page: operations/security.md covering:
    • Authentication (requirepass, Docker, Docker Compose examples)
    • Access Control Lists (ACLs) with graph-level read/write permissions
    • TLS/SSL encryption (self-hosted configuration + Cloud notes)
    • Network isolation (bind address, Docker networks, K8s NetworkPolicy)
    • Least-privilege patterns (separate read/write users, disable default user)
    • Production security checklist
  • operations/index.md: Added Security guide link (section 13)

Testing

  • All internal links verified to exist (/commands/acl, /operations/durability/acl-persistence, /operations/docker, etc.)
  • Front matter follows existing Operations page conventions

Memory / Performance Impact

N/A — documentation only

Related Issues

Addresses audit item P2.1 (Audit-Report.md)

Create a comprehensive security guide at operations/security.md
covering:
- Authentication (requirepass, Docker, Docker Compose)
- Access Control Lists (ACLs) with graph-level permissions
- TLS/SSL encryption for self-hosted and Cloud
- Network isolation (bind address, Docker networks, K8s policies)
- Least-privilege patterns (separate users, disable default, restrict commands)
- Production security checklist

Also adds the Security guide to the Operations index page.

Addresses audit item P2.1.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 2, 2026

Warning

Rate limit exceeded

@gkorland has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 26 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ac5567db-9123-4de8-9465-0314348255db

📥 Commits

Reviewing files that changed from the base of the PR and between b1b07e7 and aff1ffb.

📒 Files selected for processing (3)
  • .wordlist.txt
  • operations/index.md
  • operations/security.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-security-guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 53 minutes and 26 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a new Operations documentation page that centralizes FalkorDB security guidance, bringing together authentication, ACLs, TLS, network isolation, and least-privilege recommendations into a single reference for production deployments.

Changes:

  • Added a new operations/security.md guide covering authentication, ACLs, TLS, network isolation, and a production checklist.
  • Added the new Security guide to the Operations landing page navigation.
  • Cross-linked the guide to existing ACL, durability, Docker, configuration, and Cloud documentation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
operations/security.md New security reference page for production deployment practices and related links.
operations/index.md Adds the Security guide to the Operations section index/navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread operations/security.md

### Bind Address

By default, Redis binds to all interfaces (`0.0.0.0`). In production, restrict binding to specific interfaces:
Comment thread operations/index.md
Comment on lines +62 to 66
## 13. [Security Guide](/operations/security)

Comprehensive security guide covering authentication, ACL access control, TLS/SSL encryption, network isolation, and least-privilege patterns for production deployments.

Build custom FalkorDB Docker containers from source with platform-specific examples.
gkorland and others added 2 commits May 2, 2026 20:12
Add crt, NetworkPolicy, VPN, passwordless to .wordlist.txt to fix
check-spelling CI failure on operations/security.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants