diff --git a/docs/Navigation.md b/docs/Navigation.md index 53d9b25..8910772 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 98a164f..e9d84cb 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 69da4cf..9bf1395 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 0000000..e710e8b --- /dev/null +++ b/docs/install/railway.md @@ -0,0 +1,31 @@ +--- +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 0000000..5db07a9 --- /dev/null +++ b/docs/resources/railway/button.svg @@ -0,0 +1 @@ + \ No newline at end of file