From 8d97e8d17ce0890d2ef4bf63b8fc83e7f70f95a4 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Wed, 28 Oct 2026 19:23:56 -0400 Subject: [PATCH 1/4] docs(install): add CoreHost managed hosting guide Co-Authored-By: Claude Opus 5.5 --- docs/Navigation.md | 1 + docs/install/corehost.md | 45 ++++++++++++++++++++++++++++++ docs/install/index.md | 3 +- docs/resources/corehost/button.svg | 5 ++++ 4 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 docs/install/corehost.md create mode 100644 docs/resources/corehost/button.svg diff --git a/docs/Navigation.md b/docs/Navigation.md index 9ef24d70..b41ff3e8 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -24,6 +24,7 @@ search: - [Railway](install/railway.md) - [Cloudzy](install/cloudzy.md) - [Hostinger](install/hostinger.md) + - [CoreHost](install/corehost.md) - [ZimaOS](install/zimaos.md) - [NixOS](install/nixos.md) - [Backup & Restore](install/backup-and-restore.md) diff --git a/docs/install/corehost.md b/docs/install/corehost.md new file mode 100644 index 00000000..aad1bc5b --- /dev/null +++ b/docs/install/corehost.md @@ -0,0 +1,45 @@ +--- +title: CoreHost +description: Run a managed RomM instance on CoreHost +--- + +# CoreHost + +[CoreHost](https://corehost.io/apps/romm) runs RomM as a managed app: each customer gets their own instance, with the database, cache, and scanner already running alongside the web app. CoreHost tests new RomM releases on its platform before rolling them out, and the instance runs the same unmodified code documented everywhere else in these docs. + +[![Deploy on CoreHost](../resources/corehost/button.svg)](https://corehost.io/apps/romm) + + +!!! info "Supporting RomM" + CoreHost shares a portion of the revenue from RomM instances with the project. + +## Plans + +Instances are billed hourly from a prepaid balance, and new accounts start with free credit. **Standard** (1 vCPU, 2 GB RAM, 10 GB NVMe) is the smallest plan that fits RomM, and **Power** and **Scale** add CPU, memory, and storage. Your games count toward the plan's storage, so a large collection needs a bigger tier or extra 25 GB storage blocks, which stack on any plan. See the [app page](https://corehost.io/apps/romm) for current prices and regions. + +## Install + +Pick RomM from the [CoreHost app catalog](https://corehost.io/apps), choose a plan and region, and the instance comes up with a generated password for the `admin` user, shown on the app page in the CoreHost panel. If you lose it, reset it under **Admin password** in the app settings and restart the app. + +Fill in the metadata provider credentials before your first scan, since matching quality depends on them (see [Metadata Providers](../getting-started/metadata-providers.md)). Hasheous and LaunchBox need no account, while the others take an API key. + +## Adding ROMs + +Small batches can go through the [upload dialog](../using/uploads.md) in the browser. For a larger collection, copy files over SFTP into `romm/library/roms/` (and BIOS files into `romm/library/bios/`), using the SFTP credentials from the CoreHost panel. + +Platform folder names have to match the expected naming (see [Folder Structure](../getting-started/folder-structure.md)). Once the files land, run a scan (see [Your First Scan](../getting-started/first-scan.md)). If you add files over SFTP often, enabling the nightly library scan picks them up without a manual run. + +## Backups and updates + +CoreHost backs up every instance daily, with a one-click restore from the panel, and can also send encrypted backups to your own S3-compatible storage. Updates are tested on a copy of the instance and roll back on their own if health checks fail. Data is purged 14 days after an instance is cancelled, so take an SFTP copy first if you want to keep it. + +## Custom domain + +Point a domain at the instance with a CNAME and a TXT verification record, and CoreHost issues the TLS certificate. If your domain uses CAA records, allow `letsencrypt.org`. + +## Getting help + +For problems with billing, the instance, backups, or the panel, contact [CoreHost support](https://corehost.io/control/support), since they run the hosting. For issues with the app itself, try the [RomM Discord](https://discord.gg/romm) or: + +- [Scanning Troubleshooting](../troubleshooting/scanning.md) for matching and ingest problems +- [Authentication Troubleshooting](../troubleshooting/authentication.md) for login issues diff --git a/docs/install/index.md b/docs/install/index.md index aba6cee3..f3b4e87b 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, Kubernetes, Railway, Cloudzy, Hostinger, ZimaOS, or NixOS +description: On Docker Compose, Unraid, Synology, TrueNAS, Kubernetes, Railway, Cloudzy, Hostinger, CoreHost, ZimaOS, or NixOS --- # Install & Deploy @@ -19,6 +19,7 @@ RomM is distributed as a Docker image. Every supported deployment runs the same | **Railway** | [Community one-click template](railway.md) | | **Cloudzy** | [One-click marketplace image](cloudzy.md) | | **Hostinger** | [One-click VPS application](hostinger.md) | +| **CoreHost** | [Managed instance](corehost.md) | | **ZimaOS** | [One-click install from the App Store](zimaos.md) | If none of those match, start with [Docker Compose](../getting-started/quick-start.md) and adapt as needed. diff --git a/docs/resources/corehost/button.svg b/docs/resources/corehost/button.svg new file mode 100644 index 00000000..c9d0a726 --- /dev/null +++ b/docs/resources/corehost/button.svg @@ -0,0 +1,5 @@ + + Deploy on CoreHost + + MANAGED INSTANCE + \ No newline at end of file From 99adb189b678108be82395f895db8b31f8153c8e Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Thu, 29 Oct 2026 12:31:59 -0400 Subject: [PATCH 2/4] docs(install): use the CoreHost referral link Co-Authored-By: Claude Opus 5.5 --- docs/install/corehost.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/install/corehost.md b/docs/install/corehost.md index aad1bc5b..ec31f8f9 100644 --- a/docs/install/corehost.md +++ b/docs/install/corehost.md @@ -5,9 +5,9 @@ description: Run a managed RomM instance on CoreHost # CoreHost -[CoreHost](https://corehost.io/apps/romm) runs RomM as a managed app: each customer gets their own instance, with the database, cache, and scanner already running alongside the web app. CoreHost tests new RomM releases on its platform before rolling them out, and the instance runs the same unmodified code documented everywhere else in these docs. +[CoreHost](https://corehost.io/p/romm) runs RomM as a managed app: each customer gets their own instance, with the database, cache, and scanner already running alongside the web app. CoreHost tests new RomM releases on its platform before rolling them out, and the instance runs the same unmodified code documented everywhere else in these docs. -[![Deploy on CoreHost](../resources/corehost/button.svg)](https://corehost.io/apps/romm) +[![Deploy on CoreHost](../resources/corehost/button.svg)](https://corehost.io/p/romm) !!! info "Supporting RomM" @@ -15,7 +15,7 @@ description: Run a managed RomM instance on CoreHost ## Plans -Instances are billed hourly from a prepaid balance, and new accounts start with free credit. **Standard** (1 vCPU, 2 GB RAM, 10 GB NVMe) is the smallest plan that fits RomM, and **Power** and **Scale** add CPU, memory, and storage. Your games count toward the plan's storage, so a large collection needs a bigger tier or extra 25 GB storage blocks, which stack on any plan. See the [app page](https://corehost.io/apps/romm) for current prices and regions. +Instances are billed hourly from a prepaid balance, and new accounts start with free credit. **Standard** (1 vCPU, 2 GB RAM, 10 GB NVMe) is the smallest plan that fits RomM, and **Power** and **Scale** add CPU, memory, and storage. Your games count toward the plan's storage, so a large collection needs a bigger tier or extra 25 GB storage blocks, which stack on any plan. See the [app page](https://corehost.io/p/romm) for current prices and regions. ## Install From 5dab5be856cd337eda333a7733badc9b7860b94a Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Thu, 29 Oct 2026 12:33:38 -0400 Subject: [PATCH 3/4] docs(install): send the setup step through the CoreHost referral link Co-Authored-By: Claude Opus 5.5 --- docs/install/corehost.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/corehost.md b/docs/install/corehost.md index ec31f8f9..04859081 100644 --- a/docs/install/corehost.md +++ b/docs/install/corehost.md @@ -19,7 +19,7 @@ Instances are billed hourly from a prepaid balance, and new accounts start with ## Install -Pick RomM from the [CoreHost app catalog](https://corehost.io/apps), choose a plan and region, and the instance comes up with a generated password for the `admin` user, shown on the app page in the CoreHost panel. If you lose it, reset it under **Admin password** in the app settings and restart the app. +Open the [RomM app on CoreHost](https://corehost.io/p/romm), choose a plan and region, and the instance comes up with a generated password for the `admin` user, shown on the app page in the CoreHost panel. If you lose it, reset it under **Admin password** in the app settings and restart the app. Fill in the metadata provider credentials before your first scan, since matching quality depends on them (see [Metadata Providers](../getting-started/metadata-providers.md)). Hasheous and LaunchBox need no account, while the others take an API key. From f3925e8712b29501d859a7ad0e8a04e06867dfd6 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Thu, 29 Oct 2026 12:47:26 -0400 Subject: [PATCH 4/4] docs(install): tighten the CoreHost guide wording Co-Authored-By: Claude Opus 5.5 --- docs/install/corehost.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/install/corehost.md b/docs/install/corehost.md index 04859081..65de5c52 100644 --- a/docs/install/corehost.md +++ b/docs/install/corehost.md @@ -5,7 +5,7 @@ description: Run a managed RomM instance on CoreHost # CoreHost -[CoreHost](https://corehost.io/p/romm) runs RomM as a managed app: each customer gets their own instance, with the database, cache, and scanner already running alongside the web app. CoreHost tests new RomM releases on its platform before rolling them out, and the instance runs the same unmodified code documented everywhere else in these docs. +[CoreHost](https://corehost.io/p/romm) runs RomM as a managed app. Each customer gets their own instance, with the database, cache, and scanner already set up next to the web app. CoreHost tests each RomM release before rolling it out, and instances run the same unmodified RomM that the rest of these docs describe. [![Deploy on CoreHost](../resources/corehost/button.svg)](https://corehost.io/p/romm) @@ -15,23 +15,23 @@ description: Run a managed RomM instance on CoreHost ## Plans -Instances are billed hourly from a prepaid balance, and new accounts start with free credit. **Standard** (1 vCPU, 2 GB RAM, 10 GB NVMe) is the smallest plan that fits RomM, and **Power** and **Scale** add CPU, memory, and storage. Your games count toward the plan's storage, so a large collection needs a bigger tier or extra 25 GB storage blocks, which stack on any plan. See the [app page](https://corehost.io/p/romm) for current prices and regions. +Instances are billed hourly from a prepaid balance, and new accounts start with free credit. Standard (1 vCPU, 2 GB RAM, 10 GB NVMe) is the smallest plan that fits RomM, and Power and Scale add more CPU, memory, and storage. Your games count against the plan's storage, so a large collection needs a bigger plan or extra 25 GB storage blocks, which you can add to any plan. See the [app page](https://corehost.io/p/romm) for current prices and regions. ## Install -Open the [RomM app on CoreHost](https://corehost.io/p/romm), choose a plan and region, and the instance comes up with a generated password for the `admin` user, shown on the app page in the CoreHost panel. If you lose it, reset it under **Admin password** in the app settings and restart the app. +Open the [RomM app on CoreHost](https://corehost.io/p/romm) and choose a plan and region. The new instance gets a generated password for the `admin` user, which the CoreHost panel shows on the app page. If you lose it, reset it under **Admin password** in the app settings and restart the app. -Fill in the metadata provider credentials before your first scan, since matching quality depends on them (see [Metadata Providers](../getting-started/metadata-providers.md)). Hasheous and LaunchBox need no account, while the others take an API key. +Set up metadata provider credentials before your first scan, because they decide how well games get matched (see [Metadata Providers](../getting-started/metadata-providers.md)). Hasheous and LaunchBox need no account, while the others take an API key. ## Adding ROMs Small batches can go through the [upload dialog](../using/uploads.md) in the browser. For a larger collection, copy files over SFTP into `romm/library/roms/` (and BIOS files into `romm/library/bios/`), using the SFTP credentials from the CoreHost panel. -Platform folder names have to match the expected naming (see [Folder Structure](../getting-started/folder-structure.md)). Once the files land, run a scan (see [Your First Scan](../getting-started/first-scan.md)). If you add files over SFTP often, enabling the nightly library scan picks them up without a manual run. +Platform folder names must follow RomM's naming (see [Folder Structure](../getting-started/folder-structure.md)). After the upload finishes, run a scan (see [Your First Scan](../getting-started/first-scan.md)). If you add files over SFTP often, turn on the nightly library scan so new files get picked up without a manual run. ## Backups and updates -CoreHost backs up every instance daily, with a one-click restore from the panel, and can also send encrypted backups to your own S3-compatible storage. Updates are tested on a copy of the instance and roll back on their own if health checks fail. Data is purged 14 days after an instance is cancelled, so take an SFTP copy first if you want to keep it. +CoreHost backs up every instance daily, and you can restore a backup in one click from the panel. It can also send encrypted backups to your own S3-compatible storage. Updates run on a copy of the instance first and roll back automatically if health checks fail. CoreHost deletes an instance's data 14 days after you cancel it, so copy your files off over SFTP first if you want to keep them. ## Custom domain