Skip to content

docs: add self-signed certificate guide#2776

Merged
fallenbagel merged 4 commits intoseerr-team:developfrom
costajohnt:docs/self-signed-certs
Apr 3, 2026
Merged

docs: add self-signed certificate guide#2776
fallenbagel merged 4 commits intoseerr-team:developfrom
costajohnt:docs/self-signed-certs

Conversation

@costajohnt
Copy link
Copy Markdown
Contributor

@costajohnt costajohnt commented Mar 28, 2026

Description

Add a new docs page covering how to use self-signed certificates with Seerr. Documents the NODE_EXTRA_CA_CERTS approach with Docker CLI and Docker Compose examples. Updates the four "Use SSL" sections in services.md and mediaserver.mdx to link to the new guide instead of saying certificates are "not supported."

How Has This Been Tested?

  • Verified the documentation renders correctly with pnpm start in the docs directory
  • Confirmed all internal links resolve to valid pages
  • Tested the Docker CLI and Docker Compose examples against the Node.js documentation

Screenshots / Logs (if applicable)

N/A — documentation-only change.

Checklist:

  • I have read and followed the contribution guidelines.
  • Disclosed any use of AI (see our policy)
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • Successful build pnpm build
  • Translation keys pnpm i18n:extract
  • Database migration (if required)

AI Disclosure

AI tools were used to assist with drafting and reviewing this documentation. All content was verified for technical accuracy against the Node.js documentation and the Seerr codebase.

Summary by CodeRabbit

  • Documentation
    • Added a new guide explaining how to configure acceptance of self-signed SSL certificates for upstream services.
    • Clarified media server and services pages to note self-signed certs are untrusted by default and link to the new guide.
    • Included concrete Docker CLI/Compose examples, PEM conversion instructions, and a link to Node.js docs for adding CA certificates.

@costajohnt costajohnt requested a review from a team as a code owner March 28, 2026 21:44
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 28, 2026

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: 46769c83-df65-47af-985b-4da13d483660

📥 Commits

Reviewing files that changed from the base of the PR and between 4462a57 and 2923e12.

📒 Files selected for processing (1)
  • docs/using-seerr/advanced/self-signed-certificates.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/using-seerr/advanced/self-signed-certificates.mdx

📝 Walkthrough

Walkthrough

Adds a new advanced docs page describing how to configure Seerr to trust upstream services using self-signed SSL certificates via Node.js CA configuration, and updates media-server and services settings docs to note self-signed certs are untrusted by default but can be configured.

Changes

Cohort / File(s) Summary
New Self-Signed Certificate Guide
docs/using-seerr/advanced/self-signed-certificates.mdx
Adds a new page explaining Seerr rejects untrusted upstream SSL connections by default and how to add a CA to Node.js trust using NODE_EXTRA_CA_CERTS. Includes Docker CLI and Docker Compose examples, read-only volume mount guidance, PEM format requirement with an openssl DER→PEM conversion, admonitions, and a link to Node.js docs.
Updated Settings Documentation
docs/using-seerr/settings/mediaserver.mdx, docs/using-seerr/settings/services.md
Rewords prior "not supported" language to state self-signed certificates are untrusted by default and can be configured; adds links to the new self-signed certificates guide. Minor text edits only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I found a PEM beneath the log,
I nudged it, sniffed it through the fog,
Mount it read-only, point NODE right,
Upstream waves in softer light,
Hoppity-hop — all set tonight.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for self-signed certificate configuration, which is the primary focus of the changeset.
Linked Issues check ✅ Passed The PR fully addresses issue #2578 by documenting a supported approach (NODE_EXTRA_CA_CERTS) with concrete Docker examples and updating service documentation to reference the new guide.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation updates directly addressing the linked issue—adding a new self-signed certificate guide and updating existing service docs to reference it.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

Comment thread docs/using-seerr/advanced/self-signed-certificates.mdx
Comment thread docs/using-seerr/advanced/self-signed-certificates.mdx Outdated
Comment thread docs/using-seerr/advanced/self-signed-certificates.mdx Outdated
@costajohnt costajohnt force-pushed the docs/self-signed-certs branch from a9eecec to 38ee70e Compare March 31, 2026 20:34
M0NsTeRRR
M0NsTeRRR previously approved these changes Apr 1, 2026
Add a new page at docs/using-seerr/advanced/ covering
NODE_EXTRA_CA_CERTS (recommended) and NODE_TLS_REJECT_UNAUTHORIZED
(fallback) for self-signed certificate setups.

Update the four "Use SSL" sections in services.md and mediaserver.mdx
to cross-reference the new guide instead of saying "not supported."

Closes #2578
- Link note to /getting-started instead of /getting-started/docker
- Remove alternative disable-validation section per maintainer request
Since the alternative method section was removed, the
"Recommended:" qualifier is unnecessary. Also removes the
horizontal rule separator and adjusts the description text.
@costajohnt costajohnt force-pushed the docs/self-signed-certs branch from 38ee70e to 4462a57 Compare April 2, 2026 22:43
The alternative method section was removed per review feedback,
so there is only one approach now. Drop the qualifier.
@fallenbagel fallenbagel merged commit dc40ca4 into seerr-team:develop Apr 3, 2026
18 checks passed
lucianchauvin pushed a commit to lucianchauvin/jellyseerr that referenced this pull request Apr 20, 2026
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.

Add docs for self-signed certificates

4 participants