From 726df1f8190dca2f9f8a89024eef31ac779307a1 Mon Sep 17 00:00:00 2001
From: Victor Jack <67293106+thedon-dev@users.noreply.github.com>
Date: Fri, 24 Jul 2026 14:13:41 +0100
Subject: [PATCH] docs: updated READMe for jobs env (#773)

* Udated READMe for jobs env

Added instructions to clone the .env.example in the jobs directory to your .env

* corrections to greptile comment

* Greptile code review

---------

Co-authored-by: Rotimi Best <best@classroomio.com>
---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 969ae653..90f79fb0 100644
--- a/README.md
+++ b/README.md
@@ -133,7 +133,7 @@ The repository also contains shared packages under `packages/` (for example `pac
 
 5. Set up your `.env` files:
 
-   Each app reads its **own** `.env`. In `apps/api` and `apps/dashboard`, duplicate
+   Each app reads its **own** `.env`. In `apps/api`, `apps/jobs` and `apps/dashboard`, duplicate
    `.env.example` to `.env` and fill the values below (host ports). The secret values are
    placeholders — **generate each one** with `openssl rand -hex 32` rather than copying
    the example text. The two `PRIVATE_SERVER_KEY` values **must match** — they
@@ -152,6 +152,16 @@ The repository also contains shared packages under `packages/` (for example `pac
      DASHBOARD_ORIGIN="http://localhost:5173"        # optional; used for invite/email links back to the dashboard
      ```
 
+   - `apps/jobs/.env`:
+      The jobs service handles background tasks (emails, media processing, analytics rollups, etc.).
+
+      **Recommended setup** (simplest):
+
+      ```bash
+      cd apps/jobs
+      ln -s ../../apps/api/.env .env  
+     ```
+
    - `apps/dashboard/.env`:
 
      ```bash