From 2fbefbddd741a8dee94967ebda86b7c908ad8d35 Mon Sep 17 00:00:00 2001
From: Thomas Gerber <thomas@faros.ai>
Date: Fri, 22 Apr 2022 11:17:11 -0700
Subject: [PATCH] Organize .env file better (#112)

Also clarifies what db hosts must correspond to.
---
 .env | 117 +++++++++++++++++++++++++++++++----------------------------
 1 file changed, 62 insertions(+), 55 deletions(-)

diff --git a/.env b/.env
index bce91606..85189092 100644
--- a/.env
+++ b/.env
@@ -1,4 +1,62 @@
-############################## AirByte ########################################
+COMPOSE_PROFILES="airbyte,default,faros-db"
+
+############################## Faros ##########################################
+# The db_host, db_port, db_user and db_pass are identical to those used by Airbyte.
+# This is because we use a single db service for the Faros Community Edition deployment and host all required databases
+# on the same host. That service is faros-db, which extends the airbyte db service.
+# These can be overriden as needed.
+# Note that hosts (faros host, faros config host, airbyte host) MUST correspond a service running postgres.
+FAROS_CONFIG_DB_HOST=faros-db
+FAROS_CONFIG_DB_PORT=5432
+FAROS_CONFIG_DB_USER=docker
+FAROS_CONFIG_DB_PASSWORD=docker
+FAROS_DB_NAME=faros
+FAROS_DB_HOST=faros-db
+FAROS_DB_PORT=5432
+FAROS_DB_USER=docker
+FAROS_DB_PASSWORD=docker
+FAROS_INIT_LOG_LEVEL=info
+FAROS_AIRBYTE_FORCE_SETUP=false
+
+############################## Airbyte ########################################
+# Airbyte Internal Job Database, see https://docs.airbyte.io/operator-guides/configuring-airbyte-db
+DATABASE_USER=docker
+DATABASE_PASSWORD=docker
+DATABASE_HOST=faros-db
+DATABASE_PORT=5432
+DATABASE_DB=airbyte
+# translate manually DATABASE_URL=jdbc:postgresql://${DATABASE_HOST}:${DATABASE_PORT/${DATABASE_DB} (do not include the username or password here)
+DATABASE_URL=jdbc:postgresql://faros-db:5432/airbyte
+# Host must correspond to the service name running webapp
+AIRBYTE_URL=http://airbyte-webapp:80
+AIRBYTE_DESTINATION_HASURA_URL=http://localhost:8080
+AIRBYTE_IMAGE_PREFIX="airbyte/"
+
+############################## Hasura #########################################
+HASURA_DB_NAME=hasura
+HASURA_PORT=8080
+HASURA_GRAPHQL_ADMIN_SECRET=admin
+HASURA_URL=http://hasura:8080
+HASURA_VERSION=v2.1.1
+
+############################## Metabase #######################################
+METABASE_IMAGE="metabase/metabase"
+METABASE_DB_NAME=metabase
+METABASE_PORT=3000
+METABASE_USER=admin@admin.com
+METABASE_PASSWORD=admin
+METABASE_URL=http://metabase:3000
+METABASE_USE_SSL=false
+# The db_host used in Metabase to connect to the Faros database.
+METABASE_FAROS_DB_HOST=faros-db
+
+############################## n8n ############################################
+N8N_DB_NAME=n8n
+N8N_PORT=5678
+N8N_VERSION=0.164.1
+N8N_DOCKER_MOUNT=n8n_data
+
+############################## AirByte default config #########################
 # This file only contains Docker relevant variables.
 #
 # Variables with defaults have been omitted to avoid duplication of defaults.
@@ -9,10 +67,10 @@
 #
 # # Contributors - please organize this env file according to the above linked file.
 
+# Source: https://github.com/airbytehq/airbyte/blob/5643c1747152defb81d760911884f36618617abd/.env
+
 ### SHARED ###
-COMPOSE_PROFILES="airbyte,default,faros-db"
 VERSION=0.35.5-alpha
-AIRBYTE_IMAGE_PREFIX="airbyte/"
 
 # When using the airbyte-db via default docker image
 CONFIG_ROOT=/data
@@ -36,14 +94,7 @@ HACK_LOCAL_ROOT_PARENT=/tmp
 
 
 ### DATABASE ###
-# Airbyte Internal Job Database, see https://docs.airbyte.io/operator-guides/configuring-airbyte-db
-DATABASE_USER=docker
-DATABASE_PASSWORD=docker
-DATABASE_HOST=faros-db
-DATABASE_PORT=5432
-DATABASE_DB=airbyte
-# translate manually DATABASE_URL=jdbc:postgresql://${DATABASE_HOST}:${DATABASE_PORT/${DATABASE_DB} (do not include the username or password here)
-DATABASE_URL=jdbc:postgresql://faros-db:5432/airbyte
+# Faros note: main database settings have been moved above for clarity
 JOBS_DATABASE_MINIMUM_FLYWAY_MIGRATION_VERSION=0.29.15.001
 
 # Airbyte Internal Config Database, defaults to Job Database if empty. Explicitly left empty to mute docker compose warnings.
@@ -97,47 +148,3 @@ PAPERCUPS_STORYTIME=disabled
 RUN_DATABASE_MIGRATION_ON_STARTUP=true
 SECRET_PERSISTENCE=NONE
 WORKER_ENVIRONMENT=docker
-
-############################## Faros ##########################################
-# The db_host, db_port, db_user and db_pass are identical to those used by Airbyte (see Airbyte job database cfg above).
-# This is because we use a single db service for the Faros Community Edition deployment and host all required databases
-# on the same host. These can be overriden as needed.
-FAROS_CONFIG_DB_HOST=faros-db
-FAROS_CONFIG_DB_PORT=5432
-FAROS_CONFIG_DB_USER=docker
-FAROS_CONFIG_DB_PASSWORD=docker
-FAROS_DB_NAME=faros
-FAROS_DB_HOST=faros-db
-FAROS_DB_PORT=5432
-FAROS_DB_USER=docker
-FAROS_DB_PASSWORD=docker
-FAROS_INIT_LOG_LEVEL=info
-FAROS_AIRBYTE_FORCE_SETUP=false
-
-############################## Airbyte ########################################
-AIRBYTE_URL=http://airbyte-webapp:80
-AIRBYTE_DESTINATION_HASURA_URL=http://localhost:8080
-
-############################## Hasura #########################################
-HASURA_DB_NAME=hasura
-HASURA_PORT=8080
-HASURA_GRAPHQL_ADMIN_SECRET=admin
-HASURA_URL=http://hasura:8080
-HASURA_VERSION=v2.1.1
-
-############################## Metabase #######################################
-METABASE_IMAGE="metabase/metabase"
-METABASE_DB_NAME=metabase
-METABASE_PORT=3000
-METABASE_USER=admin@admin.com
-METABASE_PASSWORD=admin
-METABASE_URL=http://metabase:3000
-METABASE_USE_SSL=false
-# The db_host used in Metabase to connect to the Faros database.
-METABASE_FAROS_DB_HOST=faros-db
-
-############################## n8n ############################################
-N8N_DB_NAME=n8n
-N8N_PORT=5678
-N8N_VERSION=0.164.1
-N8N_DOCKER_MOUNT=n8n_data