diff --git a/docs/Navigation.md b/docs/Navigation.md index c1a03c17..c3c091a3 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -22,6 +22,7 @@ search: - [TrueNAS](install/truenas.md) - [Kubernetes](install/kubernetes.md) - [Railway](install/railway.md) + - [Hostinger](install/hostinger.md) - [ZimaOS](install/zimaos.md) - [NixOS](install/nixos.md) - [Backup & Restore](install/backup-and-restore.md) diff --git a/docs/install/hostinger.md b/docs/install/hostinger.md new file mode 100644 index 00000000..2ed93ab5 --- /dev/null +++ b/docs/install/hostinger.md @@ -0,0 +1,89 @@ +--- +title: Hostinger +description: Deploy on a Hostinger VPS with the built-in one-click application +--- + +# Hostinger + +[Hostinger](https://www.hostinger.com/applications/romm) ships RomM as a one-click application in its VPS catalog, so a fresh server comes up with the container, its database, and a reverse proxy already wired together. Hostinger builds and maintains the template, and the app itself is the same `rommapp/romm` image documented everywhere else in these docs. + +## What it deploys + +The template creates two Docker applications on the VPS: + +- **`romm-`**: two containers, the RomM app and a MariaDB database. There is no third container for the in-memory store, since the template leaves `REDIS_HOST` unset and the image starts its [embedded Valkey](redis-or-valkey.md). +- **`traefik`**: one container, acting as the reverse proxy. + +Resources, assets, and config live in named Docker volumes, while the library is a bind mount from a directory on the VPS, which is where you'll upload ROMs. + +## Prerequisites + +- A Hostinger VPS plan. The catalog offers the app on every tier down to the entry-level KVM 1, though your library shares the server's disk, so pick a plan whose storage fits your collection. + +## Install + +Start a new VPS order and pick a server location close to you. + +![Choosing a Hostinger server location](../resources/hostinger/choose-location.png) + +On the **Choose what to install** step, search for `romm` and pick it from the **Applications** tab. + +![Searching for RomM in the Hostinger application catalog](../resources/hostinger/choose-app.png) + +Confirm the app card with **Select**. + +![The RomM application card in the Hostinger catalog](../resources/hostinger/app-card.png) + +Hostinger then provisions the server and brings the stack up, which takes about five minutes. You can close the page, since an email arrives when it's ready. + +![Hostinger provisioning the RomM stack](../resources/hostinger/setup-progress.png) + +When it finishes, the VPS **Overview** lists RomM under **My applications** with an **Open app** button. + +![RomM listed on the Hostinger VPS overview](../resources/hostinger/vps-overview.png) + +Open it and the first-run **Setup Wizard** walks you through creating the first admin account. + +## Managing the stack + +**Docker Manager → Applications** lists both stacks with their status, a terminal, and a **Manage** button for each. + +![The RomM and Traefik applications in Hostinger's Docker Manager](../resources/hostinger/docker-manager.png) + +**Manage** on the RomM application is where you'll do everything after install, including editing environment variables, editing the compose file, viewing logs, and restarting or updating the containers. + +## Configuration + +The **Environment** section holds the values the template interpolates into the compose file, and **Save and deploy** applies a change by recreating the containers. + +![Editing RomM's environment variables in Hostinger](../resources/hostinger/environment-editor.png) + +Fill in the metadata provider credentials before your first scan, since matching quality depends on them (see [Metadata Providers](../getting-started/metadata-providers.md)). + + +!!! tip "Names have to match the compose file" + Each entry here is referenced from the compose file as `${NAME}`. If you rename a variable in the **Environment** section without renaming its reference, the container starts with that value empty rather than failing loudly. + +The full compose file is editable under **.yaml editor**, which is the place to add volumes, change the image tag, or set env vars the template doesn't expose. + +![Editing the RomM compose file in Hostinger's YAML editor](../resources/hostinger/yaml-editor.png) + +Everything in it is the standard configuration described in [Quick Start](../getting-started/quick-start.md) and the [Environment Variables reference](../reference/environment-variables.md). + +## Adding ROMs + +The library can live anywhere on the VPS disk, as long as the host directory is bind-mounted to `/romm/library` inside the container. The template mounts `/library`, and you can point it somewhere else by editing that line in the **.yaml editor**. Copy files to the host path over SFTP or SSH using the server's IP and the `root` credentials from the VPS overview: + +```bash +ssh root@ mkdir -p /library/roms +scp -r ~/roms/gbc root@:/library/roms/ +``` + +Platform folder names inside `roms/` 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)). + +## Getting help + +For problems with the VPS, the template, or Docker Manager, contact [Hostinger support](https://www.hostinger.com/contact), since they maintain the catalog entry. For issues with the app itself, try the [RomM Discord](https://discord.gg/P5HtHnhUDH) 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 31c35823..b033b35f 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, ZimaOS, or NixOS +description: On Docker Compose, Unraid, Synology, TrueNAS, Kubernetes, Railway, Hostinger, ZimaOS, or NixOS --- # Install & Deploy @@ -17,6 +17,7 @@ RomM is distributed as a Docker image. Every supported deployment runs the same | **TrueNAS** | [App Catalog or YAML install](truenas.md) | | **Kubernetes** | [Community charts and gotchas](kubernetes.md) | | **Railway** | [Community one-click template](railway.md) | +| **Hostinger** | [One-click VPS application](hostinger.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/hostinger/app-card.png b/docs/resources/hostinger/app-card.png new file mode 100644 index 00000000..16a4c87f Binary files /dev/null and b/docs/resources/hostinger/app-card.png differ diff --git a/docs/resources/hostinger/choose-app.png b/docs/resources/hostinger/choose-app.png new file mode 100644 index 00000000..5c7391d0 Binary files /dev/null and b/docs/resources/hostinger/choose-app.png differ diff --git a/docs/resources/hostinger/choose-location.png b/docs/resources/hostinger/choose-location.png new file mode 100644 index 00000000..c7d4f415 Binary files /dev/null and b/docs/resources/hostinger/choose-location.png differ diff --git a/docs/resources/hostinger/docker-manager.png b/docs/resources/hostinger/docker-manager.png new file mode 100644 index 00000000..d3880ae0 Binary files /dev/null and b/docs/resources/hostinger/docker-manager.png differ diff --git a/docs/resources/hostinger/environment-editor.png b/docs/resources/hostinger/environment-editor.png new file mode 100644 index 00000000..8557c489 Binary files /dev/null and b/docs/resources/hostinger/environment-editor.png differ diff --git a/docs/resources/hostinger/setup-progress.png b/docs/resources/hostinger/setup-progress.png new file mode 100644 index 00000000..45b66c1b Binary files /dev/null and b/docs/resources/hostinger/setup-progress.png differ diff --git a/docs/resources/hostinger/vps-overview.png b/docs/resources/hostinger/vps-overview.png new file mode 100644 index 00000000..1c1c9e2f Binary files /dev/null and b/docs/resources/hostinger/vps-overview.png differ diff --git a/docs/resources/hostinger/yaml-editor.png b/docs/resources/hostinger/yaml-editor.png new file mode 100644 index 00000000..73fff71d Binary files /dev/null and b/docs/resources/hostinger/yaml-editor.png differ