Skip to content

docs(self-hosting): note the Railway ENCRYPTION_KEY must be 64-char hex - #6530

Open
eeshsaxena wants to merge 1 commit into
simstudioai:mainfrom
eeshsaxena:docs/railway-encryption-key-hex
Open

docs(self-hosting): note the Railway ENCRYPTION_KEY must be 64-char hex#6530
eeshsaxena wants to merge 1 commit into
simstudioai:mainfrom
eeshsaxena:docs/railway-encryption-key-hex

Conversation

@eeshsaxena

Copy link
Copy Markdown

What

Adds a troubleshooting note to the Railway self-hosting docs (platforms.mdx) for ENCRYPTION_KEY.

Why

The Railway template auto-generates ENCRYPTION_KEY as 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:

ENCRYPTION_KEY must be set to a 64-character hex string

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 with openssl rand -hex 32 and set it in the Railway dashboard if they hit that error. Docs-only, no code change.

Re #6246.

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.
@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

@eeshsaxena is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

@cursor

cursor Bot commented Aug 11, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only change with no runtime or configuration code touched.

Overview
Adds a warning callout on the Railway section of platforms.mdx explaining that the one-click template’s auto-generated ENCRYPTION_KEY is URL-safe, while Sim only accepts a 64-character hex value (same as the Docker docs’ openssl rand -hex 32 guidance).

The callout tells users who see ENCRYPTION_KEY must be set to a 64-character hex string (HTTP 500) when saving Workspace Secrets to regenerate the key and update it in the Railway dashboard. The existing cron-service warning callout is unchanged; only this new note is inserted above it.

Reviewed by Cursor Bugbot for commit a6fb74f. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps

greptile-apps Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds Railway troubleshooting guidance explaining that ENCRYPTION_KEY must be a 64-character hexadecimal value.

  • Documents the Workspace Secrets failure users may encounter with the template-generated key.
  • Recommends regenerating the value with openssl rand -hex 32.
  • The edited MDX file was also converted from LF to CRLF, conflicting with repository formatting configuration.

Confidence Score: 4/5

The 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

Important Files Changed

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).
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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!

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.

1 participant