Skip to content

Fix - #37

Merged
ucswift merged 1 commit into
masterfrom
develop
Sep 12, 2026
Merged

Fix#37
ucswift merged 1 commit into
masterfrom
develop

Conversation

@ucswift

@ucswift ucswift commented Sep 12, 2026

Copy link
Copy Markdown
Member

This PR updates the self-hosted multi-node deployment documentation to clarify the intended use of the auto-generated self-signed TLS certificate.

What changed

  • Expanded the guidance for setups that do not provide TLS certificate files.
  • Clarified that the generated self-signed certificate should be considered suitable only for lab or LAN-only environments.
  • Added explicit guidance for internet-reachable clusters to use a certificate from a trusted certificate authority.
  • Documented the supported ways to provide trusted TLS:
    • via RESGRID_TLS_CERT_FILE and RESGRID_TLS_KEY_FILE
    • or by replacing the ingress TLS secret with one managed by the cluster’s certificate tooling

Why

This change helps prevent misuse of self-signed certificates in public-facing deployments and makes the expected TLS setup clearer for browsers and mobile apps to trust the web, API, and events endpoints without requiring manual certificate installation.

Summary by CodeRabbit

  • Documentation
    • Clarified that self-signed TLS is intended for lab or LAN environments.
    • Added guidance for internet-facing deployments, including using a trusted CA certificate or cluster-managed TLS.

@ucswift
ucswift merged commit 21e69f4 into master Sep 12, 2026
1 of 2 checks passed
@Resgrid-Bot

Resgrid-Bot commented Sep 12, 2026

Copy link
Copy Markdown

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Business Logic

Access your configuration settings here.

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Essentials

Run ID: 58ddfa31-c51e-4d99-9a77-a7564c0eece4

📥 Commits

Reviewing files that changed from the base of the PR and between d628331 and 95c6ae3.

📒 Files selected for processing (1)
  • docs/self-hosted/multi.md

📝 Walkthrough

Walkthrough

The TLS guidance now limits generated self-signed certificates to lab or LAN environments. Internet-facing deployments must use a trusted CA certificate or cluster-managed TLS.

Changes

TLS deployment guidance

Layer / File(s) Summary
Certificate usage guidance
docs/self-hosted/multi.md
The documentation limits self-signed certificates to lab or LAN environments and documents trusted CA-issued or cluster-managed certificates for internet-facing deployments.

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

Change: Other

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch develop

Comment @coderabbitai help to get the list of available commands.

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