Fixed incorrect Docker permission command structure (root user context)

[Memory123456789]

The original code block merged sudo su - with usermod commands as if they could all run from the regular shell, which isn't correct.

• sudo su - should be run first to switch to root.
• The usermod -aG docker <user> and systemctl restart docker must be run as root after switching.
• I’ve separated these steps into two clearly labeled code blocks.

This improves clarity and avoids confusion for anyone following the setup guide.

Thanks for the great repo!

Summary by CodeRabbit

• Documentation
  • Clarified instructions for granting Jenkins and Ubuntu users permission to the Docker daemon, including explicit steps for switching to the root user before running commands.

[coderabbitai]

Walkthrough

The README.md was updated to clarify the instructions for granting Jenkins and Ubuntu users permission to access the Docker daemon. The changes include separating the steps for switching to the root user and running usermod commands, with added explanatory comments and clearer code formatting.

Changes

File(s)	Change Summary
README.md	Clarified and reformatted instructions for Docker group permissions.

Estimated code review effort

1 (~2 minutes)

Poem

🐇
A README refreshed, with clarity bright,
Permissions for Docker, now set just right.
With steps split apart and comments anew,
The Jenkins and Ubuntu crew
Can hop through setup—no more fright!

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

119-123: Specify the code-block language & drop the stray blank line

Markdownlint (MD040) is flagging this fenced block because it lacks a language hint. Adding bash (or shell) both fixes the lint error and enables syntax highlighting.
Also, the blank line after the comment is unnecessary.

-```
-# Switch to root user
-
-sudo su -
-```
+```bash
+# Switch to root user
+sudo su -
+```

---

125-131: Same issue here – add language hint and consider dropping sudo su - altogether

1. Lint / readability: add bash to the fence.
2. UX / security: instead of opening a root shell with sudo su -, you can execute the three commands directly with sudo, which is safer in copy-paste scenarios:

-```
-# Now run the following as root
-
-usermod -aG docker jenkins
-usermod -aG docker ubuntu
-systemctl restart docker
-```
+```bash
+# Grant Docker group access and restart the daemon
+sudo usermod -aG docker jenkins
+sudo usermod -aG docker ubuntu
+sudo systemctl restart docker
+```

(Users will still need to log out/in or run newgrp docker for the group change to take effect.)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3028953 and 3f239ea.

📒 Files selected for processing (1)

• README.md (1 hunks)

🪛 markdownlint-cli2 (0.17.2)

README.md

125-125: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

125-125: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

[Memory123456789]

Hi Abhishek Sir, just cleaned up the Docker group permission steps. Let me know if any changes are needed — happy to adjust.
Thanks for this amazing learning repo!