Skip to content

Commit 7e82a71

Browse files
committed
remove parts of the architecture docs
1 parent a217a4c commit 7e82a71

File tree

6 files changed

+11
-131
lines changed

6 files changed

+11
-131
lines changed

content/docs/architecture.mdx

Lines changed: 7 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -276,88 +276,17 @@ Riven supports multiple configuration methods:
276276
1. **Web Interface** (primary)
277277
- User-friendly settings UI
278278
- Real-time validation
279-
- Stored in PostgreSQL
279+
- Stored in settings file
280280

281281
2. **Environment Variables**
282282
- Prefix: `RIVEN_`
283283
- Format: `RIVEN_CATEGORY_SUBCATEGORY_SETTING`
284284
- Example: `RIVEN_FILESYSTEM_MOUNT_PATH=/mount`
285285

286-
3. **Settings File** (legacy)
286+
3. **Settings File**
287287
- JSON-based configuration
288-
- Used as fallback
289288

290-
Priority: Environment Variables > Database Settings > Defaults
291-
292-
---
293-
294-
## Scaling & Performance
295-
296-
### Multi-User Support
297-
- RivenVFS includes fair scheduling for concurrent streams
298-
- Each user gets proportional bandwidth allocation
299-
- No single stream monopolizes resources
300-
301-
### Caching Strategy
302-
- **Hot Cache**: Frequently accessed chunks stay in cache (LRU)
303-
- **Prefetch**: Read-ahead prevents buffering
304-
- **Eviction**: Automatic cleanup when cache fills
305-
306-
### Database Optimization
307-
- Indexed queries for fast lookups
308-
- Lazy loading of relationships
309-
- Periodic cleanup of old data
310-
311-
### Resource Usage
312-
- **CPU**: Low (except during scraping)
313-
- **Memory**: Moderate (depends on cache size)
314-
- **Disk I/O**: Low (VFS streams, minimal writes)
315-
- **Network**: Variable (depends on streaming activity)
316-
317-
---
318-
319-
## Security Considerations
320-
321-
1. **API Authentication**
322-
- API key required for all requests
323-
- 32-character secure keys
324-
325-
2. **Container Isolation**
326-
- FUSE runs in container with limited permissions
327-
- No host filesystem access except mount point
328-
329-
3. **Debrid Service Keys**
330-
- Stored encrypted in database
331-
- Never exposed in logs or API responses
332-
333-
4. **Network Security**
334-
- HTTPS recommended for reverse proxy
335-
- CORS protection enabled
336-
337-
---
338-
339-
## Deployment Patterns
340-
341-
### Single-User Home Setup
342-
```
343-
[User] → [Reverse Proxy] → [Riven Frontend] → [Riven Backend + VFS]
344-
345-
[Media Server]
346-
```
347-
348-
### Multi-User Shared Setup
349-
```
350-
[User 1] ┐
351-
[User 2] ├→ [Reverse Proxy] → [Riven] → [Shared Media Server]
352-
[User 3] ┘
353-
```
354-
355-
### ElfHosted (Cloud)
356-
```
357-
[User] → [ElfHosted Infrastructure] → [Riven + Media Server]
358-
359-
[Shared Debrid Pool]
360-
```
289+
Priority: Environment Variables > Settings File > Defaults
361290

362291
---
363292

@@ -372,10 +301,10 @@ Priority: Environment Variables > Database Settings > Defaults
372301
- **Async**: asyncio, trio (for FUSE)
373302

374303
### Frontend
375-
- **Framework**: Next.js 15
304+
- **Framework**: Svelte 5
376305
- **Language**: TypeScript
377-
- **UI Library**: Fumadocs UI
378-
- **State Management**: React hooks
306+
- **UI Library**: Shadcn/UI
307+
- **State Management**: Svelte stores
379308

380309
### Build & Deploy
381310
- **Backend**: Docker multi-stage builds
@@ -402,12 +331,4 @@ Priority: Environment Variables > Database Settings > Defaults
402331
- Database connectivity
403332
- VFS mount status
404333
- Debrid service availability
405-
- Media server connectivity
406-
407-
---
408-
409-
## See Also
410-
411-
- [Filesystem (VFS)](/docs/services/filesystem) - Detailed VFS documentation
412-
- [Services](/docs/services) - Service configuration guides
413-
- [Troubleshooting](/docs/troubleshooting) - Common issues and solutions
334+
- Media server connectivity

content/docs/deployment.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -612,13 +612,4 @@ See the main [Troubleshooting Guide](/docs/troubleshooting) for detailed solutio
612612
- FUSE not available → Install fuse3, load kernel module
613613
- Mount propagation → Follow host mount setup above
614614
- Database connection → Check credentials, network
615-
- API key errors → Generate proper 32-character key
616-
617-
---
618-
619-
## See Also
620-
621-
- [Filesystem (VFS)](/docs/services/filesystem) - VFS configuration
622-
- [Troubleshooting](/docs/troubleshooting) - Common issues
623-
- [Architecture](/docs/architecture) - How it all works
624-
- [Performance Tuning](/docs/services/filesystem/performance) - Optimize your setup
615+
- API key errors → Generate proper 32-character key

content/docs/services/filesystem/index.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -379,12 +379,4 @@ This means multiple users can stream different content simultaneously without on
379379
| **Setup Complexity** | High (systemd, rclone config) | Low (built-in) |
380380
| **Prefetching** | Basic | Advanced with fair scheduling |
381381
| **Repair Needed** | Yes (broken symlinks) | No |
382-
| **HTTP/2 Support** | Depends on rclone version | Native support |
383-
384-
---
385-
386-
## See Also
387-
388-
- [Troubleshooting Guide](/docs/troubleshooting) - Common issues and solutions
389-
- [Performance Tuning](/docs/services/filesystem/performance) - Optimize VFS for your setup
390-
- [Updaters](/docs/services/updaters) - Configure media server integrations
382+
| **HTTP/2 Support** | Depends on rclone version | Native support |

content/docs/services/filesystem/performance.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -550,12 +550,4 @@ fetch_ahead_chunks = 2
550550
**Solutions**:
551551
1. Decrease `cache_max_size_mb`
552552
2. Switch to disk cache
553-
3. Update Riven to latest version
554-
555-
---
556-
557-
## See Also
558-
559-
- [Filesystem (VFS)](/docs/services/filesystem) - VFS configuration reference
560-
- [Troubleshooting](/docs/troubleshooting) - Common issues
561-
- [Architecture](/docs/architecture) - How VFS works internally
553+
3. Update Riven to latest version

content/docs/services/post-processing/index.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,3 @@ Potential future post-processing features:
222222
<Callout type="info">
223223
These are potential features, not currently available. Check the [GitHub roadmap](https://github.com/rivenmedia/riven/issues) for updates.
224224
</Callout>
225-
226-
---
227-
228-
## See Also
229-
230-
- [Architecture](/docs/architecture) - Understanding the workflow
231-
- [Troubleshooting](/docs/troubleshooting) - Common issues
232-
- [Filesystem (VFS)](/docs/services/filesystem) - Where media files end up

content/docs/troubleshooting.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -524,12 +524,4 @@ If none of these solutions work:
524524
- Docker/OS version
525525
- Full logs (use pastebin)
526526
- Configuration (remove API keys!)
527-
- Steps to reproduce
528-
529-
---
530-
531-
## See Also
532-
533-
- [Filesystem (VFS)](/docs/services/filesystem) - VFS configuration and troubleshooting
534-
- [Architecture](/docs/architecture) - Understanding how Riven works
535-
- [Performance Tuning](/docs/services/filesystem/performance) - Optimize your setup
527+
- Steps to reproduce

0 commit comments

Comments
 (0)