Skip to content

Conversation

@Junko-Takeguchi
Copy link

@Junko-Takeguchi Junko-Takeguchi commented Nov 8, 2025

Added information about LOGCHIMP_DB_URL environment variable

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated self-hosting configuration documentation to introduce a new PostgreSQL connection URL environment variable as the preferred method for database connection setup. When provided, this variable overrides individual host, database, port, user, and password settings.

@coderabbitai
Copy link

coderabbitai bot commented Nov 8, 2025

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'path_filters'
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
📝 Walkthrough

Walkthrough

The documentation for environment variables was updated to introduce a new LOGCHIMP_DB_URL variable for PostgreSQL connection configuration. Individual database connection variables were reorganized and repositioned with a clarifying note indicating URL precedence over separate host/port/database/user/password settings.

Changes

Cohort / File(s) Change Summary
Database Configuration Documentation
content/self-hosting/environment-variables.mdx
Added LOGCHIMP_DB_URL environment variable for complete PostgreSQL connection URL. Reorganized existing individual connection variables (LOGCHIMP_DB_HOST, LOGCHIMP_DB_DATABASE, LOGCHIMP_DB_PORT, LOGCHIMP_DB_USER, LOGCHIMP_DB_PASSWORD) with updated formatting. Added precedence note clarifying URL override behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Documentation-only changes with no code logic modifications
  • Straightforward reorganization and addition of configuration variable documentation
  • Single file affected with clear, cosmetic updates

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Feature: Complete DB connection URL support' directly and clearly aligns with the main change: introducing a new LOGCHIMP_DB_URL environment variable that provides complete PostgreSQL connection URL support, replacing individual connection parameters.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

@github-actions
Copy link

github-actions bot commented Nov 8, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@Junko-Takeguchi
Copy link
Author

I have read the CLA Document and I hereby sign the CLA

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
content/self-hosting/environment-variables.mdx (1)

53-53: Minor: Clarify the precedence note for better readability.

The current phrasing has awkward grammar and could be clearer. The phrase "for example" with backticks placement and "as per the given URL" are non-standard English constructions.

Consider revising to: "If LOGCHIMP_DB_URL is provided, it will override the individual connection configurations (such as LOGCHIMP_DB_HOST, LOGCHIMP_DB_DATABASE, etc.) and connect using the URL instead."

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4279219 and b9ab3de.

📒 Files selected for processing (1)
  • content/self-hosting/environment-variables.mdx (1 hunks)
🔇 Additional comments (1)
content/self-hosting/environment-variables.mdx (1)

44-52: Well-structured database configuration documentation.

The new LOGCHIMP_DB_URL variable is clearly documented and appropriately positioned at the top of the database configuration table. The default values are reasonable for a self-hosted deployment guide, and the retention of individual connection variables provides flexibility for users who prefer granular configuration. The critical security reminder on the password field is a nice touch.

@github-actions github-actions bot locked and limited conversation to collaborators Nov 9, 2025
@mittalyashu
Copy link
Member

Closing this PR against #418

@mittalyashu mittalyashu closed this Nov 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants