@@ -50,10 +50,25 @@ AkashChat leverages the decentralized cloud infrastructure of Akash Network, off
5050
5151## Getting Started
5252
53+ ### Minimal Setup
54+
55+ AkashChat can run with just an API key! The minimal configuration requires:
56+
57+ - Node.js (v18 or higher)
58+ - ` API_KEY ` environment variable
59+
60+ Redis, Auth0, Database, and other features are ** optional** and only needed for:
61+ - ** Redis** : Session management and caching (without it, uses simple cookie-based sessions)
62+ - ** Auth0 + Database** : Multi-user accounts with persistent chat history
63+ - ** Access Token** : Frontend access control for private instances
64+
5365### Prerequisites
5466
67+ For the full-featured setup:
68+
5569- Node.js (v18 or higher)
56- - Redis server (for caching and session management)
70+ - Redis server (optional, for session management and caching)
71+ - PostgreSQL database (optional, for multi-user support with Auth0)
5772- API keys/endpoints for the AI models you want to use
5873
5974### Installation
@@ -69,9 +84,17 @@ AkashChat leverages the decentralized cloud infrastructure of Akash Network, off
6984 npm install
7085 ```
7186
72- 3 . Create a ` .env.local ` file in the root directory with the following variables:
87+ 3 . Create a ` .env.local ` file in the root directory.
88+
89+ ** Minimal configuration** (only required variables):
90+ ``` env
91+ # API Configuration - REQUIRED
92+ API_KEY=your_api_key_here
93+ ```
94+
95+ ** Full configuration** (all available options):
7396 ``` env
74- # API Configuration
97+ # API Configuration - REQUIRED
7598 API_KEY=your_api_key_here
7699 API_ENDPOINT=your_api_endpoint_here
77100 DEFAULT_MODEL=your_default_model_here
@@ -118,23 +141,23 @@ AkashChat leverages the decentralized cloud infrastructure of Akash Network, off
118141
119142| Variable | Description | Required | Default |
120143| ----------| -------------| ----------| ---------|
121- | API_KEY | Authentication key for Akash AI API access | Yes | - |
122- | API_ENDPOINT | Base URL for Akash AI API | Yes | https://chatapi.akash.network/api /v1 |
144+ | ** API_KEY** | ** Authentication key for Akash AI API access** | ** Yes** | ** - ** |
145+ | API_ENDPOINT | Base URL for Akash AI API | No | https://api.akashml.com /v1 |
123146| DEFAULT_MODEL | Default AI model to use | No | Qwen-QwQ-32B |
124- | REDIS_URL | Connection URL for Redis | Yes | redis://localhost:6379 |
125- | CACHE_TTL | Cache time-to-live in seconds | No | 600 (10 minutes) |
126- | ACCESS_TOKEN | Token for API and frontend protection | No | - |
147+ | REDIS_URL | Connection URL for Redis (for session management) | No | - |
148+ | CACHE_TTL | Cache/session time-to-live in seconds | No | 600 (10 minutes) |
149+ | ACCESS_TOKEN | Token for API and frontend protection (SHA-256 hashed automatically) | No | - |
127150| WS_TRANSCRIPTION_URLS | Comma-separated WebSocket URLs for voice transcription | No | - |
128151| WS_TRANSCRIPTION_MODEL | Model for voice transcription | No | mobiuslabsgmbh/faster-whisper-large-v3-turbo |
129152| IMG_API_KEY | Authentication key for AkashGen image generation | No | - |
130153| IMG_ENDPOINT | Endpoint for AkashGen image generation | No | - |
131154| IMG_GEN_FN_MODEL | Model for AkashGen image generation | No | - |
132- | AUTH0_SECRET | Auth0 session secret for user authentication | No | - |
155+ | AUTH0_SECRET | Auth0 session secret (required for multi- user mode) | No | - |
133156| AUTH0_BASE_URL | Base URL for Auth0 configuration | No | - |
134157| AUTH0_ISSUER_BASE_URL | Auth0 issuer base URL | No | - |
135158| AUTH0_CLIENT_ID | Auth0 application client ID | No | - |
136159| AUTH0_CLIENT_SECRET | Auth0 application client secret | No | - |
137- | DATABASE_URL | PostgreSQL connection URL for data persistence | Yes | - |
160+ | DATABASE_URL | PostgreSQL connection URL (required for multi-user mode) | No | - |
138161| LITELLM_BASE_URL | LiteLLM proxy base URL | No | - |
139162| LITELLM_API_KEY | LiteLLM proxy API key | No | - |
140163
0 commit comments