Skip to content

Add reverse proxy docker documentation#206

Open
J-Drolet wants to merge 1 commit into
pelican-dev:mainfrom
J-Drolet:Add-REVERSE_PROXY-information
Open

Add reverse proxy docker documentation#206
J-Drolet wants to merge 1 commit into
pelican-dev:mainfrom
J-Drolet:Add-REVERSE_PROXY-information

Conversation

@J-Drolet

@J-Drolet J-Drolet commented Jul 5, 2026

Copy link
Copy Markdown

Add information regarding the BEHIND_PROXY environment variable to the docker documentation to address #202.

This is my first OSS contribution so hopefully this is helpful. Open to feedback 😄

Summary by CodeRabbit

  • Documentation
    • Added clearer guidance for setting up the app behind a reverse proxy.
    • Documented key environment variables and expected behavior when using an HTTPS app URL.
    • Included an updated example showing port mapping, mounting a custom configuration, and proxy-related settings.

@netlify

netlify Bot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

Name Link
🔨 Latest commit 9cc81bb
🔍 Latest deploy log https://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Preview https://deploy-preview-206--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 66da4f16-dce7-4b8a-b2b3-a1a482a04c66

📥 Commits

Reviewing files that changed from the base of the PR and between e4c937d and 9cc81bb.

📒 Files selected for processing (1)
  • docs/panel/advanced/docker.mdx
📜 Recent review details
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.

Applied to files:

  • docs/panel/advanced/docker.mdx
🪛 LanguageTool
docs/panel/advanced/docker.mdx

[grammar] ~196-~196: Ensure spelling is correct
Context: ...e a custom Caddyfile as described above.
An example compose.yml for hosting the...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (3)
docs/panel/advanced/docker.mdx (3)

190-190: 📐 Maintainability & Code Quality | ⚡ Quick win

Grammar: "running the panel on with an APP_URL".

Awkward phrasing; "on with" reads as a typo.

✏️ Proposed fix
-When running the panel on with an `APP_URL` starting with `https://` behind a reverse proxy that handles TLS (SSL), the following configuration should be set:
+When running the panel with an `APP_URL` starting with `https://` behind a reverse proxy that handles TLS (SSL), the following configuration should be set:

147-147: LGTM!

Also applies to: 196-196, 200-231


192-192: 🎯 Functional Correctness

Make the reverse-proxy env var consistent. The instructions use BEHIND_PROXY, but the example sets REVERSE_PROXY; one of these names is wrong and the docs need to match.


📝 Walkthrough

Walkthrough

This PR updates documentation in docs/panel/advanced/docker.mdx by inserting a heading before the reverse-proxy example and adding a new "Reverse Proxy Configuration" subsection describing BEHIND_PROXY, TRUSTED_PROXIES environment variables and an example compose.yml.

Changes

Reverse Proxy Documentation

Layer / File(s) Summary
Reverse proxy documentation additions
docs/panel/advanced/docker.mdx
Adds a "Installing behind a reverse proxy" heading and a new "Reverse Proxy Configuration" subsection covering BEHIND_PROXY, TRUSTED_PROXIES, custom Caddyfile usage, and an example compose.yml with port mapping.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit hops through docs anew,
Explaining proxies, tried and true,
BEHIND_PROXY set, TRUSTED_PROXIES too,
A compose.yml example, crisp and true,
Hop along, reader — the config's in view! 🐇📄

🚥 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 clearly matches the main change: adding Docker documentation for reverse proxy setup.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@JoanFo3123

Copy link
Copy Markdown

Just a comment. It would be better if you say like if the end user needs to be on https make url https otherwise http. Because it’s that easy for example.

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