From a55989107f496c058b9c143d78e7bb0de973fdc1 Mon Sep 17 00:00:00 2001
From: Jay's <dallardj@gmail.com>
Date: Thu, 18 Apr 2024 13:05:26 +0200
Subject: [PATCH] Refactor env config and add new env var keys doc (#37)

* refactor env config

* added documentation on new env vars in .env.example

* fix bootstrap

* Update .gitignore

remove .idea

---------

Co-authored-by: Crypta Eve <crypta@crypta.tech>
---
 .env => .env.example | 13 ++++++++++++-
 .gitignore           |  1 +
 bootstrap.sh         |  2 +-
 3 files changed, 14 insertions(+), 2 deletions(-)
 rename .env => .env.example (89%)
 create mode 100644 .gitignore

diff --git a/.env b/.env.example
similarity index 89%
rename from .env
rename to .env.example
index d67b070..4a8cd75 100644
--- a/.env
+++ b/.env.example
@@ -107,6 +107,11 @@ APP_URL=https://${SEAT_DOMAIN}
 
 APP_KEY=insecure
 
+# Application default locale
+# If you need to change the default locale of the server for notifications you need to put the locale code here
+# e.g. fr, en, ru, etc.
+APP_LOCALE=en
+
 # App Environment
 APP_ENV=local
 
@@ -175,8 +180,14 @@ EVE_CALLBACK_URL=${APP_URL}/auth/eve/callback
 # ---------------------------
 
 # This is an advanced setting. Understand the ramifications of change.
-
+# The type of driver that eseye should use for the cache
+# available values are file, redis
 ESEYE_CACHE_DRIVER=file
+
+# When using the file driver, this is the name of the folder in seat/storage that will store the cache files
 ESEYE_CACHE_STORAGE_PATH=eseye
+
+# When using the redis driver, this is the name of the redis connection. If using 'cache', it will reuse the existing
+# redis cache configuration found in seat/config/cache.php. It must be a configured connection
 ESEYE_CACHE_CONNECTION=cache
 ESEYE_CACHE_LOCK_CONNECTION=default
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4c49bd7
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.env
diff --git a/bootstrap.sh b/bootstrap.sh
index 5a75484..f96184f 100755
--- a/bootstrap.sh
+++ b/bootstrap.sh
@@ -61,7 +61,7 @@ curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANC
 curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANCH/docker-compose.mariadb.yml -o $SEAT_DOCKER_INSTALL/docker-compose.mariadb.yml
 curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANCH/docker-compose.traefik.yml -o $SEAT_DOCKER_INSTALL/docker-compose.traefik.yml
 curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANCH/docker-compose.proxy.yml -o $SEAT_DOCKER_INSTALL/docker-compose.proxy.yml
-curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANCH/.env -o $SEAT_DOCKER_INSTALL/.env
+curl -L https://raw.githubusercontent.com/eveseat/seat-docker/$SEAT_GITHUB_BRANCH/.env.example -o $SEAT_DOCKER_INSTALL/.env
 
 echo "Generating a random database password and writing it to the .env file."
 sed -i -- 's/DB_PASSWORD=i_should_be_changed/DB_PASSWORD='$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c22 ; echo '')'/g' .env