Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Docker Support with docker-compose.yml #74

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Docker Support with docker-compose.yml #74

wants to merge 1 commit into from

Conversation

mindmonk
Copy link
Contributor

Changes

  • Added a docker-compose.yml to simplify container management.
  • Updated README.md with instructions for running the project using docker compose up -d and accessing the live preview.

Why this change?

  • Makes it easier to start the project with a single command.
  • Ensures consistent environment configuration via the docker-compose.yml file.

@mindmonk mindmonk requested a review from SailReal February 19, 2025 18:17
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Feb 19, 2025

Walkthrough

The changes update the documentation instructions and Docker configuration. The README now uses updated markdown headers for clearer sectioning and switches the command for live preview from a direct Docker run command to using Docker Compose (docker compose up -d). It also adds a note about the container using settings from the docker-compose.yml file and explicitly mentions the URL for accessing the live preview. In addition, a new service named sphinx has been added to the docker-compose.yml file. This service uses the cryptomator_docs_image, maps local directories to container paths, and runs sphinx-autobuild to build the documentation.

Possibly related PRs

  • Add Docker Support with docker-compose.yml #72: This PR also updates the Docker usage instructions in the README and introduces changes to the docker-compose.yml file, establishing a strong code-level connection with the current changes.

Suggested reviewers

  • SailReal

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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[bot]
coderabbitai bot reviewed Feb 19, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
docker-compose.yml (1)

1-11: Service Definition is Correct with a Suggestion for Enhanced Resilience.
The new sphinx service is defined correctly using the cryptomator_docs_image, with appropriate port mapping, volume mounts, and command for running sphinx-autobuild. For added robustness, consider optionally adding a restart policy (for example, restart: unless-stopped) and, if desired, a version key at the top of the file.

README.md (2)

40-44: Build Site Command Inconsistency Detected.
While the live preview section has been updated to use Docker Compose, the "Build site" instructions still rely on a docker run command. Consider updating these instructions to use Docker Compose for consistency, or add a note clarifying why the two commands differ.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

42-42: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

33-34: Specify Language in Fenced Code Blocks.
To comply with markdownlint rules (MD040), please specify a language (for example, bash) in the fenced code blocks. This small change will improve documentation clarity.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

33-33: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0f8302c and d0e3cac.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • docker-compose.yml (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

33-33: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

🔇 Additional comments (1)
README.md (1)

31-39: Live Preview Instructions Using Docker Compose Look Great.
The updated instructions now clearly indicate that users should run docker compose up -d for live preview. This aligns with the new service in docker-compose.yml and significantly simplifies the process.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

33-33: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

SailReal
SailReal requested changes Feb 19, 2025
View reviewed changes
Copy link
Member

@SailReal SailReal left a comment

Choose a reason for hiding this comment

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

With the requested changes, we do build the image in the docker compose file. Therefore remove the hole docker install (should be clear how to install docker), build section, only mention to run the docker compose command.

docker-compose.yml
@@ -0,0 +1,10 @@
services:
sphinx:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
sphinx:
cryptomator-docs:

docker-compose.yml
@@ -0,0 +1,10 @@
services:
sphinx:
image: cryptomator_docs_image
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
image: cryptomator_docs_image
build: .

README.md

```
docker run -p 8000:8000 -v $(pwd)/source:/source -v $(pwd)/build:/build cryptomator_docs_image sphinx-autobuild -b html /source /build/html --host 0.0.0.0
docker compose up -d
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
docker compose up -d
docker compose up

overheadhunter
overheadhunter requested changes Feb 22, 2025
View reviewed changes
docker-compose.yml
Comment on lines +9 to +10
command: >
sphinx-autobuild -b html /source /build/html --host 0.0.0.0
Copy link
Member

Choose a reason for hiding this comment

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

When using > in yaml files, you can add line breaks that will be removed when parsing.

Ideal to make long commands like this with many parameters more readable.

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

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@overheadhunter overheadhunter overheadhunter requested changes

@SailReal SailReal SailReal requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mindmonk @overheadhunter @SailReal