Skip to content

add coolify deployment docs#488

Merged
mittalyashu merged 3 commits intov0-2from
coolify-deployment-docs
Mar 12, 2026
Merged

add coolify deployment docs#488
mittalyashu merged 3 commits intov0-2from
coolify-deployment-docs

Conversation

@mittalyashu
Copy link
Member

@mittalyashu mittalyashu commented Mar 12, 2026

Summary by CodeRabbit

  • New Features

    • Added Coolify as a supported self-hosting deployment platform.
    • Clarified the Docker Compose install option label to indicate it includes all required services.
  • Documentation

    • Added a step-by-step Coolify deployment guide with prerequisites, service configuration, SMTP warnings, verification steps, and next-step links.

@mittalyashu mittalyashu changed the base branch from master to v0-2 March 12, 2026 13:09
@coderabbitai
Copy link

coderabbitai bot commented Mar 12, 2026

Warning

Rate limit exceeded

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

⌛ 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 25dff337-5521-406f-bd5b-8c2c5b909d35

📥 Commits

Reviewing files that changed from the base of the PR and between 9e7681c and 5b591d2.

📒 Files selected for processing (2)
  • content/self-hosting/deployments/coolify.mdx
  • src/components/SelfhostInstall.tsx

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

Adds a new Coolify deployment guide for LogChimp (MDX), registers it in self-hosting metadata, and updates the self-hosting UI component to include Coolify and adjust the Docker label.

Changes

Cohort / File(s) Summary
Coolify Deployment Guide
content/self-hosting/deployments/coolify.mdx
New MDX document providing step-by-step deployment instructions for LogChimp on Coolify, including download steps, Docker Compose usage, service configuration (Postgres, Redis), env var guidance, images, and links to docs.
Navigation / Metadata
content/self-hosting/meta.json
Added deployments/coolify to the Deployments list to register the new guide in site navigation.
Self-Hosting Component UI
src/components/SelfhostInstall.tsx
Updated Docker item label to a more descriptive string and added a new Coolify item/link to the self-hosting install options.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A Coolify path shines bright and new,
With Docker Compose steps tried and true,
PostgreSQL nestles, Redis flows free,
LogChimp deploys with glee! ☁️✨

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: adding documentation for Coolify deployment, which is the primary focus of the three file modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch coolify-deployment-docs
📝 Coding Plan for PR comments
  • Generate coding plan

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.

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.

🧹 Nitpick comments (3)
content/self-hosting/deployments/coolify.mdx (2)

29-31: Redundant phrasing in version requirement.

The phrase "greater than v0.8.0 or higher" is redundant. Consider simplifying to either "v0.8.0 or higher" or "greater than v0.8.0".

📝 Proposed fix
 		<Alert type="warning">
-			The `<logchimp-version>` value should be greater than v0.8.0 or higher.
+			The `<logchimp-version>` value should be v0.8.0 or higher.
 		</Alert>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/self-hosting/deployments/coolify.mdx` around lines 29 - 31, The Alert
message uses redundant phrasing "greater than v0.8.0 or higher"; update the text
inside the Alert (the string referencing `<logchimp-version>`) to a concise form
such as "v0.8.0 or higher" or "greater than v0.8.0" (pick one) so the warning
reads clearly without redundancy.

83-83: Consider adjusting the congratulatory message.

The phrase "Phew! That was a lot of work!" may feel inconsistent given Coolify's simplified deployment experience. While this matches the template used in other deployment guides, you might consider tailoring it to better reflect the streamlined Coolify workflow.

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

In `@content/self-hosting/deployments/coolify.mdx` at line 83, Replace the
congratulatory sentence "Phew! That was a lot of work! Let's move to next step."
with a tone that reflects Coolify's streamlined deployment experience; locate
that exact string in the content and update it to a more positive/concise
message (for example, "Great — that’s all set! Proceed to the next step." or
similar) so the copy aligns with the product's simplified workflow and matches
other deployment guides.
src/components/SelfhostInstall.tsx (1)

15-16: Trailing whitespace in label string.

There's a trailing space at the end of the label text before the closing quote. This should be removed for consistency.

🧹 Proposed fix
     label:
-      "Deploy LogChimp using Coolify's platform for simplified container management. ",
+      "Deploy LogChimp using Coolify's platform for simplified container management.",
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/components/SelfhostInstall.tsx` around lines 15 - 16, The label string in
the SelfhostInstall component contains a trailing space ("Deploy LogChimp using
Coolify's platform for simplified container management. "), remove the extra
space so the text ends immediately before the closing quote; locate the label
property in src/components/SelfhostInstall.tsx (the label assignment) and delete
the terminal whitespace character to ensure the string has no trailing spaces.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@content/self-hosting/deployments/coolify.mdx`:
- Around line 29-31: The Alert message uses redundant phrasing "greater than
v0.8.0 or higher"; update the text inside the Alert (the string referencing
`<logchimp-version>`) to a concise form such as "v0.8.0 or higher" or "greater
than v0.8.0" (pick one) so the warning reads clearly without redundancy.
- Line 83: Replace the congratulatory sentence "Phew! That was a lot of work!
Let's move to next step." with a tone that reflects Coolify's streamlined
deployment experience; locate that exact string in the content and update it to
a more positive/concise message (for example, "Great — that’s all set! Proceed
to the next step." or similar) so the copy aligns with the product's simplified
workflow and matches other deployment guides.

In `@src/components/SelfhostInstall.tsx`:
- Around line 15-16: The label string in the SelfhostInstall component contains
a trailing space ("Deploy LogChimp using Coolify's platform for simplified
container management. "), remove the extra space so the text ends immediately
before the closing quote; locate the label property in
src/components/SelfhostInstall.tsx (the label assignment) and delete the
terminal whitespace character to ensure the string has no trailing spaces.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 167903c0-c454-44d7-9a4c-0a2369169932

📥 Commits

Reviewing files that changed from the base of the PR and between 52ac07a and eb0b112.

⛔ Files ignored due to path filters (1)
  • public/images/logos/coolify-logo.svg is excluded by !**/*.svg
📒 Files selected for processing (4)
  • content/self-hosting/deployments/coolify.mdx
  • content/self-hosting/meta.json
  • public/images/docs/install/coolify/new-resource.webp
  • src/components/SelfhostInstall.tsx

@mittalyashu mittalyashu merged commit 9cbcc5a into v0-2 Mar 12, 2026
6 checks passed
@mittalyashu
Copy link
Member Author

mittalyashu commented Mar 12, 2026

LGTM

@mittalyashu mittalyashu deleted the coolify-deployment-docs branch March 12, 2026 13:18
@github-actions github-actions bot locked and limited conversation to collaborators Mar 12, 2026
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.

1 participant