Add PostgreSQL and MySQL database configuration documentation - #34
Merged
MarkProminic merged 1 commit intoSep 25, 2025
Merged
Conversation
- Add comprehensive database setup instructions for PostgreSQL and MySQL - Include schema ownership fix for PostgreSQL ENUM creation - Add troubleshooting sections for all database types - Update architecture diagram to reflect multi-database support - Fix config.yaml.example references to use dev.config.yaml - Document required dependencies (pg, mysql2 packages) Co-Authored-By: mark.gilbert@prominic.net <mark.gilbert@prominic.net>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
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
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.
Add PostgreSQL and MySQL database configuration documentation
Summary
Updates Armor documentation to reflect the recently implemented multi-database support (PostgreSQL, MySQL, SQLite). Adds comprehensive configuration examples, setup instructions, troubleshooting guidance, and environment variable documentation for all three database types.
Key Changes:
docs/configuration.mddocs/guides/installation.mdincluding dependency installation, user creation, and critical PostgreSQL schema ownership fixconfig.yaml.examplereferences to use existingdev.config.yamlReview & Testing Checklist for Human
docs/configuration.mdthat need to be removed (visible in diff)ALTER SCHEMA public OWNER TO armor_user;is the correct fix for ENUM creation issuespgandmysql2are the correct npm package names for database driversNotes
This addresses the production PostgreSQL compatibility issues mentioned in the session. The schema ownership fix (
ALTER SCHEMA public OWNER TO armor_user;) was identified as critical for resolving ENUM creation permissions errors that were causing startup failures.Link to Devin run: https://app.devin.ai/sessions/30b40362482e42109b8243b6c7a36ca3
Requested by: @MarkProminic