docs
Railway documentation
File Explorer
- skills
- SKILL.md
- verifying-against-source.md
- build-search-index.yml
- ci.yml
- ltex.dictionary.en-US.txt
- ltex.hiddenFalsePositives.en-US.txt
- accounts.md
- multi-factor-authentication.md
- two-factor-enforcement.md
- discord.md
- slack.md
- agent-connectors.md
- agent-integrations.md
- agent-skills.md
- chatgpt-plugin.md
- claude-code-plugin.md
- claude-connector.md
- codex-plugin.md
- cursor-plugin.md
- grok-build-plugin.md
- mcp-server.md
- plugins-and-connectors.md
- railway-agent.md
- build-and-start-commands.md
- build-configuration.md
- dockerfiles.md
- private-registries.md
- railpack.md
- skipped-builds.md
- add.md
- agent.md
- api.md
- autoupdate.md
- bucket.md
- ca.md
- cdn.md
- code.md
- completion.md
- config.md
- connect.md
- delete.md
- deploy.md
- deploying.md
- deployment.md
- dev.md
- docs.md
- domain.md
- down.md
- environment.md
- flag.md
- functions.md
- global-options.md
- init.md
- link.md
- list.md
- login.md
- logout.md
- logs.md
- mcp.md
- metrics.md
- open.md
- outbound-network.md
- postgres.md
- private-network.md
- project.md
- redeploy.md
- restart.md
- run.md
- sandbox.md
- scale.md
- service.md
- setup.md
- shell.md
- skills.md
- ssh.md
- starship.md
- status.md
- tcp-proxy.md
- telemetry.md
- templates.md
- unlink.md
- up.md
- upgrade.md
- usage.md
- variable.md
- volume.md
- waf.md
- whoami.md
- affiliate-program.md
- bounties.md
- the-conductor-program.md
- reference.md
- enotfound-redis-railway-internal.md
- postgres-corrupted-wal.md
- build-a-database-service.md
- database-view.md
- mongodb.md
- mysql-ha.md
- mysql.md
- postgresql-ha.md
- postgresql-pgbouncer.md
- postgresql.md
- redis-ha.md
- redis.md
- reference.md
- no-start-command-could-be-found.md
- nodejs-sigterm-handling.md
- slow-deployments.md
- deployment-actions.md
- deployment-teardown.md
- github-autodeploys.md
- healthchecks.md
- image-auto-updates.md
- monorepo.md
- optimize-performance.md
- pre-deploy-command.md
- reference.md
- regions.md
- restart-policy.md
- scaling.md
- serverless.md
- staged-changes.md
- start-command.md
- access-groups.md
- audit-logs.md
- compliance.md
- environment-rbac.md
- guardrails.md
- saml.md
- reference.md
- api-cookbook.md
- graphql-overview.md
- manage-deployments.md
- manage-domains.md
- manage-environments.md
- manage-projects.md
- manage-services.md
- manage-variables.md
- manage-volumes.md
- authorized-apps.md
- creating-an-app.md
- fetching-workspaces-or-projects.md
- login-and-tokens.md
- managing-an-app.md
- quickstart.md
- scopes-and-user-consent.md
- troubleshooting.md
- api.md
- oauth.md
- stripe.md
- railway-domains.md
- working-with-domains.md
- how-it-works.md
- library-configuration.md
- specs-and-limits.md
- 405-method-not-allowed.md
- application-failed-to-respond.md
- network-diagnostics.md
- ssl.md
- cdn.md
- domains.md
- edge-networking.md
- edge-rules.md
- outbound-networking.md
- private-networking.md
- public-networking.md
- static-outbound-ips.md
- tcp-proxy.md
- waf.md
- logs.md
- metrics.md
- webhooks.md
- advanced-concepts.md
- best-practices.md
- keyboard-shortcuts.md
- production-readiness-checklist.md
- the-basics.md
- compare-to-bolt.md
- compare-to-digitalocean.md
- compare-to-fly.md
- compare-to-heroku.md
- compare-to-lovable.md
- compare-to-northflank.md
- compare-to-render.md
- compare-to-replit.md
- compare-to-vercel.md
- compare-to-vps.md
- incident-management.md
- migrate-from-bolt.md
- migrate-from-digitalocean.md
- migrate-from-fly.md
- migrate-from-heroku.md
- migrate-from-lovable.md
- migrate-from-render.md
- migrate-from-replit.md
- migrate-from-vercel.md
- philosophy.md
- priority-boarding.md
- railway-metal.md
- support.md
- use-cases.md
- aws-marketplace.md
- committed-spend.md
- cost-control.md
- credits.md
- faqs.md
- free-trial.md
- plans.md
- refunds.md
- understanding-your-bill.md
- project-members.md
- project-usage.md
- workspaces.md
- billing.md
- uploading-serving.md
- best-practices.md
- create.md
- deploy.md
- kickbacks.md
- metrics.md
- partners.md
- private-docker-images.md
- publish-and-share.md
- updates.md
- reference.md
- backups.md
- point-in-time-recovery.md
- reference.md
- access.md
- agents.md
- ai.md
- build-deploy.md
- builds.md
- cli.md
- cloud-agents.md
- community.md
- config-as-code.md
- cron-jobs.md
- data-storage.md
- databases.md
- deployments.md
- enterprise.md
- environments.md
- feature-flags.md
- functions.md
- infrastructure-as-code.md
- integrations.md
- languages-frameworks.md
- mobile-app.md
- networking.md
- observability.md
- platform.md
- pricing.md
- projects.md
- quick-start.md
- sandboxes.md
- services.md
- storage-buckets.md
- templates.md
- variables.md
- volumes.md
- actix-web.md
- add-a-cdn-using-cloudfront.md
- agents-in-sandboxes.md
- ai-agent-workers.md
- ai-api-hosted-inference.md
- ai-api-proxy.md
- ai-chatbot-streaming.md
- ai-discord-telegram-bot.md
- alerts-crashes-failed-deploys.md
- angular.md
- aspnet-core.md
- astro.md
- autoscale-horizontally.md
- axum.md
- beego.md
- best-mcp-servers-coding-agents.md
- bridge-railway-to-rds-with-tailscale.md
- build-time-vs-runtime-secrets.md
- bullmq-jobs-retry-dlq.md
- bun.md
- cache-headers-cdn.md
- caddy.md
- claude-agent-sdk-app.md
- clickhouse-analytics.md
- code-execution-sandboxes.md
- connection-pooling-pgbouncer.md
- cron-workers-queues.md
- cut-idle-costs-serverless.md
- debug-production-incident.md
- deploy-ai-saas.md
- deploy-an-otel-collector-stack.md
- deploy-node-express-api-with-auto-scaling-secrets-and-zero-downtime.md
- deploying-a-monorepo.md
- dify.md
- django.md
- docker-compose.md
- embeddings-pipeline.md
- estimate-ai-agent-costs.md
- express.md
- external-secrets-manager.md
- fastapi.md
- fastify.md
- flask.md
- flowise.md
- frontend-authentication.md
- frontend-environment-variables.md
- fullstack-nextjs.md
- gatsby.md
- ghost.md
- gin.md
- github-actions-post-deploy.md
- github-actions-pr-environment.md
- github-actions-runners.md
- go-fiber.md
- hono.md
- host-documentation-site.md
- hybrid-search-postgres-pgvector.md
- instrument-app-opentelemetry.md
- isolate-staging-production.md
- jupyter-server-team.md
- keycloak-authentication.md
- ktor.md
- langfuse-llm-observability.md
- langgraph-agent-backend.md
- laravel.md
- llm-gateway.md
- load-test-k6.md
- local-vs-remote-mcp-servers.md
- lock-down-production-project.md
- lovable.md
- luminus.md
- managing-secrets-on-railway.md
- mcp-server.md
- migrate-database-minimal-downtime.md
- multi-agent-system.md
- multi-region-api-failover.md
- n8n.md
- nest.md
- nextjs.md
- nuxt.md
- object-storage-for-ai-agents.md
- open-webui.md
- payload-cms.md
- phoenix-distillery.md
- phoenix.md
- play.md
- playwright.md
- postgres-backups-restores.md
- preview-deployments-with-pr-environments.md
- private-container-registry.md
- rabbitmq-producers-consumers.md
- rag-pipeline-pgvector.md
- rails.md
- react.md
- redis-cache-vs-store.md
- remix.md
- right-size-cpu-memory.md
- rocket.md
- roll-back-bad-deploy.md
- rotate-credentials-zero-downtime.md
- running-agents-on-railway.md
- saas-backend.md
- sails.md
- scaling-your-application.md
- set-up-a-datadog-agent.md
- set-up-a-tailscale-forwarder.md
- ship-logs-third-party.md
- ship-on-merge-pr-canaries.md
- socketio.md
- solid.md
- spa-routing-configuration.md
- spring-boot.md
- sse-vs-websockets.md
- ssr-ssg-isr.md
- static-hosting.md
- storage-buckets-guide.md
- strapi.md
- streaming-ai-responses.md
- structured-logging-production.md
- supabase.md
- sveltekit.md
- symfony.md
- tanstack-start.md
- third-party-observability.md
- uptime-kuma.md
- vibe-coding-deploy.md
- vue.md
- webhooks-at-scale.md
- access-groups-security-toggle.png
- access-groups-tab.png
- create-access-group.png
- project-members-access.png
- ca-full-screen.png
- ca-manage.png
- ca-menu.png
- ibm-plex-serif-bold-latin.woff2
- ibm-plex-serif-light-latin.woff2
- ibm-plex-serif-medium-latin.woff2
- ibm-plex-serif-regular-latin.woff2
- ibm-plex-serif-semibold-latin.woff2
- FireMono-latin.woff2
- IBMPlexSerif-Medium-latin.woff2
- Inter-latin.woff2
- jet-brains-mono-latin.woff2
- sprite.svg
- account-nav.png
- build-command.png
- card-dark-guides.svg
- card-dark-how-railway-works.svg
- card-dark-quickstart.svg
- card-dark-tutorials.svg
- card-light-guides.svg
- card-light-how-railway-works.svg
- card-light-quickstart.svg
- card-light-tutorials.svg
- cloudflare.png
- code-terminal.png
- code-terminal.svg
- commit-metrics.png
- connect-heroku-account.png
- database-config-connection.png
- database-config-extensions.png
- DocBlog.svg
- environment-dock.png
- full-train.svg
- healthcheck-timeout.png
- project-invite-member.png
- project-transfer.png
- railway-link.png
- root-directory.png
- VectorGrid.svg
- watch-paths.png
- webhooks.png
- faq.json
- android-chrome-192x192.png
- android-chrome-512x512.png
- apple-touch-icon.png
- blog.png
- favicon-16x16.png
- favicon-32x32.png
- favicon-96x96.png
- favicon.ico
- og.png
- railway.svg
- site.webmanifest
- arrow-right.svg
- arrow-up-right.svg
- arrow-up.svg
- bash.svg
- book.svg
- chatgpt.svg
- check-circle.svg
- check.svg
- chevron-down.svg
- chevron-right.svg
- chevron-up.svg
- claude.svg
- copy.svg
- cross-circle.svg
- cross.svg
- cursor-ai.svg
- discord.svg
- file-text.svg
- file.svg
- folder.svg
- github.svg
- home.svg
- info-circle.svg
- link-square.svg
- link.svg
- menu.svg
- monitor.svg
- moon.svg
- plus.svg
- railway.svg
- react.svg
- rss.svg
- search.svg
- spinner.svg
- square.svg
- star.svg
- sun.svg
- three-dots-horizontal.svg
- triangle-alert.svg
- types.ts
- typescript.svg
- vscode.svg
- x-icon.svg
- youtube.svg
- index.tsx
- modal.tsx
- open-modal-button.tsx
- accordion.tsx
- agent-install-command.tsx
- anchor.tsx
- arrow.tsx
- badge.tsx
- banner.tsx
- breadcrumb.tsx
- button.tsx
- card.tsx
- code-block.tsx
- collapse.tsx
- command.tsx
- dialog.tsx
- file-tree.tsx
- footer.tsx
- frame.tsx
- global-banner.tsx
- graphql-code-tabs.tsx
- header.tsx
- icon.tsx
- image.tsx
- inline-code.tsx
- inline-toc.tsx
- link.tsx
- loading-indicator.tsx
- logo.tsx
- mcp-install-guide.tsx
- page-actions.tsx
- page-nav.tsx
- scroll-area.tsx
- seo.tsx
- sheet.tsx
- sidebar-item.tsx
- sidebar.tsx
- steps.tsx
- table.tsx
- tabs.tsx
- tally-button.tsx
- theme-switcher.tsx
- toc.tsx
- tooltip.tsx
- top-nav.tsx
- tree.tsx
- index.ts
- copyable-code-context.tsx
- sidebar.ts
- page-urls.json
- use-copy-to-clipboard.ts
- use-debounced-search.ts
- use-global-banners.tsx
- use-hash-redirect.ts
- use-is-mounted.ts
- use-posthog.ts
- use-scroll-to-open-collapse.ts
- use-search-analytics.ts
- use-touch-primary.ts
- docs-layout.tsx
- guides-layout.tsx
- page.tsx
- cn.ts
- index.tsx
- export.ts
- llms-full.txt.ts
- llms.txt.ts
- [...slug].tsx
- [...slug].tsx
- [...slug].tsx
- index.tsx
- rss.xml.ts
- 404.tsx
- [...slug].tsx
- _app.tsx
- _document.tsx
- index.tsx
- icon-spritesheet.ts
- page-urls.ts
- rehype-code-block.ts
- index.ts
- animate.css
- colors.css
- fonts.css
- globals.css
- prose.css
- theme.tsx
- highlight.ts
- markdown.ts
- mdxUtils.ts
- page-url-set.ts
- scroll.ts
- seo.ts
- slugger.ts
- slugify.ts
- proxy.ts
- types.ts
- .env.example
- .gitignore
- .nvmrc
- .prettierignore
- .prettierrc
- content-collections.ts
- CONTRIBUTING.md
- docker-compose.yml
- flake.lock
- flake.nix
- LICENSE
- meilisearch-docs-scraper.config.json
- next-env.d.ts
- next-sitemap.config.js
- next.config.js
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- postcss.config.js
- railway.json
- README.md
- redirects.js
- shell.nix
- tsconfig.json
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Link
Example
Command Glossary
Commands referenced in this DOCs, explained below.
pnpm
View Details ▼
pnpm
Fast, disk space efficient package manager for Node.js.
Manage Node.js projects and their module dependencies.
pnpm init
Create a `package.json` file:
pnpm {{[i|install]}}
Download all the packages listed as dependencies in `package.json`:
pnpm add {{module_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
// repository documentation
Was this content helpful?
(0 ratings)
