From f78d76299914ce539c91b9ff3f1acd8dac8dbb00 Mon Sep 17 00:00:00 2001
From: Ben Grant <benjamin.grantGRA0007@gmail.com>
Date: Tue, 16 May 2023 02:42:01 +1000
Subject: [PATCH] Add docs for FRONTEND_URL env var

---
 .gitignore                   | 1 -
 README.md                    | 4 ++++
 api/README.md                | 8 +++++++-
 browser-extension/.gitignore | 1 +
 4 files changed, 12 insertions(+), 2 deletions(-)
 create mode 100644 browser-extension/.gitignore

diff --git a/.gitignore b/.gitignore
index f11e864..cfc9619 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,2 @@
 /graphics
 .DS_Store
-/browser-extension/*.zip
diff --git a/README.md b/README.md
index e59204f..8ba0b35 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,10 @@ If you find any bugs or have a feature request, please create an issue by <a hre
 
 If you speak a language other than English and you want to help translate Crab Fit, fill out this form: https://forms.gle/azz1yGqhpLUka45S9
 
+### Pull requests
+
+If you see an issue you want to fix, or want to implement a feature you think would be useful, please feel free to open a pull request with your changes. If you can, please open an issue about the bug or feature you want to work on before starting your PR, to prevent work duplication and give others a chance to improve your idea.
+
 ## Setup
 
 1. Clone the repo and ensure you have `node`, `yarn` and `rust` installed on your machine.
diff --git a/api/README.md b/api/README.md
index 4ae479f..79d2d61 100644
--- a/api/README.md
+++ b/api/README.md
@@ -25,6 +25,12 @@ Some adaptors require environment variables to be set. You can specify them in a
 
 See [adding an adaptor](adaptors/README.md#adding-an-adaptor) in the adaptors readme.
 
-## Cleanup task
+## Environment
+
+### CORS
+
+In release mode, a `FRONTEND_URL` environment variable is required to correctly restrict cross-origin requests to the frontend.
+
+### Cleanup task
 
 By default, anyone can run the cleanup task at `/tasks/cleanup`. This is usually not an issue, as it's based on when the events were last visited, and not when it's run, but if you'd prefer to restrict runs of the cleanup task (as it can be intensive), set a `CRON_KEY` environment variable in `.env`. This will require sending an `X-Cron-Key` header to the route with a value that matches `CRON_KEY`, or the route will return a 401 Unauthorized error.
diff --git a/browser-extension/.gitignore b/browser-extension/.gitignore
new file mode 100644
index 0000000..c4c4ffc
--- /dev/null
+++ b/browser-extension/.gitignore
@@ -0,0 +1 @@
+*.zip