Merge pull request #99 from ant-xuexiao/chore/update-self-hosted-docs

Chore/update self hosted docs

.env.example

@@ -0,0 +1,14 @@
+# Supabase Configures
+SUPABASE_URL=supabase_url
+SUPABASE_SERVICE_KEY=supabase_service_key
+
+# OPTIONAL - Github Apps Configures
+X_GITHUB_APP_ID=github_app_id
+X_GITHUB_APPS_CLIENT_ID=github_apps_client_id
+X_GITHUB_APPS_CLIENT_SECRET=github_apps_client_secret
+
+# OpenAI API KEY
+OPENAI_API_KEY=openapi_api_key
+
+# Tavily Api Key
+TAVILY_API_KEY=tavily_api_key

docs/guides/self_hosting_docker.md

@@ -4,24 +4,46 @@ Docker is the easiest way to get started with self-hosted Petercat. This guide a
 
 ## Before you begin
 
-You need the following installed in your system: [Git](https://git-scm.com/downloads) and Docker ([Windows](https://docs.docker.com/desktop/install/windows-install/), [MacOS](https://docs.docker.com/desktop/install/mac-install/), or [Linux](https://docs.docker.com/desktop/install/linux-install/)).
+You need the following installed in your system: 
+- [Git](https://git-scm.com/downloads)
+- Docker ([Windows](https://docs.docker.com/desktop/install/windows-install/), [MacOS](https://docs.docker.com/desktop/install/mac-install/), or [Linux](https://docs.docker.com/desktop/install/linux-install/)).
+
 
 ## Running Petercat
 
 Follow these steps to start Supabase locally:
 
 
-```sh
-# Get the code
-git clone --depth 1 https://github.com/ant-xuexiao/bot-meta
+- **Step 0**: Clone the repository:
+
+  ```bash
+  git clone https://github.com/ant-xuexiao/bot-meta && cd quivr
+  ```
+
+- **Step 1**: Copy the `.env.example` files
+
+  ```bash
+  cp .env.example .env
+  ```
+
+- **Step 2**: Update the `.env` files
+
+  ```bash
+  vim .env # or emacs or vscode or nano
+  ```
+  Update services keys in the `.env` file.
+
+  ***OPENAI***:
+
+  You need to update the `OPENAI_API_KEY` variable in the `.env` file. You can get your API key [here](https://platform.openai.com/api-keys). You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing [here](https://openai.com/pricing/).
+
+  ***SUPABASE***:
 
-# Copy the fake env vars
-cp .env.example .env
+  You need to update the `SUPABASE_URL` and `SUPABASE_SERVICE_KEY` variable in the `.env` file. You can get your help from [here](https://supabase.com/docs/guides/database/connecting-to-postgres#finding-your-database-hostname). You need to create a supabase account first. 
 
-# Pull the latest images
-docker compose pull
 
-# Start the services (in detached mode)
-docker compose --env-file .env -f docker/docker-compose.yml up
-```
+- **Step 4**: Launch the project
 
+  ```bash
+  docker compose --env-file .env -f docker/docker-compose.yml up
+  ```