From cd1cedad693c036c2d8dd083cfa995e64e1017d5 Mon Sep 17 00:00:00 2001 From: Beverly Nguyen Date: Mon, 5 Aug 2024 12:09:38 -0700 Subject: [PATCH 1/2] add debug staging api to docs --- docs/debug-issues-with-staging-api.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/debug-issues-with-staging-api.md diff --git a/docs/debug-issues-with-staging-api.md b/docs/debug-issues-with-staging-api.md new file mode 100644 index 000000000..e80a2ac32 --- /dev/null +++ b/docs/debug-issues-with-staging-api.md @@ -0,0 +1,26 @@ +### Setting Up Environment Variables for Local Development to the Staging API + +When you’re working locally, you can point your local admin repo to the staging API and use that to help debug +issues with the staging data set. To do this, you’ll need to modify your .env file for the admin project and +include the following new environment variables: + +- `ADMIN_CLIENT_SECRET` +- `ADMIN_CLIENT_USERNAME` +- `DANGEROUS_SALT` +- `SECRET_KEY` + +Additionally, update `API_HOST_NAME` and `NOTIFY_ENVIRONMENT`: + +1. Change `API_HOST_NAME` to `API_HOST_NAME=https://notify-api-staging.app.cloud.gov` +2. Change `NOTIFY_ENVIRONMENT` to `NOTIFY_ENVIRONMENT=staging` + +### Retrieving Environment Variables for Staging + +You can retrieve the values needed for these by using the cf CLI (Cloud Foundry CLI tool) and making sure +you’re targeting the notify-staging space. + +1. `cf login -a [api.fr.cloud.gov](http://api.fr.cloud.gov/) --sso` +2. select `notify-staging` +3. `cf env notify-admin-staging` + +By pointing your local environment to staging, it should mirror what's in staging. From 21da7ef7db724c597067d3fd81779734a356b85d Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Thu, 8 Aug 2024 13:49:49 -0400 Subject: [PATCH 2/2] Update docs/debug-issues-with-staging-api.md Some additional formatting. --- docs/debug-issues-with-staging-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/debug-issues-with-staging-api.md b/docs/debug-issues-with-staging-api.md index e80a2ac32..517eab4d9 100644 --- a/docs/debug-issues-with-staging-api.md +++ b/docs/debug-issues-with-staging-api.md @@ -16,8 +16,8 @@ Additionally, update `API_HOST_NAME` and `NOTIFY_ENVIRONMENT`: ### Retrieving Environment Variables for Staging -You can retrieve the values needed for these by using the cf CLI (Cloud Foundry CLI tool) and making sure -you’re targeting the notify-staging space. +You can retrieve the values needed for these by using the `cf` CLI (Cloud Foundry CLI tool) and making sure +you’re targeting the `notify-staging` space. 1. `cf login -a [api.fr.cloud.gov](http://api.fr.cloud.gov/) --sso` 2. select `notify-staging`