Skip to content

Navigation Menu

Sign in
Sign up

docs(install): add Cloudzy guide and one-click deploy buttons - #138

Open
gantoine wants to merge 8 commits into
main from
docs/cloudzy-one-click
Open

docs(install): add Cloudzy guide and one-click deploy buttons #138
gantoine wants to merge 8 commits into
main from
docs/cloudzy-one-click

Conversation

@gantoine

@gantoine gantoine commented Sep 11, 2026
edited
Loading

Copy link
Copy Markdown
Member

Cloudzy ships RomM as a one-click marketplace image, so this adds an install guide alongside the other provider pages. It also closes out the leftovers from #136, which is now closed as superseded.

Cloudzy guide

  • What it deploys: Ubuntu Server 24.04 LTS, a Compose stack at /root/romm with the app and MariaDB, embedded Valkey (no separate store container), and Caddy running on the host under systemd rather than in Docker.
  • Managing the stack: SSH plus docker compose from /root/romm.
  • Configuration: /root/romm/.env, with Hasheous enabled out of the box.
  • Domain and HTTPS: ROMM_BASE_URL, the Caddyfile site address, and the reload.
  • Adding ROMs: /root/romm/library/roms and /bios.

Wired into Navigation.md and the "Pick your path" table in install/index.md, with a deploy button pointing at a cart link that preselects the RomM image and a 2 GB plan.

Hostinger affiliate button

The affiliate link lived only in the README, so install/hostinger.md had no way to send signups back to the project. This carries the button and the disclosure admonition over from #136 onto the merged page.

Note for review

Cloudzy's marketplace page says "update ROMM_BASE_URL" and then writes the line as BASE_URL=https://example.com. The container reads ROMM_BASE_URL, so following their snippet literally leaves the public URL at its default. There's a tip callout about it in the page, and it's worth reporting upstream to them as well.

The Cloudzy page has no screenshots and a thin install section, both because I don't have a Cloudzy account to walk the order flow. Happy for someone with one to fill those in.

Verification

  • trunk fmt and trunk check clean on every changed file.
  • mkdocs build renders install/cloudzy/, copies both button SVGs, and resolves all internal links. --strict aborts only on pre-existing cairosvg/libcairo failures in the social-cards plugin, which is a local environment gap unrelated to this change.

🤖 Generated with Claude Code

gantoine and others added 3 commits September 11, 2026 16:06
Cloudzy ships RomM in its one-click marketplace, so document what the
image deploys and how to manage it after install: the Compose stack at
/root/romm, host-installed Caddy under systemd, the library and BIOS
paths, and the domain plus HTTPS steps.
Their marketplace page writes the base URL line as BASE_URL while the
container reads ROMM_BASE_URL, so call that out in a tip.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Reuses the badge from #136 and points it at a cart link that
preselects the RomM image and a 2 GB plan, matching how railway.md
leads with a deploy button.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The affiliate link lived only in the README, so the docs page had no
way to send signups back to the project. Carries the button and the
disclosure over from the closed #136.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@gantoine gantoine changed the title (削除) docs(install): add Cloudzy one-click VPS guide (削除ここまで) (追記) docs(install): add Cloudzy guide and one-click deploy buttons (追記ここまで) Sep 11, 2026
gantoine and others added 4 commits September 11, 2026 16:28
Drop the in-memory store aside, the domain prerequisite (the HTTPS
section already covers it), and the ordering walkthrough, which
screenshots will replace.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The block was a bare site line with nothing around it, which said less
than the sentence above it. Show the file it lives in, the address it
replaces, and that the block body stays as shipped.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Replaces the raw discord.gg/P5HtHnhUDH invite code with
discord.com/invite/romm, matching the social link already in
mkdocs.yml. The README's invidget badge takes a bare invite code
rather than a URL, so it gets the vanity code instead.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Normalises every RomM Discord link to the short vanity form, including
the social link in mkdocs.yml, so the docs use one spelling throughout.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /