docs: document MariaDB/MySQL binary logging prerequisite - #109
Merged
Conversation
Migrations create triggers on the roms table, which MariaDB/MySQL refuse when binary logging is on and the RomM user lacks SUPER, aborting startup with a raw traceback. Add the fix (log_bin_trust_function_creators or a BINLOG ADMIN/SUPER grant) to the Databases page, and point at it from troubleshooting, the quick start, and the Unraid guide. Refs rommapp/romm#3932 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Users pointing RomM at an external or managed MariaDB/MySQL server hit a hard startup failure when binary logging is enabled and the RomM DB user lacks
SUPER: the migrations that create triggers on theromstable are refused, and the container dies with a raw SQLAlchemy traceback. This was never documented, so affected users had nothing to search for.install/databases.md: new Binary logging and trigger privileges section with the error text, why it affects external servers (binlog is on by default on MySQL 8) and not the bundledmariadb:11, and the fixes:SET GLOBAL log_bin_trust_function_creators = 1, the persistent[mysqld]option-file version (includingcustom.cnfunder/configon the linuxserver image), or aBINLOG ADMIN/SUPERgrant.troubleshooting/index.md: symptom bullet under "RomM won't start" linking to the above.getting-started/quick-start.md: one line for people who drop theromm-dbservice and use their own server.install/unraid.md: pointer next to the MariaDB template step.Refs rommapp/romm#3932 (fix guidance from rommapp/romm#3932 (comment) and the surrounding thread).
Verified with
mkdocs build --strict(social plugin disabled locally, missing libcairo).🤖 Generated with Claude Code