From 26c01b470fe6c7a8ecc281c78174575ba51f6685 Mon Sep 17 00:00:00 2001
From: Leander Furumo <leander@furumo.eu>
Date: Fri, 11 Oct 2024 16:22:18 +0200
Subject: [PATCH] add verification server setup guide

---
 verification_server/README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/verification_server/README.md b/verification_server/README.md
index 6c8be19..49a7030 100644
--- a/verification_server/README.md
+++ b/verification_server/README.md
@@ -4,4 +4,26 @@ A simple API whose purpose is to receive OAuth2 callbacks, verify them and enter
 
 # Setup
 
-TBA
+1. Make a copy of the `.env.example` file and rename it to `.env`
+
+2. Make sure all the fields are filled
+
+You have two options to run the API:
+
+### Option 1 - Docker (Recommended)
+
+```
+docker compose up
+```
+
+### Option 2 - Manual
+
+0. Install Python 3.12+
+
+1. Install dependencies
+
+```
+pip install -r requirements.txt -U
+```
+
+2. Run - See [this guide](https://fastapi.tiangolo.com/#create-it)