docs(self-hosting): note the Railway ENCRYPTION_KEY must be 64-char hex - #6530
docs(self-hosting): note the Railway ENCRYPTION_KEY must be 64-char hex#6530eeshsaxena wants to merge 1 commit into
Conversation
The Railway template auto-generates ENCRYPTION_KEY as a URL-safe secret, but Sim requires a 64-character hex string, so saving Workspace Secrets fails with a 500. Add a troubleshooting callout with the openssl rand -hex 32 fix. Re simstudioai#6246.
|
@eeshsaxena is attempting to deploy a commit to the Sim Team on Vercel. A member of the Team first needs to authorize it. |
PR SummaryLow Risk Overview The callout tells users who see Reviewed by Cursor Bugbot for commit a6fb74f. Bugbot is set up for automated code reviews on this repo. Configure here. |
Greptile SummaryAdds Railway troubleshooting guidance explaining that
Confidence Score: 4/5The documentation guidance is reasonable, but the file should be normalized to LF before merging so the repository lint gate can pass. The substantive MDX addition follows established documentation patterns, while the file-wide line-ending conversion violates the formatter configuration exercised by CI. Files Needing Attention: apps/docs/content/docs/en/platform/self-hosting/platforms.mdx
|
| Filename | Overview |
|---|---|
| apps/docs/content/docs/en/platform/self-hosting/platforms.mdx | The new Railway warning is structurally consistent with neighboring callouts, but the file-wide CRLF conversion conflicts with the LF-only Biome configuration and can fail CI formatting checks. |
Reviews (1): Last reviewed commit: "docs(self-hosting): note the Railway ENC..." | Re-trigger Greptile
| ``` | ||
|
|
||
| For the Helm chart, disable the bundled Postgres and use `externalDatabase` — see [Kubernetes](/platform/self-hosting/kubernetes#external-database). | ||
| --- |
There was a problem hiding this comment.
CRLF conversion breaks formatting check
When CI runs the docs workspace's biome check ., the file-wide CRLF conversion conflicts with the repository's required LF line endings, causing the lint gate to fail. Normalize this file back to LF while retaining the new callout.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
What
Adds a troubleshooting note to the Railway self-hosting docs (
platforms.mdx) forENCRYPTION_KEY.Why
The Railway template auto-generates
ENCRYPTION_KEYas a URL-safe secret, but Sim validates it as a 64-character hex string. So on a fresh Railway deploy, saving Workspace Secrets fails with:and an HTTP 500 (reported in #6246). The Docker self-hosting docs already generate this correctly with
openssl rand -hex 32(self-hosting/index.mdx); only the Railway path was missing the guidance.Change
A
<Callout type="warn">next to the "auto-generated by the template" line, telling users to regenerate the key withopenssl rand -hex 32and set it in the Railway dashboard if they hit that error. Docs-only, no code change.Re #6246.