Merge pull request #1083 from clearlydefined/update-required-env-docs

Add now-required env vars to docs and minimal.env.json
clearlydefined · Apr 4, 2024 · cfcd81e · cfcd81e
2 parents 89555eb + 3b9f973
commit cfcd81e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/rampup.md b/docs/rampup.md
@@ -45,6 +45,8 @@ Better to use a copy of the real dev environment, can change queue names to be y
    - "CURATION_GITHUB_REPO"
    - "CURATION_GITHUB_TOKEN"
    - "CRAWLER_GITHUB_TOKEN"
+   - "WEBHOOK_GITHUB_SECRET"
+   - "WEBHOOK_CRAWLER_SECRET"
    - "SCANCODE_HOME"
 5. Any other environmental variable values you might need can be found in the Clearly Defined subscription in Azure Portal under App Services -> clearlydefined-api-dev -> Settings -> Configuration
 6. Consider all the vars and what you need for testing what you will test.

diff --git a/minimal.env.json b/minimal.env.json
@@ -2,6 +2,10 @@
   "========== Service Harvest settings ==========": "",
   "FILE_STORE_LOCATION": "< path to cloned harvested-data repo, other local store location, or omit for default >",
 
+  "========== Service Webhooks settings ==========": "",
+  "WEBHOOK_CRAWLER_SECRET": "<crawler webhook secret here>",
+  "WEBHOOK_GITHUB_SECRET": "<GitHub webhook secret here>",
+
   "========== Service Curation settings ==========": "",
   "CURATION_GITHUB_REPO": "sample-curated-data",
   "CURATION_GITHUB_TOKEN": "<GitHub token here>"