Skip to content

Document MySQL DSN password URL-encoding requirement#1692

Merged
josecelano merged 1 commit intotorrust:developfrom
josecelano:1606-document-mysql-dsn-password-url-encoding
Apr 17, 2026
Merged

Document MySQL DSN password URL-encoding requirement#1692
josecelano merged 1 commit intotorrust:developfrom
josecelano:1606-document-mysql-dsn-password-url-encoding

Conversation

@josecelano
Copy link
Copy Markdown
Member

Summary

Document that MySQL DSN passwords must be percent-encoded when they contain reserved URL characters.

Changes

  • Add URL-encoding guidance to container deployment docs.
  • Add URL-encoding note to the default MySQL tracker config example.
  • Clarify MySQL DSN format in configuration docs and add encoding requirement for reserved characters.

Why

Deployments commonly build DSNs from environment variables. Generated secrets can include characters like + and /, which break DSN parsing unless encoded.

Fixes #1606

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.51%. Comparing base (d178b2b) to head (bcbef65).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1692   +/-   ##
========================================
  Coverage    86.50%   86.51%           
========================================
  Files          288      288           
  Lines        22672    22672           
  Branches     22672    22672           
========================================
+ Hits         19613    19614    +1     
  Misses        2833     2833           
+ Partials       226      225    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@josecelano josecelano force-pushed the 1606-document-mysql-dsn-password-url-encoding branch from d6c1f97 to bcbef65 Compare April 16, 2026 20:08
@josecelano josecelano self-assigned this Apr 16, 2026
@josecelano josecelano added the Documentation Improves Instructions, Guides, and Notices label Apr 16, 2026
@josecelano
Copy link
Copy Markdown
Member Author

ACK bcbef65

@josecelano josecelano merged commit 0ed564c into torrust:develop Apr 17, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improves Instructions, Guides, and Notices

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document DSN password URL-encoding requirement for MySQL connection string

1 participant