docs: add message_db.encoding to config docs

postalserver · Mar 1, 2024 · 0c1f925 · 0c1f925
1 parent fadca88
commit 0c1f925
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/doc/config/environment-variables.md b/doc/config/environment-variables.md
@@ -33,6 +33,7 @@ This document contains all the environment variables which are available for thi
 | `MESSAGE_DB_PORT` | Integer | The MariaDB port to connect to | 3306 |
 | `MESSAGE_DB_USERNAME` | String | The MariaDB username | postal |
 | `MESSAGE_DB_PASSWORD` | String | The MariaDB password |  |
+| `MESSAGE_DB_ENCODING` | String | The encoding to use when connecting to the MariaDB database | utf8mb4 |
 | `MESSAGE_DB_DATABASE_NAME_PREFIX` | String | The MariaDB prefix to add to database names | postal |
 | `LOGGING_RAILS_LOG_ENABLED` | Boolean | Enable the default Rails logger | false |
 | `LOGGING_SENTRY_DSN` | String | A DSN which should be used to report exceptions to Sentry |  |

diff --git a/doc/config/yaml.yml b/doc/config/yaml.yml
@@ -67,6 +67,8 @@ message_db:
   username: postal
   # The MariaDB password
   password: 
+  # The encoding to use when connecting to the MariaDB database
+  encoding: utf8mb4
   # The MariaDB prefix to add to database names
   database_name_prefix: postal