update docs
This commit is contained in:
25
README.md
25
README.md
@@ -9,6 +9,7 @@
|
||||
### Prerequisites
|
||||
- Docker and Docker Compose installed
|
||||
- API key from [Anthropic](https://console.anthropic.com/) or [OpenAI](https://platform.openai.com/api-keys)
|
||||
- Microsoft Entra ID app registration (for authentication)
|
||||
|
||||
### Setup
|
||||
|
||||
@@ -21,15 +22,22 @@ cd devden
|
||||
2. **Configure environment variables**
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# Edit .env and add your API keys
|
||||
# Edit .env and add your API keys and Entra ID credentials
|
||||
```
|
||||
|
||||
3. **Start the services**
|
||||
3. **Set up Microsoft Entra ID** (Azure AD)
|
||||
- Go to [Azure Portal - App Registrations](https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps)
|
||||
- Create a new app registration
|
||||
- Add redirect URI: `http://localhost:3000/auth/callback`
|
||||
- Generate a client secret under "Certificates & secrets"
|
||||
- Copy Tenant ID, Client ID, and Client Secret to your `.env` file
|
||||
|
||||
4. **Start the services**
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
4. **Access DevDen**
|
||||
5. **Access DevDen**
|
||||
- Frontend: http://localhost:3000
|
||||
- Backend API: http://localhost:8000
|
||||
- Health Check: http://localhost:8000/health
|
||||
@@ -37,10 +45,19 @@ docker compose up -d --build
|
||||
### Environment Variables
|
||||
|
||||
Required variables in `.env`:
|
||||
```
|
||||
```bash
|
||||
# AI Providers (at least one required)
|
||||
ANTHROPIC_API_KEY=your_key_here # For Claude
|
||||
OPENAI_API_KEY=your_key_here # For OpenAI
|
||||
DEFAULT_PROVIDER=claude # claude or openai
|
||||
|
||||
# Microsoft Entra ID (required for authentication)
|
||||
ENTRA_TENANT_ID=your-tenant-id
|
||||
ENTRA_CLIENT_ID=your-client-id
|
||||
ENTRA_CLIENT_SECRET=your-client-secret
|
||||
|
||||
# JWT (change in production)
|
||||
JWT_SECRET=generate-a-secure-random-string
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user