Updating documentation

.env.example

@@ -1,6 +1,7 @@
 # Change the name of this file to .env after updating it!
 
 ############
+# [required] 
 # n8n credentials - you set this to whatever you want, just make it a long and secure string for both!
 ############
 
@@ -9,8 +10,14 @@ N8N_USER_MANAGEMENT_JWT_SECRET=even-more-secret
 
 
 ############
+# [required] 
 # Supabase Secrets
+
 # YOU MUST CHANGE THESE BEFORE GOING INTO PRODUCTION
+# Read these docs for any help: https://supabase.com/docs/guides/self-hosting/docker
+# For the JWT Secret and keys, see: https://supabase.com/docs/guides/self-hosting/docker#generate-api-keys
+# For the other secrets, see: https://supabase.com/docs/guides/self-hosting/docker#update-secrets
+# You can really decide any value for POOLER_TENANT_ID like 1000.
 ############
 
 POSTGRES_PASSWORD=your-super-secret-and-long-postgres-password
@@ -22,8 +29,8 @@ DASHBOARD_PASSWORD=this_password_is_insecure_and_should_be_updated
 POOLER_TENANT_ID=your-tenant-id
 
 ############
+# [required for prod] 
 # Caddy Config
-############
 
 # By default listen on https://localhost:[service port] and don't use an email for SSL
 # To change this for production:
@@ -31,6 +38,7 @@ POOLER_TENANT_ID=your-tenant-id
 # Note that you might not want to expose Ollama or SearXNG since they aren't secured by default
 # Replace the placeholder value with the host for each service (like n8n.yourdomain.com)
 # Replace internal by your email (require to create a Let's Encrypt certificate)
+############
 
 # N8N_HOSTNAME=n8n.yourdomain.com
 # WEBUI_HOSTNAME=:openwebui.yourdomain.com
@@ -40,6 +48,17 @@ POOLER_TENANT_ID=your-tenant-id
 # SEARXNG_HOSTNAME=searxng.yourdomain.com
 # LETSENCRYPT_EMAIL=internal
 
+
+
+# Everything below this point is optional.
+# Default values will suffice unless you need more features/customization.
+
+   #
+   #
+#######
+ #####
+   #
+
 ############
 # Optional SearXNG Config
 # If you run a very small or a very large instance, you might want to change the amount of used uwsgi workers and threads per worker

README.md

@@ -4,7 +4,7 @@
 quickly bootstraps a fully featured Local AI and Low Code development
 environment including Ollama for your local LLMs, Open WebUI for an interface to chat with your N8N agents, and Supabase for your database, vector store, and authentication. 
 
-This is Cole's version with a couple of improvements and the addition of Supabase, Open WebUI, and Flowise!
+This is Cole's version with a couple of improvements and the addition of Supabase, Open WebUI, Flowise, SearXNG, and Caddy!
 Postgres was also removed since Supabase runs Postgres under the hood.
 Also, the local RAG AI Agent workflow from the video will be automatically in your 
 n8n instance if you use this setup instead of the base one provided by n8n!
@@ -46,6 +46,11 @@ builder that pairs very well with n8n
 store with an comprehensive API. Even though you can use Supabase for RAG, this was
 kept unlike Postgres since it's faster than Supabase so sometimes is the better option.
 
+✅ [**SearXNG**](https://searxng.org/) - Open-source, free internet metasearch engine which aggregates 
+results from up to 229 search services. Users are neither tracked nor profiled, hence the fit with the local AI package.
+
+✅ [**Caddy**](https://caddyserver.com/) - Managed HTTPS/TLS for custom domains
+
 ## Prerequisites
 
 Before you begin, make sure you have the following software installed:
@@ -82,16 +87,26 @@ Before running the services, you need to set up your environment variables for S
    SERVICE_ROLE_KEY=
    DASHBOARD_USERNAME=
    DASHBOARD_PASSWORD=
-
-   ############
-   # Supavisor -- Database pooler
-   ############
    POOLER_TENANT_ID=
    ```
 
-   > [!IMPORTANT]
-   > Make sure to generate secure random values for all secrets. Never use the example values in production.
+> [!IMPORTANT]
+> Make sure to generate secure random values for all secrets. Never use the example values in production.
 
+3. Set the following environment variables if deploying to production, otherwise leave commented:
+   ```bash
+   ############
+   # Caddy Config
+   ############
+
+   N8N_HOSTNAME=n8n.yourdomain.com
+   WEBUI_HOSTNAME=:openwebui.yourdomain.com
+   FLOWISE_HOSTNAME=:flowise.yourdomain.com
+   SUPABASE_HOSTNAME=:supabase.yourdomain.com
+   OLLAMA_HOSTNAME=:ollama.yourdomain.com
+   SEARXNG_HOSTNAME=searxng.yourdomain.com
+   LETSENCRYPT_EMAIL=your-email-address
+   ```   
 
 ---
 
@@ -266,7 +281,7 @@ and nodes. If you run into an issue, go to [support](#support).
 
 ## 🎥 Video walkthrough
 
-- [Cole's Guide to the Local AI Starter Kit](https://youtu.be/V_0dNE-H2gw)
+- [Cole's Guide to the Local AI Starter Kit](https://youtu.be/pOsO40HSbOo)
 
 ## 🛍️ More AI templates