Add documentation about the expected Postmark API key environment var…

…iable.
studyhall-project · Oct 4, 2023 · d53be53 · d53be53
1 parent 0cee7de
commit d53be53
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/backend-elixir/.env.example b/backend-elixir/.env.example
@@ -0,0 +1,8 @@
+# We currenltly manage our production environment variables via Render's `Env Groups` feature.
+#
+# https://dashboard.render.com/env-group/evg-ckc433usmu8c73eo08tg
+#
+# This file aims to document specific environment variables that influence the Elixir backend project.
+
+# We use Postmark to send out emails, when `POSTMARK_API_KEY` is set the app will configure the Postmark adaptor.
+POSTMARK_API_KEY
diff --git a/backend-elixir/.gitignore b/backend-elixir/.gitignore
@@ -36,3 +36,6 @@ study_hall-*.tar
 npm-debug.log
 /assets/node_modules/
 
+# Hide local environment files.
+.env.*
+!.env.example