Skip to content

Fix: Corrected docker command in Readme - #321

Open
sanskaraggarwal2025 wants to merge 1 commit into
mainfrom
correct-readme
Open

sanskaraggarwal2025 wants to merge 1 commit into
mainfrom
correct-readme

Conversation

@sanskaraggarwal2025

@sanskaraggarwal2025 sanskaraggarwal2025 commented May 11, 2026 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated Docker run instructions with expanded environment variable configuration for Google OAuth credentials and JWT authentication settings.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 11, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d83a3489-d59c-4ab2-be3d-284e2b928ea1

📥 Commits

Reviewing files that changed from the base of the PR and between 16d255f and c06db04.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md Docker instructions are updated to show expanded environment variable configuration in the docker run example. The change adds explicit variables for Google OAuth credentials and JWT issuer settings while keeping volume mounting and port mapping unchanged.

Changes

Docker Configuration Documentation

Layer / File(s) Summary
Docker Environment Variables Documentation
README.md
Docker run example expanded with -e flags for GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GOOGLE_REDIRECT_URL, OAuth issuer/provider URLs, APP_JWT_SECRET, and APP_ISSUER.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Docker's stage now gleams so bright,
With OAuth secrets in the light,
And JWT issuers all in place,
This config runs at Docker's pace! 🐳

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix: Corrected docker command in Readme' accurately describes the main change - updating Docker instructions in README.md with expanded environment variables and configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch correct-readme

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md documentation to include essential environment variables for OAuth and JWT configuration in the Docker execution example. Feedback suggests correcting the GOOGLE_REDIRECT_URL to align with the application's routing and removing the redundant --entrypoint flag, which is already specified in the Dockerfile.

Comment thread README.md
--name sortedchat \
-e GOOGLE_CLIENT_ID=<your-google-client-id> \
-e GOOGLE_CLIENT_SECRET=<your-google-client-secret> \
-e GOOGLE_REDIRECT_URL=http://localhost:8080/callback \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The GOOGLE_REDIRECT_URL path (/callback) appears to be inconsistent with the application's routing. Based on the middleware configuration in backend/mono/main.go (line 175), the application expects the authentication callback at /auth/callback. Using the incorrect path will likely result in a 404 error or a failure in the OAuth flow.

Suggested change
-e GOOGLE_REDIRECT_URL=http://localhost:8080/callback \
-e GOOGLE_REDIRECT_URL=http://localhost:8080/auth/callback \

Comment thread README.md
-e APP_ISSUER=sortedchat \
-v $(pwd)/ui-config.json:/config/ui-config.json \
-p 8080:8080 \
--entrypoint /usr/local/bin/sortedchat \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The --entrypoint flag is redundant here. The deployment/Dockerfile already defines ENTRYPOINT ["/usr/local/bin/sortedchat"] (line 60), so Docker will automatically use this binary when the container starts. Removing this flag simplifies the command without changing its behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant