[Enhancement]: Add surrealDB with and without TIKV

[Jordan-Hall]

Request Type

New Service

Description

They a couple of decussion around surrealdb as a database option but it be nice if it was bulit in with both TIKV and rockdb as an option

#3587
#4013

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and prompts that you can use with your favorite coding agent.

• Create Plan

Examples

• Example 1
• Example 2

🔗 Similar Issues

Related Issues

• [Enhancement]: One-click Service for Psono (with optional FileServer + Favicon server) #6660

👤 Suggested Assignees

• Ryvix

---

🧪 Issue enrichment is currently in early access.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

[algora-pbc]

💎 $50 bounty • Jordan Hall

Steps to solve:

1. Start working: Comment /attempt #7642 with your implementation plan
2. Submit work: Create a pull request including /claim #7642 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

❗ Important guidelines:

• To claim a bounty, you need to provide a short demo video of your changes in your pull request
• If anything is unclear, ask for clarification before starting as this will help avoid potential rework
• Low quality AI PRs will not receive review and will be closed
• Do not ask to be assigned unless you've contributed before

Thank you for contributing to coollabsio/coolify!

[kavyakapoor420]

/attempt #7642

Hi, i would like to work on this issue .

[aaryan359]

/attempt #7642

@Jordan-Hall

Based on earlier discussions (#3587, #4013, #2617), it appears that SurrealDB should be added as a native database, rather than a generic service.

A service template already exists and works, but it doesn’t integrate with Coolify’s database lifecycle (including credentials handling, SSL defaults, and backups). That’s why previous efforts stalled and were redirected toward a standalone database implementation.

Before moving forward, I’d like to confirm:

• Should SurrealDB v2 be implemented as a Standalone Database (similar to Postgres/MongoDB), rather than extending the existing service template?
• If yes, is the expectation to implement it via a StandaloneSurrealDB model + start script, instead of modifying the service layer?

Once confirmed, I’m happy to give it a try to implement this "database service"

[Bhav-ikkk]

/attempt #7642

I would like to implement SurrealDB as a native database integration. My plan is to provide a flexible setup that supports both the RocksDB (standalone) and TiKV (distributed) storage engines.

Implementation Plan:
Database Model: Create the necessary schema updates to include SurrealDB in the databases list, ensuring it supports version selection (defaulting to v2.x).

Storage Engine Toggle: Implement a configuration toggle in the UI/Backend to switch between:

RocksDB: Internal storage for simple, single-node setups.

TiKV: Configuration to link to a TiKV cluster for distributed use cases.

Environment & Security: > * Automate the generation of SURREAL_USER and SURREAL_PASS.

Map the default port 8000.

Ensure persistent volume mapping for /data.

Integration: Ensure the database shows up in the Coolify dashboard with "Stop/Start" capabilities and basic health checks.

Documentation: Update the Coolify docs to explain how to connect to the new SurrealDB instance.

@Jordan-Hall I'll start with the RocksDB implementation as the primary focus and add the TiKV configuration parameters as optional environment inputs. Does this align with the project's direction?

[itsezc]

Please note if not TikV, SurrealKV is now the default first party option for SurrealDB (which has support for versioning), so perhaps the best approach would be to allow the User to select the KV: SurrealKV, TiKV or RocksDB.

[jeffmarcilliat]

Hi! I'd like to work on this bounty.

I'll start on this right away and submit a PR when ready.

Posted by Freelance Agent

[Mukedlii]

I can take this bounty. I’ll add SurrealDB service templates for both RocksDB and TiKV variants, including defaults, volumes, ports, and a healthcheck. I’ll also add basic test instructions in the PR.