Add security documentation for credentials and deployment #2696
+291
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create new security.md page documenting: - Security boundaries (Docker network, host, network configuration) - All backend credentials (Redis, MinIO, SERVICE_PASSWORD, SECRET_KEY_BASE) - users.acl file format and relationship to .env - Step-by-step instructions for changing passwords - Security recommendations for production deployments - Frontend vs backend authentication distinction - Update installation.md to link to new security documentation Closes #2538 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2696 +/- ##
==========================================
- Coverage 79.31% 79.24% -0.07%
==========================================
Files 662 664 +2
Lines 52588 52823 +235
Branches 734 734
==========================================
+ Hits 41708 41858 +150
- Misses 10800 10885 +85
Partials 80 80
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
clayandgen
reviewed
Jan 2, 2026
Contributor
clayandgen
left a comment
clayandgen
left a comment
There was a problem hiding this comment.
I briefly mention using a dynamic secret manager in https://docs.openc3.com/docs/guides/scripting-api#initialize_offline_access, I'm curious if we'd like to add something about that here as well
|
|
||
| By default, COSMOS only listens on localhost (127.0.0.1). This configuration keeps COSMOS completely off the network and is only vulnerable to local users of the host computer. | ||
|
|
||
| For production use, it is recommended to open COSMOS to the network and run clients from other machines. This removes browser load from the host computer and allows better securing of the host. See [SSL/TLS](../configuration/ssl-tls) for configuring HTTPS. |
Contributor
There was a problem hiding this comment.
maybe the network and clients should be a bit more specific here, this sentence isn't very intuitive to me
ryan-pratt
approved these changes
Jan 7, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
security.mdpage in the public documentation covering security boundaries, all backend credentials, users.acl file, and deployment security recommendationsinstallation.mdto link to the new security documentationCloses #2538
Closes https://github.com/OpenC3/cosmos-enterprise/issues/298
See OpenC3/cosmos-project#32
See https://github.com/OpenC3/cosmos-enterprise-project/pull/29
🤖 Generated with Claude Code