commit eba22c2d9429b9f9bad5baff9b1d571b469645c9
parent 11cc9ae0c05daa849f769aefbb31db96b46f976e
Author: Daniel GarcĂa <dani-garcia@users.noreply.github.com>
Date: Thu, 13 Aug 2020 22:34:46 +0200
Merge pull request #1095 from jjlin/db-docs
Add more doc comments for MySQL/PostgreSQL connection URIs
Diffstat:
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/.env.template b/.env.template
@@ -9,9 +9,16 @@
## Database URL
## When using SQLite, this is the path to the DB file, default to %DATA_FOLDER%/db.sqlite3
-## When using MySQL, this it is the URL to the DB, including username and password:
-## Format: mysql://[user[:password]@]host/database_name
# DATABASE_URL=data/db.sqlite3
+## When using MySQL, specify an appropriate connection URI.
+## Details: https://docs.diesel.rs/diesel/mysql/struct.MysqlConnection.html
+# DATABASE_URL=mysql://user:password@host[:port]/database_name
+## When using PostgreSQL, specify an appropriate connection URI (recommended)
+## or keyword/value connection string.
+## Details:
+## - https://docs.diesel.rs/diesel/pg/struct.PgConnection.html
+## - https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
+# DATABASE_URL=postgresql://user:password@host[:port]/database_name
## Individual folders, these override %DATA_FOLDER%
# RSA_KEY_FILENAME=data/rsa_key