fix(env): added missing CLICKHOUSE_USER environment variable by nktnet1 · Pull Request #270 · rybbit-io/rybbit

nktnet1 · 2025-05-16T10:10:56Z

Since CLICKHOUSE_USER can be set as an environment variable, I assume the backend will also need knowledge of it, otherwise it will be out of sync with the clickhouse container for the first deploy if it's set to something other than default.

Summary by CodeRabbit

New Features
- Added support for specifying the ClickHouse user via a new environment variable for backend and compose deployments.
Documentation
- Updated self-hosting and setup guides to include the optional ClickHouse user environment variable in examples.
Chores
- Backend client now respects the configured ClickHouse username from environment variables for authentication.

vercel · 2025-05-16T10:11:01Z

@nktnet1 is attempting to deploy a commit to the goldflag's projects Team on Vercel.

A member of the Team first needs to authorize it.

FraglyG · 2025-06-14T08:50:21Z

I can't host Rybbit until this gets merged 😔

coderabbitai · 2025-07-24T11:52:22Z

Walkthrough

The diff adds the CLICKHOUSE_USER environment variable (default default) to Docker Compose services and docs, and updates ClickHouse client initialization in server and mockdata to include username from that variable for authentication.

Changes

Cohort / File(s)	Change Summary
Compose files `docker-compose.yml`, `docker-compose.cloud.yml`	Added `CLICKHOUSE_USER=default` to the `backend` service environment.
Documentation `docs/src/content/self-hosting-advanced.mdx`, `docs/src/content/self-hosting-manual.mdx`, `docs/src/content/self-hosting-guides/nginx-proxy-manager.mdx`	Added `CLICKHOUSE_USER` to example `.env` snippets and Docker Compose examples (commented or explicit).
Runtime / mocks `mockdata/index.js`	Pass `username: process.env.CLICKHOUSE_USER` into ClickHouse client configuration.
Server DB client `server/src/db/clickhouse/clickhouse.ts`	Added `username` property to ClickHouse client initialization using `process.env.CLICKHOUSE_USER`.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer / Orchestration
    participant Backend as Backend service
    participant ClickHouse as ClickHouse DB

    Dev->>Backend: Start (docker-compose with CLICKHOUSE_USER)
    Backend->>ClickHouse: Connect(url, database, username=CLICKHOUSE_USER, password)
    ClickHouse-->>Backend: Auth response / connection established

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit taps keys in the night,
Adding a name so auth is right.
Env vars aligned,
Connections signed —
ClickHouse greets with a hop and a bite. 🐇✨

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 clearly and accurately summarizes the primary change—adding the missing CLICKHOUSE_USER environment variable—and aligns with the changes to docker-compose files, documentation, and ClickHouse client configuration in the diff. It is concise, specific, and uses a conventional-commit style prefix so a reviewer scanning history will understand the intent. There are no extraneous details, emojis, or vague phrasing that would obscure the main change.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f503d1 and f1ee75b.

📒 Files selected for processing (2)

docker-compose.cloud.yml (1 hunks)
docker-compose.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

docker-compose.yml
docker-compose.cloud.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Build Client Images (ubuntu-latest, linux/amd64)
GitHub Check: Build Client Images (ubuntu-24.04-arm, linux/arm64)

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

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.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

mockdata/index.js (1)
6-11: Provide a sane fallback for username when the env var is absent.
Running the generator locally (outside Docker Compose) will set username: undefined, which the ClickHouse JS client forwards verbatim and can trigger auth errors. A tiny default keeps the script zero-config.
-  username: process.env.CLICKHOUSE_USER,
+  // Default ClickHouse user is "default" when env not provided
+  username: process.env.CLICKHOUSE_USER || "default",

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 895ca2d and 6f503d1.

📒 Files selected for processing (7)

docker-compose.cloud.yml (1 hunks)
docker-compose.yml (1 hunks)
docs/src/content/self-hosting-advanced.mdx (1 hunks)
docs/src/content/self-hosting-guides/nginx-proxy-manager.mdx (1 hunks)
docs/src/content/self-hosting-manual.mdx (1 hunks)
mockdata/index.js (1 hunks)
server/src/db/clickhouse/clickhouse.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

{client,server}/**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (CLAUDE.md)

{client,server}/**/*.{ts,tsx}: Use TypeScript with strict typing throughout both client and server
Use try/catch blocks with specific error types for error handling
Use camelCase for variables and functions, PascalCase for components and types
Group imports by external, then internal, and sort alphabetically within groups

Files:

server/src/db/clickhouse/clickhouse.ts

🧠 Learnings (7)

docs/src/content/self-hosting-manual.mdx (1)