home / skills / railwayapp / railway-skills / domain

This skill helps you add, view, or remove Railway domains, retrieve service URLs, and generate custom or railway domains efficiently.

npx playbooks add skill railwayapp/railway-skills --skill domain

Review the files below or copy the command above to add this skill to your agents.

Files (5)
SKILL.md
2.7 KB
---
name: domain
description: This skill should be used when the user wants to add a domain, generate a railway domain, check current domains, get the URL for a service, or remove a domain.
allowed-tools: Bash(railway:*)
---

# Domain Management

Add, view, or remove domains for Railway services.

## When to Use

- User asks to "add a domain", "generate a domain", "get a URL"
- User wants to add a custom domain
- User asks "what's the URL for my service"
- User wants to remove a domain

## Add Railway Domain

Generate a railway-provided domain (max 1 per service):

```bash
railway domain --json
```

For a specific service:
```bash
railway domain --json --service backend
```

### Response
Returns the generated domain URL. Service must have a deployment.

## Add Custom Domain

```bash
railway domain example.com --json
```

### Response
Returns required DNS records:
```json
{
  "domain": "example.com",
  "dnsRecords": [
    { "type": "CNAME", "host": "@", "value": "..." }
  ]
}
```

Tell user to add these records to their DNS provider.

## Read Current Domains

Use `environment` skill to see configured domains, or query directly:

```graphql
query domains($envId: String!) {
  environment(id: $envId) {
    config(decryptVariables: false)
  }
}
```

Domains are in `config.services.<serviceId>.networking`:
- `serviceDomains` - Railway-provided domains
- `customDomains` - User-provided domains

## Remove Domain

Use `environment` skill to remove domains:

### Remove custom domain
```json
{
  "services": {
    "<serviceId>": {
      "networking": {
        "customDomains": { "<domainId>": null }
      }
    }
  }
}
```

### Remove railway domain
```json
{
  "services": {
    "<serviceId>": {
      "networking": {
        "serviceDomains": { "<domainId>": null }
      }
    }
  }
}
```

Then use `environment` skill to apply and commit the change.

## CLI Options

| Flag | Description |
|------|-------------|
| `[DOMAIN]` | Custom domain to add (omit for railway domain) |
| `-p, --port <PORT>` | Port to connect |
| `-s, --service <NAME>` | Target service (defaults to linked) |
| `--json` | JSON output |

## Composability

- **Read domains**: Use `environment` skill
- **Remove domains**: Use `environment` skill
- **Apply removal**: Use `environment` skill
- **Check service**: Use `service` skill

## Error Handling

### No Service Linked
```
No service linked. Use --service flag or run `railway service` to select one.
```

### Domain Already Exists
```
Service already has a railway-provided domain. Maximum 1 per service.
```

### No Deployment
```
Service has no deployment. Deploy first with `railway up`.
```

### Invalid Domain
```
Invalid domain format. Use a valid domain like "example.com" or "api.example.com".
```

Overview

This skill manages domains for Railway services: add a Railway-provided domain, add a custom domain, list configured domains, get a service URL, or remove a domain. It ties into Railway environments and services to return DNS requirements, enforce limits, and apply domain removals.

How this skill works

Generating a Railway domain or adding a custom domain runs the domain command and returns either a generated URL or required DNS records to configure at your DNS provider. Reading and removing domains is done by inspecting and updating the environment configuration under services.<serviceId>.networking, then applying the change via the environment workflow. The skill validates service linkage, deployment presence, and domain format.

When to use it

  • Add a Railway-provided domain for a deployed service
  • Add a custom domain and get required DNS records
  • Ask "what's the URL for my service" or request the service URL
  • List current domains configured for an environment or service
  • Remove a custom or Railway-provided domain from a service

Best practices

  • Ensure the target service has a deployment before generating a Railway domain
  • Provide --service when no service is linked to avoid ambiguity
  • Copy all returned DNS records exactly into your DNS provider and wait for propagation
  • Use the environment skill to read current config and to apply/remove domains atomically
  • Respect the limit of one Railway-provided domain per service

Example use cases

  • Generate a Railway domain for the backend service to share a quick staging URL
  • Add example.com as a custom domain and return CNAME/A records for DNS setup
  • Check configured domains in the environment to audit routing
  • Remove an old custom domain from a service by updating networking.customDomains
  • Get the canonical URL for a service to include in documentation or CI tests

FAQ

What if no service is linked?

Use the --service flag with the service name or run `railway service` to link a service before adding a domain.

Why can't I add another Railway domain?

Each service can have a maximum of one Railway-provided domain; remove the existing railway domain first if you need a new one.

What DNS records will I receive for a custom domain?

The command returns a JSON block listing DNS records (CNAME/A) and host values you must add at your DNS provider.