Add Coolify template and 1-click deploy button for OpnForm (Fixes #626)

[aybanda]

Summary

This pull request adds a Coolify template for deploying OpnForm with a 1-click deploy button.

Changes Made

• Added coolify-template/template.yml: Configuration for deploying OpnForm using Coolify, including all necessary services and environment variables.
• Created scripts/setup-env-coolify.sh: A script to generate the necessary .env file for the deployment.
• Updated documentation in docs 1-click-deploy-button.md: Instructions for deploying OpnForm using the Coolify template, including prerequisites and a 1-click deploy button.

/claim #626

Related Issue

Fixes #626

Summary by CodeRabbit

• New Features

  • Introduced a configuration for deploying the OpnForm application using Docker Compose.
  • Added a one-click deployment guide for the OpnForm application.
  • Automated generation of a .env file for Coolify deployment.

• Documentation

  • Added comprehensive instructions for one-click deployment in 1-click-deploy-button.md.

• Chores

  • Introduced a new script to automate environment setup for Coolify deployment.

[coderabbitai]

Walkthrough

This pull request introduces several components for deploying the OpnForm application using Docker Compose. It adds a configuration file (template.yml) that defines services such as opnform-api, db, redis, and opnform-ingress. Additionally, a new documentation file (1-click-deploy-button.md) provides instructions for a one-click deployment process via Coolify. A shell script (setup-env-coolify.sh) is also included to automate the creation of a .env file for the deployment, ensuring necessary environment variables are set.

Changes

File	Change Summary
coolify-template/template.yml	Introduced a Docker Compose configuration for OpnForm with services: opnform-api, db, redis, opnform-ingress.
docs/1-click-deploy-button.md	Added documentation for one-click deployment of OpnForm using Coolify, detailing services and environment variables.
scripts/setup-env-coolify.sh	Created a script to automate the generation of a .env file with necessary environment variables for deployment.

Assessment against linked issues

Objective	Addressed	Explanation
Coolify Template: Adapt Docker setup for Coolify (626)	✅
.env File Generator Script for Coolify (626)	✅
1-Click Deploy Button integration (626)	✅

Possibly related issues

• Add EasyPanel Template for OpnForm with 1-Click Deploy Button #627: The changes made in this PR could serve as a reference for creating an EasyPanel template for OpnForm, as they follow a similar structure for deployment.

Poem

In the garden where we play,
A new template blooms today. 🌼
With Docker's charm and Coolify's grace,
OpnForm finds its perfect place.
One-click joy, oh what a sight,
Deploy with ease, everything feels right! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[JhumanJ]

Hi, thanks for the PR. Some notes:

• I don't feel like the template is aligned with our docker-compose file (misses API worker for instance.
• How does the env variable work exactly here? Have you checked the script I mentioned?
• Please see point 4.: open a pull request to merge this directly to coolify, we don't need the template here

Thanks for contributing!

[JhumanJ]

Closing for now.