Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion docs/install/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

Expand Down
31 changes: 31 additions & 0 deletions docs/install/railway.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- prettier-ignore -->
!!! 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).
1 change: 1 addition & 0 deletions docs/resources/railway/button.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.