build: add restart policy in docker compose file

[kshitij-k-osmosys]

Task Link

REST-1545

Description

Add key restart: unless-stopped for docker-compose yaml files

Summary by CodeRabbit

• Documentation
  • Updated README instructions to use the latest Docker Compose syntax and separated build and run steps for improved clarity.
• Chores
  • Added a restart policy to the Docker Compose configuration to enhance container reliability.

[coderabbitai]

Walkthrough

The updates revise the README to clarify Docker usage by splitting build and run commands and adopting the newer docker compose syntax. Additionally, the docker-compose.yaml file now includes a restart policy for the document-service container, enabling automatic restarts unless explicitly stopped.

Changes

File(s)	Change Summary
README.md	Updated Docker instructions to use docker compose build and docker compose up separately, replacing the previous combined command and aligning with modern syntax. Troubleshooting section updated accordingly.
docker-compose.yaml	Added restart: unless-stopped policy to the document-service container for automatic restarts.

Poem

🐇
Compose and build, the docs now say,
With modern commands to light the way.
If your service falls or takes a nap,
It hops right up—no need to clap!
Containers bounce, instructions clear,
Docker magic, rabbits cheer!

---

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)

52-59: Docker Compose command syntax updated.

Switching to docker compose build and docker compose up aligns with the Docker CLI V2. For background execution, consider running docker compose up -d, or combine build and startup in one step with:

docker compose up --build -d

This can streamline the developer workflow.

---

87-91: Mirror rebuild instructions.

The troubleshooting steps correctly replicate the build/run process. To improve usability, you might explicitly include the -d flag for detached mode or add a -f docker-compose.yaml option if the default file name changes or multiple compose files are in use.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d055cd3 and bee2e69.

📒 Files selected for processing (2)

• README.md (2 hunks)
• docker-compose.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (csharp)

🔇 Additional comments (1)

docker-compose.yaml (1)

7-7: Restart policy addition is correct.

The restart: unless-stopped key is properly added under the document-service service, ensuring it will automatically recover from failures unless explicitly stopped.