Updated Docs

DEFRA · Aug 23, 2024 · 58bac64 · 58bac64
1 parent 8c70842
commit 58bac64
Showing 1 changed file with 26 additions and 1 deletion.
diff --git a/docs/Developer-Reference/Infrastructure/ADP Portal.md b/docs/Developer-Reference/Infrastructure/ADP Portal.md
@@ -44,11 +44,13 @@ To sign commits using GPG from within the devcontainer, please follow [the steps
 
 ### Environment Variables
 
-The application requires the following environment variables to be set. We recommend creating a `.env` file in the root of your repo (this is ignored by Git) and pasting the variables in to this file. This file will be used whenever you run a script through `yarn` such as `yarn dev`.
+The application requires the following environment variables to be set. We recommend creating a `.env` file in the root of your repo (this is ignored by Git) and pasting the variables in to this file. This file will be used whenever you run a script through `yarn` such as `yarn dev`. All environment variables that are left blank can be found in the dev keyvault in azure
 
 ```sh
 APP_BASE_URL=http://localhost:3000
 APP_BACKEND_BASE_URL=http://localhost:7007
+ADP_PORTAL_API_ENDPOINT="http://localhost:5096/api" #If developing in WSL and running the portal API on your host machine, use: http://$(hostname).local:5096/api
+ADP_PORTAL_TEMPLATE_VERSION=main
 
 GITHUB_APP_ID=""
 GITHUB_CLIENT_ID=""
@@ -61,6 +63,7 @@ AUTH_MICROSOFT_CLIENT_SECRET=""
 AUTH_MICROSOFT_TENANT_ID=""
 
 BACKSTAGE_BACKEND_SECRET=""
+BACKEND_PLUGINS_SECRET=""
 
 ADO_PAT=""
 ADO_ORGANIZATION=""
@@ -84,6 +87,28 @@ SND3_CLUSTER_NAME=""
 SND3_CLUSTER_API_SERVER_ADDRESS=""
 
 TZ=utc
+
+# Optional env variables, you might not need these.
+NODE_ENV=development
+NODE_OPTIONS=--no-node-snapshot
+NODE_TLS_REJECT_UNAUTHORIZED=0
+```
+
+To run the end to end tests, you will need to additionally set the following variables in your .env file. These are not needed for normal development.
+
+```sh
+E2E_TEST_ACCOUNTS_ADPTESTUSER1_EMAIL=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER1_PASSWORD=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER2_EMAIL=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER2_PASSWORD=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER3_EMAIL=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER3_PASSWORD=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER4_EMAIL=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER4_PASSWORD=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER5_EMAIL=""
+E2E_TEST_ACCOUNTS_ADPTESTUSER5_PASSWORD=""
+
+TEST_ENVIRONMENT_ROOT_URL=https://portal.snd1.adp.defra.gov.uk/
 ```
 
 To convert a GitHub private key into a format that can be used in the `GITHUB_PRIVATE_KEY` environment variable use one of the following scripts: