Add example environment file

1 files changed, 38 insertions, 0 deletions

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..1a3da6d
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,38 @@
+## Flask config
+# production|development
+FLASK_ENV=development
+
+## App config
+# database to use: mysql|sqlite3
+DB_TYPE=mysql
+# secret key for flask
+SECRET_KEY=my-long-and-hard-to-guess-secret-key
+
+## Mail configuration
+#
+# Mail server config
+MAIL_SERVER=smtp
+MAIL_PORT=2525
+MAIL_USE_TLS=1
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+# Admin emails (semicolon separated)
+ADMIN_EMAILS=someone@example.com;
+
+## Database configuration
+
+# MySQL
+# - config for AnnotateChange
+AC_MYSQL_HOST=db
+AC_MYSQL_PORT=3306
+AC_MYSQL_DATABASE=annotatechange
+AC_MYSQL_USER=annotatechange
+AC_MYSQL_PASSWORD=the-sql-password
+# - config for MySQL docker image
+MYSQL_RANDOM_ROOT_PASSWORD=yes
+MYSQL_DATABASE=annotatechange
+MYSQL_USER=annotatechange
+MYSQL_PASSWORD=the-sql-password
+
+# SQLite3
+SQL3_FILENAME=app.db