diff --git a/docs/Navigation.md b/docs/Navigation.md index c2d8ef62..0392af0a 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) + - [Pethost](install/pethost.md) - [Cloudzy](install/cloudzy.md) - [Hostinger](install/hostinger.md) - [ZimaOS](install/zimaos.md) diff --git a/docs/install/index.md b/docs/install/index.md index aba6cee3..9b26e020 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, Pethost, Cloudzy, 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) | +| **Pethost** | [One-click template](pethost.md) | | **Cloudzy** | [One-click marketplace image](cloudzy.md) | | **Hostinger** | [One-click VPS application](hostinger.md) | | **ZimaOS** | [One-click install from the App Store](zimaos.md) | diff --git a/docs/install/pethost.md b/docs/install/pethost.md new file mode 100644 index 00000000..267defb8 --- /dev/null +++ b/docs/install/pethost.md @@ -0,0 +1,27 @@ +--- +title: Pethost +description: One-click deploy with Pethost's RomM template +--- + +# Pethost + +[Pethost](https://pethost.dev/) is managed Docker hosting with one-click templates. Its RomM template runs the standard stack as a Docker Compose project, with an HTTPS address and nightly backups. + +[![Deploy on Pethost](../resources/pethost/button.svg)](https://pethost.dev/templates/romm/) + + +!!! note "Maintained by Pethost" + Report template issues to [support@pethost.dev](mailto:support@pethost.dev). + +## What it deploys + +- **romm**: `rommapp/romm:5`, behind the project's HTTPS address. `REDIS_HOST` is unset, so the image starts its [embedded Valkey](redis-or-valkey.md). +- **db**: `mariadb:11.8`, reachable only inside the project + +One named volume holds `/romm` (library, resources, assets and config), another `/redis-data`, and a third MariaDB's data. `ROMM_AUTH_SECRET_KEY` and the database passwords are generated at deploy and kept in the project's `.env`. `HASHEOUS_API_ENABLED` is on, as in the reference compose file. + +## After deploy + +1. Open the project's address and finish the first-boot setup wizard. +2. Place ROMs under `/romm/library` using a supported [folder structure](../getting-started/folder-structure.md), over SFTP or with an upload in RomM. +3. Add [metadata provider](../getting-started/metadata-providers.md) credentials to the project's `.env`, deploy again, then run a scan. diff --git a/docs/resources/pethost/button.svg b/docs/resources/pethost/button.svg new file mode 100644 index 00000000..77eb6f13 --- /dev/null +++ b/docs/resources/pethost/button.svg @@ -0,0 +1 @@ + \ No newline at end of file