Introduced support of the .env for the local development (#537)

* Introduced support of the .env for the local development * Update the documentation
spryker · Dec 12, 2024 · 16517a0 · 16517a0
1 parent b9109ce
commit 16517a0
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 0 deletions.
diff --git a/bin/command/install/bootstrap.sh b/bin/command/install/bootstrap.sh
@@ -98,6 +98,8 @@ function Command::bootstrap() {
     if [ -d "${projectDeployTemplatesDirectory}" ]; then
         cp -rf "${projectDeployTemplatesDirectory}" "${tmpDeploymentDir}/project-deploy-templates"
     fi
+    [ -f "./.env" ] && { mkdir -p "${tmpDeploymentDir}/env" && cp "./.env" "${tmpDeploymentDir}/env/.env"; } || { mkdir -p "${tmpDeploymentDir}/env" && touch "${tmpDeploymentDir}/env/.env"; }
+
     Console::end "[DONE]"
 
     Console::info "${INFO}Running generator${NC}"

diff --git a/docs/02-development/02-environment-variables.md b/docs/02-development/02-environment-variables.md
@@ -0,0 +1,20 @@
+# Passing Vulnerable Secrets for Local Development
+
+This document explains how to use a **.env** file **for the local environment**.
+
+## Configuring .env
+
+1. Navigate to the **root directory of your project** and create a file named **.env**.
+2. Set up the necessary secrets for your environment.
+3. Bootstrap the Docker SDK:
+```bash
+   docker/sdk boot {deploy file name}
+```
+4. Start the local project:
+```bash
+docker/sdk up
+```
+
+Once the project is running, all secrets from the .env file will be accessible to all Spryker applications, such as Backoffice, Yves, etc.
+
+**Note:** Ensure that **.env** is added to **.gitignore** (if not already) to prevent committing vulnerable secrets to the repository.
diff --git a/generator/src/templates/application/backend-gateway.yml.twig b/generator/src/templates/application/backend-gateway.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/backoffice.yml.twig b/generator/src/templates/application/backoffice.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/glue-backend.yml.twig b/generator/src/templates/application/glue-backend.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/glue.yml.twig b/generator/src/templates/application/glue.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/merchant-portal.yml.twig b/generator/src/templates/application/merchant-portal.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/yves.yml.twig b/generator/src/templates/application/yves.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}

diff --git a/generator/src/templates/application/zed.yml.twig b/generator/src/templates/application/zed.yml.twig
@@ -8,6 +8,7 @@
       'spryker.project': ${SPRYKER_DOCKER_PREFIX}:${SPRYKER_DOCKER_TAG}
     env_file:
       - ${DEPLOYMENT_PATH}/env/{{ applicationName }}.env
+      - ${DEPLOYMENT_PATH}/env/.env
     environment:
       SPRYKER_TESTING_ENABLED: ${SPRYKER_TESTING_ENABLE}
       SPRYKER_XDEBUG_HOST_IP: ${SPRYKER_XDEBUG_HOST_IP}