Skip to content

Commit c78b251

Browse files
committed
Rename Railway compose to template-base import artifact
1 parent f1a4bb5 commit c78b251

3 files changed

Lines changed: 32 additions & 12 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ Credentials: `docs/deploy/aws.md#retrieving-credentials`
8484
One-click deploy provisions a Railway service with automatic HTTPS.
8585

8686
> **Important:** Attach a Railway Volume mounted to `/home/opencoder/.local/share/opencode` to prevent data loss across redeploys.
87+
> For manual template import, use `docker-compose.railway-template-base.yml` as a Railway importer compatibility base (not as the canonical runtime compose).
8788
8889
Docs: `docs/deploy/railway.md`
8990

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# opencode-cloud Railway Compose Template
1+
# opencode-cloud Railway template-base compose
22
#
3-
# Use this file for Railway template import workflows.
4-
# The canonical docker-compose.yml remains local/quick-deploy focused and
5-
# includes six volumes that Railway template import does not support.
3+
# Import this file into Railway only as a base for template workflows.
4+
# The canonical runtime compose for local/quick-deploy remains
5+
# docker-compose.yml.
6+
#
7+
# Intentional Railway importer compatibility constraints:
8+
# - single persisted volume only
9+
# - fixed image string (no env interpolation in "image")
10+
# - import-focused subset of compose keys; runtime knobs kept where supported
611

712
services:
813
opencode:

docs/deploy/railway.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,32 @@ Steps:
2121
> **Important:** After deploying, verify that a Railway Volume is attached.
2222
> Without a volume, all data is lost on every redeploy.
2323
24-
## Template from Compose File (Manual Upload)
24+
## Template Base Compose for Railway Import (Manual Upload)
2525

2626
If you are creating a Railway template by importing a Compose file, use
27-
`docker-compose.railway.yml` from this repository.
27+
`docker-compose.railway-template-base.yml` from this repository.
2828

2929
Do **not** import the root `docker-compose.yml` for Railway templates. That
3030
file is local/quick-deploy oriented and declares six volumes.
3131

3232
```bash
33-
curl -O https://raw.githubusercontent.com/pRizz/opencode-cloud/main/docker-compose.railway.yml
33+
curl -O https://raw.githubusercontent.com/pRizz/opencode-cloud/main/docker-compose.railway-template-base.yml
3434
```
3535

36-
Railway template import supports one volume per service. The Railway-specific
37-
compose file keeps a single persisted mount at
38-
`/home/opencoder/.local/share/opencode` for compatibility.
39-
It keeps variable-driven runtime/logging knobs where Railway supports them and
40-
uses a fixed image reference to avoid Railway parser issues.
36+
This file is intentionally a **template-base import artifact**, not a full
37+
runtime compose parity file.
38+
39+
Railway template import currently supports one volume per service and does not
40+
support all compose features uniformly. The template-base file intentionally
41+
keeps:
42+
- one persisted mount at `/home/opencoder/.local/share/opencode`
43+
- a fixed image reference (no env interpolation in `image`)
44+
- an import-focused subset of compose keys, with runtime knobs kept where
45+
Railway supports them
46+
47+
After import, apply any additional Railway-specific runtime configuration in
48+
Railway settings/template editor.
49+
4150
## Manual Deployment
4251

4352
### Prerequisites
@@ -223,6 +232,11 @@ To create or update the Railway one-click deploy template:
223232
7. **Create** and **Publish** the template
224233
8. Copy the template URL and update the deploy button in `README.md`
225234

235+
Maintenance rule:
236+
- When image references or required Railway env keys change, update both
237+
`docker-compose.yml` and `docker-compose.railway-template-base.yml` in the
238+
same PR.
239+
226240
The deploy button format:
227241

228242
```markdown

0 commit comments

Comments
 (0)