Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add reverse proxy docker documentation by J-Drolet · Pull Request #206 · pelican/docs · GitHub
Skip to content

Add reverse proxy docker documentation - #206

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

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

Conversation

@J-Drolet

@J-DroletJ-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

netlifyBot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for pelica ready!

NameLink
🔨 Latest commit9cc81bb
🔍 Latest deploy loghttps://app.netlify.com/projects/pelica/deploys/6a4a7eb8ab306b0008ca6b07
😎 Deploy Previewhttps://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

coderabbitaiBot 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly matches the main change: adding Docker documentation for reverse proxy setup.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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 freeto 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

@J-Drolet@JoanFo3123