doc pr review iteration

This commit is contained in:
Igor Loskutov
2025-12-18 16:53:53 -05:00
parent 0939d2aef9
commit 96c5a1d1ea
14 changed files with 10 additions and 190 deletions

View File

@@ -34,7 +34,7 @@ Public mode provides immediate access to core transcription features without req
Private mode unlocks the full potential of Reflector with authentication and persistent storage.
### Additional Features
- **Virtual Meeting Rooms**: Whereby integration
- **Virtual Meeting Rooms**: Whereby and Daily.co integration
- **Team Collaboration**: Share transcripts with team
- **Persistent Storage**: Long-term transcript archive
- **Advanced Analytics**: Meeting insights and trends
@@ -99,10 +99,8 @@ REFLECTOR_AUTH_BACKEND=authentik
## Security Considerations
### Public Mode Security
- Rate limiting to prevent abuse
- File size restrictions
- Automatic cleanup of old data
- No PII storage
### Private Mode Security
- Encrypted data storage

View File

@@ -15,7 +15,7 @@ The user interface is built with **Next.js 14** using the App Router pattern, pr
- Server-side rendering for optimal performance
- Real-time WebSocket connections for live transcription
- WebRTC support for audio streaming
- WebRTC support for audio streaming and live meetings
- Responsive design with Chakra UI components
### Backend API Server

View File

@@ -36,7 +36,6 @@ Accepts various input sources:
Prepares audio for optimal processing:
- **Format Conversion**: Convert to 16kHz mono WAV
- **Normalization**: Adjust volume to -23 LUFS
- **Noise Reduction**: Optional background noise removal
- **Validation**: Check duration and quality
@@ -148,7 +147,6 @@ chunk_overlap_seconds: 1
# Quality settings
enable_noise_reduction: true
enable_normalization: true
min_speech_confidence: 0.5
# Post-processing

View File

@@ -176,8 +176,6 @@ Save these credentials - you'll need them in the next step.
## Configure Environment
**Location: YOUR SERVER (via SSH, in the `reflector` directory)**
Reflector has two env files:
- `server/.env` - Backend configuration
- `www/.env` - Frontend configuration
@@ -268,8 +266,6 @@ FEATURE_REQUIRE_LOGIN=false
## Configure Caddy
**Location: YOUR SERVER (via SSH)**
```bash
cp Caddyfile.example Caddyfile
nano Caddyfile
@@ -291,8 +287,6 @@ Replace `example.com` with your domains. The `{$VAR:default}` syntax uses Caddy'
## Start Services
**Location: YOUR SERVER (via SSH)**
```bash
docker compose -f docker-compose.prod.yml up -d
```
@@ -317,12 +311,6 @@ docker compose -f docker-compose.prod.yml ps
# All should show "Up"
```
### Check logs for errors
```bash
docker compose -f docker-compose.prod.yml logs server --tail 20
docker compose -f docker-compose.prod.yml logs worker --tail 20
```
### Test API
```bash
curl https://api.example.com/health
@@ -382,6 +370,12 @@ docker compose -f docker-compose.prod.yml up -d server worker
## Troubleshooting
### Check logs for errors
```bash
docker compose -f docker-compose.prod.yml logs server --tail 20
docker compose -f docker-compose.prod.yml logs worker --tail 20
```
### Services won't start
```bash
docker compose -f docker-compose.prod.yml logs
@@ -405,11 +399,3 @@ docker compose -f docker-compose.prod.yml logs
- Set `FEATURE_REQUIRE_LOGIN=false` in `www/.env`
- Rebuild frontend: `docker compose -f docker-compose.prod.yml up -d --force-recreate web`
---
## Next Steps
- [Modal Setup](./modal-setup) - Cloud GPU processing details
- [Self-Hosted GPU Setup](./self-hosted-gpu-setup) - Own GPU server deployment
- [Authentication Setup](./auth-setup) - Authentik OAuth
- [System Requirements](./requirements) - Hardware specs

View File

@@ -42,6 +42,7 @@ This page lists hardware and software requirements. For the complete deployment
- **Daily.co account** - For video conferencing (free tier available at https://dashboard.daily.co)
- **AWS S3 bucket + IAM Role** - For Daily.co to store recordings
- **Another AWS S3 bucket (optional, can reuse the one above)** - For Reflector to store "compiled" mp3 files and transient diarization process temporary files
### Optional

View File

@@ -27,7 +27,7 @@ The file processing pipeline handles uploaded audio files, optimizing for accura
### 2. Pre-processing
**Audio Normalization:**
```python
```yaml
# Convert to standard format
- Sample rate: 16kHz (Whisper requirement)
- Channels: Mono
@@ -35,11 +35,6 @@ The file processing pipeline handles uploaded audio files, optimizing for accura
- Format: WAV
```
**Volume Normalization:**
- Target: -23 LUFS (broadcast standard)
- Prevents clipping
- Improves transcription accuracy
**Noise Reduction (Optional):**
- Background noise removal
- Echo cancellation

View File

@@ -220,13 +220,6 @@ Modify room configuration and permissions.
- `429 Too Many Requests`: Rate limit exceeded
- `500 Internal Server Error`: Server error
## Rate Limiting
- **Anonymous users**: 100 requests per minute
- **Authenticated users**: 1000 requests per minute
- **WebSocket connections**: 10 concurrent per user
- **File uploads**: 10 per hour for anonymous, 100 per hour for authenticated
## WebSocket Protocol
The WebSocket connection provides real-time updates during transcription processing. The server sends structured messages to communicate different events and data updates.