Skip to content

(fix) Make Caddyfile use /uploads/ as default root but variable UPLOAD_DIRECTORY when set #713

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

BrutalBirdie
Copy link

@BrutalBirdie BrutalBirdie commented Apr 22, 2025

What kind of change does this PR introduce?

It improves the handling of the Caddyfile to catch user errors when setting the UPLOAD_DIRECTORY to a local path.
Without this change, users will have to change the Caddyfile manually.
This way, nothing needs to be done, except set the UPLOAD_DIRECTORY variable when Caddy gets started.

Why was this change needed?

Because there is/was no documentation for this "issue" and why document more when you can improve and make it prevent user erros.

Other information:

None

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

  • I have read the CONTRIBUTING guide.
  • I checked that there were not similar issues or PRs already open for this.
  • This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

  • Chores
    • Updated file serving configuration to support a configurable uploads directory via environment variable, with a default fallback.

Copy link

vercel bot commented Apr 22, 2025

@BrutalBirdie is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Apr 22, 2025

Walkthrough

The Caddyfile configuration for the /uploads/* path has been updated to set its root directory using an environment variable, UPLOAD_DIRECTORY, with a default fallback to /uploads/. This change enables dynamic configuration of the uploads directory location at runtime without altering the file, enhancing flexibility in deployment environments. No other logic or control flow was modified.

Changes

File(s) Change Summary
var/docker/Caddyfile Updated the /uploads/* root directive to use {$UPLOAD_DIRECTORY:/uploads/} for configurability.

Possibly related issues

Poem

In Caddy’s file, a tweak so neat,
The upload path now takes a seat—
Where env vars rule, and configs bend,
Flexibility’s the latest trend!
A rabbit hops with joyful cheer,
For dynamic roots are finally here.
🐇✨


📜 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 ee0fa5b and 1d06aa5.

📒 Files selected for processing (1)
  • var/docker/Caddyfile (1 hunks)
🔇 Additional comments (2)
var/docker/Caddyfile (2)

7-7: Validate environment variable fallback syntax
Ensure that the {$UPLOAD_DIRECTORY:/uploads/} placeholder with default value is supported by your Caddy version (v2+) and correctly resolves when UPLOAD_DIRECTORY is unset. Testing both scenarios will confirm the fallback behavior.


7-7: Appropriate environment-based root directive
Switching to {$UPLOAD_DIRECTORY:/uploads/} neatly fulfills the PR objective: it defaults to /uploads/ while allowing overrides via the UPLOAD_DIRECTORY environment variable.


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
🪧 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.
  • @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.

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.

2 participants