AGENT SKILL

deploy-railway

暂无简介

使用场景运维与部署
License 许可
Apache-2.0
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

03 SKILL.md 正文

Railway 部署

适用场景

  • 后端 API 服务:Node.js、Python、Go、Java、Ruby、PHP、Rust
  • 全栈应用:后端 + 托管数据库
  • Docker 化应用:通过 Dockerfile 部署
  • 需要托管数据库:PostgreSQL、MySQL、Redis、MongoDB
  • 多服务项目:一个 project 下管理多个服务 + 数据库

前置条件

  1. 安装 Railway CLI:npm i -g @railway/cli
  2. 登录 Railway:railway login(需要用户交互完成授权)
  3. 验证登录:railway whoami

部署流程

1. 初始化 Railway 项目

# 在项目根目录初始化(交互式,选择创建新项目或链接已有项目)
railway init

2. 自动构建检测

Railway 使用 Nixpacks 自动检测项目类型并构建,无需手动配置:

项目类型 检测依据 构建命令 启动命令
Node.js package.json npm install + npm run build npm start
Python requirements.txt / pyproject.toml pip install -r requirements.txt python main.py 或 gunicorn
Go go.mod go build 编译产物
Java pom.xml / build.gradle mvn package java -jar target/*.jar
Ruby Gemfile bundle install rails s 或 ruby app.rb
Docker Dockerfile Docker build Docker CMD

3. 配置启动命令(如自动检测失败)

创建 railway.json 或 railway.toml:

{
  "$schema": "https://railway.app/railway.schema.json",
  "build": {
    "builder": "NIXPACKS"
  },
  "deploy": {
    "startCommand": "node dist/server.js",
    "restartPolicyType": "ON_FAILURE",
    "restartPolicyMaxRetries": 10
  }
}
[build]
builder = "NIXPACKS"

[deploy]
startCommand = "python main.py"
restartPolicyType = "ON_FAILURE"
restartPolicyMaxRetries = 10

4. 部署

# 部署到 Railway
railway up

# 部署并指定环境
railway up --environment production

# 查看部署日志
railway logs

部署输出示例:

✔ Connected to project my-api
✔ Deploying...
✔ Build completed
✔ Deployed to production
? https://my-api-production.up.railway.app

5. 添加托管数据库

# 添加 PostgreSQL
railway add --plugin postgresql

# 添加 MySQL
railway add --plugin mysql

# 添加 Redis
railway add --plugin redis

# 添加 MongoDB
railway add --plugin mongodb

数据库连接串会自动注入为环境变量(如 DATABASE_URL、REDIS_URL)。

6. 环境变量管理

# 设置环境变量
railway variables set DATABASE_URL "postgres://..."

# 批量设置(从 .env 文件)
railway variables import .env

# 列出环境变量
railway variables

# 删除环境变量
railway variables unset DATABASE_URL

7. 自定义域名

# 添加自定义域名
railway domain add api.example.com

Docker 部署

如果项目有 Dockerfile,Railway 会自动使用 Docker 构建:

# 多阶段构建示例
FROM node:20-alpine AS builder
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY . .
RUN npm run build

FROM node:20-alpine
WORKDIR /app
COPY --from=builder /app/dist ./dist
COPY --from=builder /app/package*.json ./
RUN npm ci --omit=dev
EXPOSE 3000
CMD ["node", "dist/server.js"]

指定 Docker 构建:

{
  "$schema": "https://railway.app/railway.schema.json",
  "build": {
    "builder": "DOCKERFILE",
    "dockerfilePath": "Dockerfile"
  }
}

多服务项目

一个 Railway project 可以包含多个服务:

# 后端服务
cd backend && railway init --name my-backend

# 前端服务
cd ../frontend && railway init --name my-frontend

# 数据库(共享给所有服务)
railway add --plugin postgresql

CI/CD 集成

GitHub 自动部署

Railway 原生支持 Git 集成,连接仓库后 push 自动部署。

GitHub Actions 手动触发

name: Deploy to Railway
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test
      - name: Deploy to Railway
        run: railway up --environment production
        env:
          RAILWAY_TOKEN: ${{ secrets.RAILWAY_TOKEN }}

需要的 Secrets:

  • RAILWAY_TOKEN:Railway API Token(Account Settings → API Tokens)

项目类型适配

项目类型 builder startCommand 示例
Express/Koa (Node) NIXPACKS npm start
FastAPI/Flask (Python) NIXPACKS uvicorn main:app 或 gunicorn app:app
Gin/Fiber (Go) NIXPACKS ./server
Spring Boot (Java) NIXPACKS java -jar target/app.jar
Rails (Ruby) NIXPACKS rails s -b 0.0.0.0
Docker 应用 DOCKERFILE (Dockerfile CMD)

检查清单

  • [ ] railway.json 或 railway.toml 配置正确(如需要)
  • [ ] 启动命令正确(startCommand 或 Nixpacks 自动检测)
  • [ ] 数据库已添加(如需要)
  • [ ] 环境变量已配置(railway variables set)
  • [ ] 健康检查端点可访问
  • [ ] 部署 URL 可访问(*.up.railway.app 或自定义域名)
  • [ ] CI/CD Secrets 已配置

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-review-with-annotations

Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-find-and-synthesize-context

Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-update-docs

Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-records

Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-interactive-html

Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-collaborate-threads

Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.

★ 1.6k