Feature toggle for authentication

Author: kartikpersistent

README.md

@@ -149,6 +149,9 @@ Allow unauthenticated request : Yes
 | VITE_GOOGLE_CLIENT_ID        | Optional           |               | Client ID for Google authentication                                                              |
 | VITE_LLM_MODELS_PROD         | Optional      | openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash | To Distinguish models based on the Enviornment PROD or DEV 
 | VITE_LLM_MODELS              | Optional | 'diffbot,openai_gpt_3.5,openai_gpt_4o,openai_gpt_4o_mini,gemini_1.5_pro,gemini_1.5_flash,azure_ai_gpt_35,azure_ai_gpt_4o,ollama_llama3,groq_llama3_70b,anthropic_claude_3_5_sonnet' | Supported Models For the application
+| VITE_AUTH0_CLIENT_ID | Mandatory if you are enabling Authentication otherwise it is optional |       |Okta Oauth Client ID for authentication
+| VITE_AUTH0_DOMAIN | Mandatory if you are enabling Authentication otherwise it is optional |           | Okta Oauth Cliend Domain
+| VITE_SKIP_AUTH | Optional | true | Flag to skip the authentication 
 
 ## LLMs Supported 
 1. OpenAI

docker-compose.yml

@@ -65,6 +65,7 @@ services:
         - VITE_LLM_MODELS_PROD=${VITE_LLM_MODELS_PROD-openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash}
         - VITE_AUTH0_DOMAIN=${VITE_AUTH0_DOMAIN-}
         - VITE_AUTH0_CLIENT_ID=${VITE_AUTH0_CLIENT_ID-}
+        - VITE_SKIP_AUTH=$VITE_SKIP_AUTH-true}
         - DEPLOYMENT_ENV=local
     volumes:
       - ./frontend:/app

frontend/Dockerfile

@@ -15,6 +15,7 @@ ARG VITE_BATCH_SIZE=2
 ARG VITE_LLM_MODELS_PROD="openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash"
 ARG VITE_AUTH0_CLIENT_ID=""
 ARG VITE_AUTH0_DOMAIN=""
+ARG VITE_SKIP_AUTH="false"
 
 WORKDIR /app
 COPY package.json yarn.lock ./
@@ -34,6 +35,7 @@ RUN VITE_BACKEND_API_URL=$VITE_BACKEND_API_URL \
     VITE_LLM_MODELS_PROD=$VITE_LLM_MODELS_PROD \
     VITE_AUTH0_CLIENT_ID=$VITE_AUTH0_CLIENT_ID \
     VITE_AUTH0_DOMAIN=$VITE_AUTH0_DOMAIN \
+    VITE_SKIP_AUTH=$VITE_SKIP_AUTH \
     yarn run build
 
 # Step 2: Serve the application using Nginx

frontend/example.env

@@ -13,4 +13,5 @@ VITE_LLM_MODELS_PROD="openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash"
 VITE_FRONTEND_HOSTNAME="localhost:8080"
 VITE_SEGMENT_API_URL=""
 VITE_AUTH0_CLIENT_ID=""
-VITE_AUTH0_DOMAIN=""
+VITE_AUTH0_DOMAIN=""
+VITE_SKIP_AUTH=true

frontend/src/App.tsx

@@ -2,10 +2,12 @@ import { Route, Routes } from 'react-router-dom';
 import ChatOnlyComponent from './components/ChatBot/ChatOnlyComponent';
 import { AuthenticationGuard } from './components/Auth/Auth';
 import Home from './Home';
+import { SKIP_AUTH } from './utils/Constants.ts';
+
 const App = () => {
   return (
     <Routes>
-      <Route path='/' element={<AuthenticationGuard component={Home} />}></Route>
+      <Route path='/' element={SKIP_AUTH ? <Home /> : <AuthenticationGuard component={Home} />}></Route>
       <Route path='/chat-only' element={<ChatOnlyComponent />}></Route>
     </Routes>
   );

frontend/src/components/Layout/Header.tsx

@@ -13,7 +13,7 @@ import {
 import { Button, TextLink, Typography } from '@neo4j-ndl/react';
 import { Dispatch, memo, SetStateAction, useCallback, useContext, useRef, useState } from 'react';
 import { IconButtonWithToolTip } from '../UI/IconButtonToolTip';
-import { buttonCaptions, tooltips } from '../../utils/Constants';
+import { buttonCaptions, SKIP_AUTH, tooltips } from '../../utils/Constants';
 import { ThemeWrapperContext } from '../../context/ThemeWrapper';
 import { useCredentials } from '../../context/UserCredentials';
 import { useNavigate } from 'react-router';
@@ -144,7 +144,7 @@ const Header: React.FC<HeaderProp> = ({ chatOnly, deleteOnClick, setOpenConnecti
                   >
                     <ArrowTopRightOnSquareIconOutline />
                   </IconButtonWithToolTip>
-                  <Profile />
+                  {!SKIP_AUTH && <Profile />}
                 </div>
               </div>
             </section>

frontend/src/main.tsx

@@ -4,13 +4,18 @@ import { BrowserRouter } from 'react-router-dom';
 import Auth0ProviderWithHistory from './components/Auth/Auth.tsx';
 import React from 'react';
 import App from './App.tsx';
+import { SKIP_AUTH } from './utils/Constants.ts';
 
 ReactDOM.createRoot(document.getElementById('root')!).render(
   <React.StrictMode>
     <BrowserRouter>
-      <Auth0ProviderWithHistory>
+      {SKIP_AUTH ? (
         <App />
-      </Auth0ProviderWithHistory>
+      ) : (
+        <Auth0ProviderWithHistory>
+          <App />
+        </Auth0ProviderWithHistory>
+      )}
     </BrowserRouter>
   </React.StrictMode>
 );

frontend/src/utils/Constants.ts

@@ -382,3 +382,4 @@ export const metricsinfo: Record<string, string> = {
   context_entity_recall: 'Determines the recall of entities present in both generated answer and retrieved contexts',
 };
 export const EXPIRATION_DAYS = 3;
+export const SKIP_AUTH = (process.env.VITE_SKIP_AUTH ?? 'true') == 'true';