docs: azure pubsub and zep

l3vels · Sep 19, 2023 · 1f8e609 · 1f8e609
1 parent f3f78e1
commit 1f8e609
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -145,21 +145,22 @@ L3AGI offers a robust set of functionalities that empower you to design, supervi
    cd L3AGI
    ```
 
-3. **Create `.env` file from `.env.example` in root directory**
+3. **Setup Git Hooks**
 
    ```bash
-   cp .env.example .env
+   chmod +x setup.sh
+   ./setup.sh
    ```
 
-   Configure `.env` file with your own values.
-
-4. **Setup Git Hooks**
+4. **Create `.env` file from `.env.example` in root directory**
 
    ```bash
-   chmod +x setup.sh
-   ./setup.sh
+   cp .env.example .env
    ```
 
+   - **Configure `Azure Web PubSub` using [our guide here](docs/azure.md)**
+   - **To configure `Zep Memory`, please see [quick start on Zep](https://docs.getzep.com/deployment/quickstart/)**
+
 5. 🐳 **Run Docker Compose:**
 
    ```bash

diff --git a/apps/server/.env.example b/apps/server/.env.example
@@ -9,7 +9,7 @@ DB_PORT=5432
 DB_USER=postgres
 DB_PASS=postgres
 
-# Azure pubsub used for chat
+# Azure pubsub used for chat. Quickstart: https://github.com/l3vels/L3AGI/blob/main/docs/azure.md
 AZURE_PUBSUB_CONNECTION_STRING=
 AZURE_PUBSUB_HUB_NAME=hub
 

diff --git a/docs/assets/azure/create-pubsub-1.png b/docs/assets/azure/create-pubsub-1.png
diff --git a/docs/assets/azure/create-pubsub-2.png b/docs/assets/azure/create-pubsub-2.png
diff --git a/docs/assets/azure/create-pubsub-3.png b/docs/assets/azure/create-pubsub-3.png
diff --git a/docs/assets/azure/create-pubsub-4.png b/docs/assets/azure/create-pubsub-4.png
diff --git a/docs/assets/azure/create-pubsub-5.png b/docs/assets/azure/create-pubsub-5.png
diff --git a/docs/assets/azure/create-pubsub-6.png b/docs/assets/azure/create-pubsub-6.png
diff --git a/docs/assets/azure/create-pubsub-7.png b/docs/assets/azure/create-pubsub-7.png
diff --git a/docs/azure.md b/docs/azure.md
@@ -0,0 +1,33 @@
+# Setup Azure Web PubSub Service from UI
+
+1. Create a free account on [Azure](https://azure.microsoft.com/en-us/free).
+
+2. Go to [Azure Portal](https://portal.azure.com/#home)
+
+3. Create Web PubSub Service on [Azure Portal](https://portal.azure.com/#create/Microsoft.AzureWebPubSub)
+   Choose first option:
+   ![Create PubSub](assets/azure/create-pubsub-1.png)
+
+4. Create a new resource group and choose name for your pubsub service:
+   ![Create new resource group](assets/azure/create-pubsub-2.png)
+
+5. Click `Review + create`
+
+6. Wait for validation and then click `Create`
+   ![Create resource](assets/azure/create-pubsub-3.png)
+
+7. After creating, you will be redirected. Click `Go to resource`:
+   ![Go to resource](assets/azure/create-pubsub-4.png)
+
+8. Go to `Keys` and copy `Connection string`:
+   ![Get connection string](assets/azure/create-pubsub-5.png)
+
+9. Paste `Connection string` in `.env` file.
+
+10. Go to `Settings` and create new `Hub`:
+    ![Create Hub](assets/azure/create-pubsub-6.png)
+    ![Save Hub](assets/azure/create-pubsub-7.png)
+
+11. Paste hub name in `.env` file.
+
+For more information visit: [Azure Web PubSub Service](https://docs.microsoft.com/en-us/azure/azure-web-pubsub/overview)