mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-10 08:05:22 +02:00
bdf43df307
Adds a start docker script so that we have required values like OSS_JWT_SECRET at runtime
96 lines
2.2 KiB
Text
96 lines
2.2 KiB
Text
---
|
|
title: "Prerequisites"
|
|
description: "System requirements and setup needed to run Dograh AI locally"
|
|
---
|
|
|
|
## System Requirements (Local Setup)
|
|
|
|
### Minimum Requirements
|
|
- **RAM**: 8 GB (4 GB available for Docker)
|
|
- **Storage**: 10 GB free disk space
|
|
- **CPU**: 2 cores (x86_64 or ARM64)
|
|
- **OS**:
|
|
- macOS 10.15+ (Catalina or newer)
|
|
- Windows 10/11 with WSL2
|
|
- Linux with kernel 3.10+
|
|
|
|
## Software Requirements
|
|
|
|
To run Dograh AI locally, make sure you have the following installed:
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/) (version 20.10 or later)
|
|
- [curl](https://curl.se/download.html) - usually preinstalled on macOS/Linux
|
|
|
|
<Note>
|
|
Docker Compose is included with Docker Desktop. Make sure Docker is running before you begin.
|
|
</Note>
|
|
|
|
### Docker Resource Allocation
|
|
|
|
For Docker Desktop users, ensure Docker has adequate resources:
|
|
|
|
1. Open Docker Desktop settings
|
|
2. Navigate to Resources
|
|
3. Allocate at least:
|
|
- Memory: 4 GB (8 GB recommended)
|
|
- CPUs: 2 (4 recommended)
|
|
- Disk: 10 GB
|
|
|
|
## Required Ports
|
|
|
|
Ensure these ports are available:
|
|
|
|
- `3010` - Web UI
|
|
- `8000` - API Server
|
|
- `5432` - PostgreSQL
|
|
- `6379` - Redis
|
|
- `9000` - MinIO (S3-compatible storage)
|
|
- `9001` - MinIO Console
|
|
|
|
## Checking Port Availability
|
|
|
|
Check if a port is in use (replace 3010 with the port number):
|
|
|
|
<CodeGroup>
|
|
|
|
```bash macOS/Linux
|
|
lsof -i :3010
|
|
```
|
|
|
|
```bash Linux (alternative)
|
|
netstat -tulpn | grep 3010
|
|
```
|
|
|
|
```bash Windows (PowerShell)
|
|
netstat -ano | findstr :3010
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Docker Registry Options
|
|
|
|
Dograh images are available from two registries:
|
|
|
|
- **GitHub Container Registry (Default)**: `ghcr.io/dograh-hq` - Recommended for most users
|
|
- **Docker Hub**: `dograhai` - Alternative registry
|
|
|
|
To use a specific registry, set the `REGISTRY` environment variable when running the startup script:
|
|
|
|
<CodeGroup>
|
|
```bash
|
|
# Using GitHub Container Registry (recommended)
|
|
REGISTRY=ghcr.io/dograh-hq ./start_docker.sh
|
|
|
|
# Using Docker Hub
|
|
REGISTRY=dograhai ./start_docker.sh
|
|
```
|
|
```powershell Windows
|
|
# Using GitHub Container Registry (recommended)
|
|
$env:REGISTRY = 'ghcr.io/dograh-hq'
|
|
.\start_docker.ps1
|
|
|
|
# Using Docker Hub
|
|
$env:REGISTRY = 'dograhai'
|
|
.\start_docker.ps1
|
|
```
|
|
</CodeGroup>
|