From fff72889f6604c72f5743cae3406c548c05a043b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Garc=C3=ADa?=
 <dani-garcia@users.noreply.github.com>
Date: Sun, 2 Jun 2019 13:44:59 +0200
Subject: [PATCH] Document DB URL in .env file

---
 .env.template | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/.env.template b/.env.template
index 63c6c01..abd1f6d 100644
--- a/.env.template
+++ b/.env.template
@@ -4,8 +4,13 @@
 ## Main data folder
 # DATA_FOLDER=data
 
-## Individual folders, these override %DATA_FOLDER%
+## 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
+
+## Individual folders, these override %DATA_FOLDER%
 # RSA_KEY_FILENAME=data/rsa_key
 # ICON_CACHE_FOLDER=data/icon_cache
 # ATTACHMENTS_FOLDER=data/attachments