docs(deployment): add Deploy to Railway guide and group nav by rohitg00 · Pull Request #1880 · iii-hq/iii

rohitg00 · 2026-06-18T16:00:12Z

docs(deployment): add Deploy to Railway guide and group nav

Stacked on #1872 (docs/deployment-guide).

What changed

New dedicated Deploy to Railway how-to (next + current): clean base image, declaring workers (everything is a worker), IPv6 private networking, public domain + TLS routing via Railway's edge (no self-run reverse proxy), secrets via service variables, volumes + object storage, scaling, /dev/kvm micro-VM limits, and end-to-end verification. Each section links to the relevant Railway docs.
Nav: group docs.json under Deployment (Deployment + Deploy to Railway) for both versions.

skill.md note

No skill.md committed: the rendered artifacts are generated in CI (re-render checkbox / recheck workflow), not hand-written.

Grounded in real Railway testing: database (SQLite on volume) verified end-to-end; storage local rustfs sidecar does not go healthy on Railway, so remote s3/gcs/r2 is the documented path; iii-sandbox and bundle workers need /dev/kvm, absent on Railway.

Validation

structure + vale: clean (0 errors, 0 warnings) on all changed docs.

Test plan

Sidebar shows Deployment group with Deployment + Deploy to Railway; page title reads Self-hosted deployment.
Railway doc links resolve.
CI skill-check passes.

Add a dedicated Deploy to Railway how-to (next + current) covering the clean base image, declaring workers, IPv6 private networking, public domain and TLS routing via Railway's edge, secrets, volumes and object storage, scaling, KVM limits, and end-to-end verification, with links to the relevant Railway docs. Group the nav under Deployment in docs.json and rename the deployment page title to Self-hosted deployment. Validated with skills-and-validation (structure + Vale).

vercel · 2026-06-18T16:00:17Z

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
iii-website	Skipped		Jun 19, 2026 1:33pm

coderabbitai · 2026-06-18T16:00:22Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c0caa9a7-8f89-4faf-a14d-a2c99a76e565

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/deploy-railway-guide

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

github-actions · 2026-06-18T16:00:49Z

skill-check — docs

2 verified, 519 skipped.

4 errors across the verified workers.

File	Approximate line	Severity	Violation
`docs/next/using-iii/deploy-railway.mdx`	~52	error	[Terminology.SlopMarketing] Avoid marketing/anthropomorphic phrasing 'lives'. Use concrete, technical language. (error)
`docs/next/using-iii/deploy-railway.mdx`	~293	error	[Terminology.SlopMarketing] Avoid marketing/anthropomorphic phrasing 'lives'. Use concrete, technical language. (error)
`docs/using-iii/deploy-railway.mdx`	~52	error	[Terminology.SlopMarketing] Avoid marketing/anthropomorphic phrasing 'lives'. Use concrete, technical language. (error)
`docs/using-iii/deploy-railway.mdx`	~293	error	[Terminology.SlopMarketing] Avoid marketing/anthropomorphic phrasing 'lives'. Use concrete, technical language. (error)

Caution

2 in-scope rendered artifact(s) are out of date — sources this PR touches changed without re-rendering.

docs/next/using-iii/deploy-railway.mdx.skill.md
docs/using-iii/deploy-railway.mdx.skill.md

Re-render this branch and commit rendered artifacts

Check the box above to trigger a workflow run that re-renders and pushes a commit with the artifacts.
This will add an additional commit on this branch — run git pull to sync your local copy before making further changes.

Note

Additionally, 106 unrelated stale artifact(s) exist on main outside this PR's scope. Not blocking this PR; a maintainer should re-render them in a separate chore PR.

docs/0-18-0/creating-workers/channels.mdx.skill.md
docs/0-18-0/creating-workers/functions.mdx.skill.md
docs/0-18-0/creating-workers/index.mdx.skill.md
docs/0-18-0/creating-workers/triggers.mdx.skill.md
docs/0-18-0/creating-workers/workers-registry.mdx.skill.md
docs/0-18-0/creating-workers/workers.mdx.skill.md
docs/0-18-0/how-to/build-a-realtime-todo-app.mdx.skill.md
docs/0-18-0/how-to/schedule-cron-task.mdx.skill.md
docs/0-18-0/how-to/use-trigger-conditions.mdx.skill.md
docs/0-18-0/patterns/adapter-pattern.mdx.skill.md
docs/0-18-0/patterns/reactive-state-pattern.mdx.skill.md
docs/0-18-0/sdk-reference/browser-sdk.mdx.skill.md
…and 94 more (see the workflow logs)

- Add libcap-ng0 to the base Dockerfile: the iii-worker daemon needs libcap-ng.so.0 to launch binary registry workers (e.g. database), so the guide as written would fail when adding one. - Recommend restart policy ALWAYS for the engine service: the engine exits cleanly (code 0) on a config reload, and Railway default ON_FAILURE skips code-0 exits, leaving the service stopped. - Link the iii-experimental/railway-template starter. - Add a Railway-specific deployment checklist layered on the shared self-hosted deployment checklist. Applied to both the next and current versions of the guide.

docs(deployment): drop hand-rendered skill.md (generated in CI)

87a6b87

vercel Bot temporarily deployed to Preview June 18, 2026 16:03 Inactive

docs(deployment): keep deployment.mdx unchanged (handled in #1872)

0876397

vercel Bot temporarily deployed to Preview June 18, 2026 16:06 Inactive

rohitg00 marked this pull request as ready for review June 18, 2026 16:17

vercel Bot temporarily deployed to Preview June 19, 2026 13:33 Inactive

rohitg00 mentioned this pull request Jun 19, 2026

docs(deployment): add Deploy to Fly.io guide #1885

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(deployment): add Deploy to Railway guide and group nav#1880

docs(deployment): add Deploy to Railway guide and group nav#1880
rohitg00 wants to merge 4 commits into
docs/deployment-guidefrom
docs/deploy-railway-guide

rohitg00 commented Jun 18, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jun 18, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 18, 2026 •

edited

Loading

Review skipped

Uh oh!

github-actions Bot commented Jun 18, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

rohitg00 commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

github-actions Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

skill-check — docs

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

rohitg00 commented Jun 18, 2026 •

edited

Loading

vercel Bot commented Jun 18, 2026 •

edited

Loading

coderabbitai Bot commented Jun 18, 2026 •

edited

Loading

github-actions Bot commented Jun 18, 2026 •

edited

Loading