docs: add NixOS install guide - #112
Merged
Merged
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
gantoine
approved these changes
Aug 26, 2026
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an install guide for running RomM natively on NixOS via the
services.rommNixOS module, and links it from the Install & Deploy overview and the nav sidebar.Important
Please don't merge this yet. The RomM package and module are still under review in nixpkgs: NixOS/nixpkgs#547607. This PR should only be merged once that one has landed in nixpkgs
master, so the docs never describe something that doesn't exist yet. I'll drop a comment here when it's in.The guide covers a minimal configuration, metadata provider credentials via an environment file, HTTPS, using an existing ROM library, external database/Redis, updates, and basic troubleshooting. It also notes that availability starts with
nixos-unstable(stable with NixOS 26.11), and that the module uses PostgreSQL rather than MariaDB.Verified with
mkdocs build --strictand prettier.🤖 Generated with Claude Code