Skip to content

Deploy on Railway

Current status

CloudDev AI is not yet published to the Railway Marketplace, and there is no live Railway template ID. The Railway deployment and Marketplace gates remain open in the release status. This guide does not make CloudDev AI a verified one-click deployment. Do not use a guessed Deploy on Railway button or template code.

The steps below are the release and onboarding path. A normal user can follow the Marketplace steps only after Railway publishes a real listing. Until then, maintainers must test the configuration in a dedicated fresh Railway project and complete the Composer and release gates.

For a future Marketplace deployment

After the template is published:

  1. Open the CloudDev AI listing from Railway's template Marketplace.
  2. Select Deploy Now.
  3. Review any requested values. Supply the operator's Ed25519 public key as SSH_AUTHORIZED_KEYS. Do not paste a private key. Railway's template variable functions should generate independent secrets for each deployment.
  4. Select Deploy and wait for the project services to report ready.
  5. Open the generated HTTPS domain for clouddev-ide and continue with first login.

Railway's template deployment guide documents this flow. If the Marketplace listing is not visible, stop. The template has not been published to your account or is not yet available.

Maintainer release path

Use a new test project in the intended personal Railway workspace. Do not apply the plan to an unrelated or production project.

Create a template draft

  1. Sign in to the Railway dashboard and choose the personal workspace that will own the release.
  2. Open Workspace Settings, choose Templates, then select New Template. Railway also documents converting a project from its project settings with Generate Template from Project.
  3. If you start from the tested project, check that the Composer contains exactly these services: clouddev-ide, clouddev-git, clouddev-postgres, and clouddev-router.
  4. Confirm each source, build context, Dockerfile, health check, private variable reference, and restart setting against the template overview and the checked-in .railway/railway.ts.
  5. Select Create Template to save an unpublished draft.

Railway's current Create a Template guide describes the New Template flow, project conversion, service configuration, variables, domains, health checks, volumes, and generated template variables.

Review Composer settings

  1. Set the workspace and its volume to europe-west4-drams3a. Keep the volume-backed services at one replica. Keep Railway Serverless/App Sleeping disabled for the workspace, then verify the setting on the deployed service.
  2. Attach the persistent volumes at the paths declared by the IaC. Keep PostgreSQL and OmniRoute private. Do not add a public domain or public TCP proxy for either service.
  3. Generate the deployment secrets with the Railway Template Composer's documented secret() function. Use ${{secret(64, "0123456789abcdef")}} as a separate value for every generated-secret variable in the variable inventory. preserve() keeps an existing Railway value; it does not generate a value for a first deployment.
  4. Keep first-login bootstrap values readable only long enough to sign in and rotate them. Store them in a password manager, then seal or remove bootstrap values as the variable inventory directs. Provider credentials are never included in the template.
  5. Generate an HTTPS domain for clouddev-ide on port 8080 and clouddev-git on port 3000. Configure TCP proxies for SSH port 2222 only where the release checklist requires them. Do not expose the PostgreSQL or OmniRoute listener.
  6. Compare every variable and proxy against the full Composer inventory. Keep SSH_AUTHORIZED_KEYS as an operator-provided public key, not a maintainer key.

Test, then publish

  1. Run railway config plan in the dedicated test project and inspect every create, update, and delete before applying anything.
  2. Deploy only to that test project. Verify region, public domains, SSH TCP proxy, private networking, volume mounts, health checks, generated secrets, and the no-sleep setting from the live Railway dashboard.
  3. Complete the release checklist, including a fresh deploy, client handoff, and a restore drill. A local test or IaC type-check is not a Railway deployment result.
  4. From the Railway workspace Templates page, choose Publish beside the reviewed draft. Complete the Marketplace form with the product description, source repository, documentation, license, and support details.
  5. Wait for Railway's result. Publication does not itself establish Railway verification or a partner badge. Do not add a Deploy button until Railway returns the actual template URL and code.

Railway's Publish and Share guide explains the publication form, template URL, and button. The real template code belongs in that button URL; this repository does not have one yet.

Screenshots still needed

No Railway dashboard screenshots are included because there is no verified live test project to capture. Capture the real screens after that test exists, then add the files and their descriptions here:

  • docs/assets/screenshots/railway-template-composer-services.png
  • docs/assets/screenshots/railway-first-deploy-variables.png
  • docs/assets/screenshots/railway-marketplace-listing.png

Do not replace these names with mock UI or a screenshot from another Railway project.

Before you continue