From a499c183ac76048edd0195f740c69d002ba8ec6f Mon Sep 17 00:00:00 2001 From: dillonstreator Date: Sun, 2 Aug 2026 23:29:02 -0500 Subject: [PATCH 1/3] docs: add community Railway one-click install option Document the community-maintained Railway template alongside Unraid/TrueNAS/Kubernetes install paths. Co-authored-by: Cursor --- docs/Navigation.md | 1 + docs/getting-started/quick-start.md | 2 +- docs/install/index.md | 3 ++- docs/install/railway.md | 40 +++++++++++++++++++++++++++++ 4 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/install/railway.md diff --git a/docs/Navigation.md b/docs/Navigation.md index 53d9b252..89107725 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -21,6 +21,7 @@ search: - [Synology](install/synology.md) - [TrueNAS](install/truenas.md) - [Kubernetes](install/kubernetes.md) + - [Railway](install/railway.md) - [Backup & Restore](install/backup-and-restore.md) - Administration - [Overview](administration/index.md) diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index 98a164fc..e9d84cb7 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -5,7 +5,7 @@ description: Get your instance running in about fifteen minutes # Quick Start -This guide gets a RomM instance up and running with the default stack (MariaDB + Valkey) using Docker Compose. If you're on Unraid, Synology, TrueNAS, or Kubernetes, check out the [Install & Deploy](../install/index.md) section for platform-specific guides. +This guide gets a RomM instance up and running with the default stack (MariaDB + Valkey) using Docker Compose. If you're on Unraid, Synology, TrueNAS, Kubernetes, or Railway, check out the [Install & Deploy](../install/index.md) section for platform-specific guides. ## Before you start diff --git a/docs/install/index.md b/docs/install/index.md index 69da4cff..9bf1395b 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,6 +1,6 @@ --- title: Install & Deploy -description: On Docker Compose, Unraid, Synology, TrueNAS, or Kubernetes +description: On Docker Compose, Unraid, Synology, TrueNAS, Kubernetes, or Railway --- # Install & Deploy @@ -16,6 +16,7 @@ RomM is distributed as a Docker image. Every supported deployment runs the same | **Synology** | [Container Manager + DSM-specific notes](synology.md) | | **TrueNAS** | [App Catalog or YAML install](truenas.md) | | **Kubernetes** | [Community charts and gotchas](kubernetes.md) | +| **Railway** | [Community one-click template](railway.md) | If none of those match, start with [Docker Compose](../getting-started/quick-start.md) and adapt as needed. diff --git a/docs/install/railway.md b/docs/install/railway.md new file mode 100644 index 00000000..64de2430 --- /dev/null +++ b/docs/install/railway.md @@ -0,0 +1,40 @@ +--- +title: Railway +description: One-click deploy with a community-maintained Railway template +--- + +# Railway + +The RomM team doesn't publish a first-party Railway template. A +**community-maintained** one-click option is available if you want a hosted +deploy without wiring Docker Compose yourself. + +[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/romm) + +- Live template: +- Template source (deployment config only): + +## What it deploys + +The template runs the standard RomM stack as two Railway services: + +- **app** — `rommapp/romm` (public). Leaves `REDIS_HOST` unset so the image + starts its [embedded Valkey](redis-or-valkey.md). +- **mariadb** — MariaDB on private networking + +Railway allows one volume per service. The template mounts `/romm` on `app` +(library, resources, assets, and config). `/redis-data` is ephemeral on +Railway. + +## After deploy + +1. Open the public **app** URL and finish the first-boot setup wizard. +2. Place ROMs under `/romm/library` using a supported + [folder structure](../getting-started/folder-structure.md). +3. Optionally add [metadata provider](../getting-started/metadata-providers.md) + credentials in the Railway service variables, then run a scan. + + +!!! note "Community-maintained" + Report Railway-template issues to the [template maintainers](https://github.com/osbytes/template-romm/issues), + not the main RomM issue tracker. From 713708722565ba7e61f6804402895a7f423fefc8 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 3 Aug 2026 07:49:47 -0400 Subject: [PATCH 2/3] inject railway button --- docs/install/railway.md | 71 ++++++++++++++----------------- docs/resources/railway/button.svg | 1 + 2 files changed, 32 insertions(+), 40 deletions(-) create mode 100644 docs/resources/railway/button.svg diff --git a/docs/install/railway.md b/docs/install/railway.md index 64de2430..e710e8b7 100644 --- a/docs/install/railway.md +++ b/docs/install/railway.md @@ -1,40 +1,31 @@ ---- -title: Railway -description: One-click deploy with a community-maintained Railway template ---- - -# Railway - -The RomM team doesn't publish a first-party Railway template. A -**community-maintained** one-click option is available if you want a hosted -deploy without wiring Docker Compose yourself. - -[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/romm) - -- Live template: -- Template source (deployment config only): - -## What it deploys - -The template runs the standard RomM stack as two Railway services: - -- **app** — `rommapp/romm` (public). Leaves `REDIS_HOST` unset so the image - starts its [embedded Valkey](redis-or-valkey.md). -- **mariadb** — MariaDB on private networking - -Railway allows one volume per service. The template mounts `/romm` on `app` -(library, resources, assets, and config). `/redis-data` is ephemeral on -Railway. - -## After deploy - -1. Open the public **app** URL and finish the first-boot setup wizard. -2. Place ROMs under `/romm/library` using a supported - [folder structure](../getting-started/folder-structure.md). -3. Optionally add [metadata provider](../getting-started/metadata-providers.md) - credentials in the Railway service variables, then run a scan. - - -!!! note "Community-maintained" - Report Railway-template issues to the [template maintainers](https://github.com/osbytes/template-romm/issues), - not the main RomM issue tracker. +--- +title: Railway +description: One-click deploy with a community-maintained Railway template +--- + +# Railway + +If you want a hosted deploy without wiring the Docker Compose yourself, a **community-maintained** one-click install option for Railway is available. + +[![Deploy on Railway](../resources/railway/button.svg)](https://railway.com/deploy/romm) + + +!!! note "Community maintained" + Report Railway template issues to the [template maintainers](https://github.com/osbytes/template-romm/issues). + +## What it deploys + +The template runs the standard stack as two Railway services: + +- **app**: `rommapp/romm` (public), leaves `REDIS_HOST` unset so the image starts its [embedded Valkey](redis-or-valkey.md). +- **mariadb**: `mariadb` (private), MariaDB on private networking + +Since Railway only allows one volume per service, the template mounts `/romm` on `app` (library, resources, assets, and config), and `/redis-data` is ephemeral. + +## After deploy + +1. Open the public **app** URL and finish the first-boot setup wizard. +2. Place ROMs under `/romm/library` using a supported [folder structure](../getting-started/folder-structure.md). +3. Add [metadata provider](../getting-started/metadata-providers.md) credentials in the Railway service variables, then run a scan. + +The template source lives at [osbytes/template-romm](https://github.com/osbytes/template-romm). diff --git a/docs/resources/railway/button.svg b/docs/resources/railway/button.svg new file mode 100644 index 00000000..73df2c13 --- /dev/null +++ b/docs/resources/railway/button.svg @@ -0,0 +1 @@ + \ No newline at end of file From 7d07eecd1e825e1e39ed2b2342603ddc0e9389d9 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 3 Aug 2026 07:51:59 -0400 Subject: [PATCH 3/3] run fmt --- docs/resources/railway/button.svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/railway/button.svg b/docs/resources/railway/button.svg index 73df2c13..5db07a9f 100644 --- a/docs/resources/railway/button.svg +++ b/docs/resources/railway/button.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file