chore: Update README and add Mintlify docs

* Update README and add Mintlify docs

* Add Twilio documentation

* Remove license and fix readme
This commit is contained in:
Abhishek 2025-10-04 15:05:07 +05:30 committed by GitHub
parent 90f7aac8ad
commit 1f4ff8f865
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 267 additions and 60 deletions

View file

@ -0,0 +1,26 @@
---
title: "Introduction"
description: "Welcome to Dograh AI documentation"
---
## Setting up
Get the stack up and running using Docker with a single command.
<Note>We collect anonymous usage data to improve the product. You can opt out by setting the `ENABLE_TELEMETRY` to `false` in the below command.</Note>
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml && REGISTRY=ghcr.io/dograh-hq ENABLE_TELEMETRY=true docker compose up
```
Please check [Prerequisites](getting-started/prerequisites) for the system requirements and [Troubleshooting](getting-started/troubleshooting) for common issues.
You can also watch below video to see the setup in action.
<iframe
className="w-full aspect-video rounded-xl"
src="https://www.tella.tv/video/cmgbysbsz00kw0bjm2qnc5f1d/embed?b=1&title=1&a=1&loop=0&t=0&muted=0&wt=1"
title="Dogrh Getting Started"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>

View file

@ -0,0 +1,85 @@
---
title: "Prerequisites"
description: "System requirements and setup needed to run Dograh AI"
---
## System Requirements
### 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:
```bash
# Using GitHub Container Registry (recommended)
REGISTRY=ghcr.io/dograh-hq docker compose up
# Using Docker Hub
REGISTRY=dograhai docker compose up
```

View file

@ -0,0 +1,50 @@
---
title: "Troubleshooting"
description: "Common issues and solutions for running Dograh AI"
---
# Troubleshooting
## Freeing Up Ports
### When a port is already in use:
##### Check what's using the port first and then kill the process (may require sudo on Linux)
```bash
lsof -i :3010
kill -9 $(lsof -t -i :3010)
```
### When Docker containers are using the ports (with auto-restart enabled):
**Step 1:** Stop all running containers
```bash
docker stop $(docker ps -q)
```
**Step 2:** Disable restart policy for all containers
This prevents containers from automatically restarting:
```bash
docker update --restart=no $(docker ps -a -q)
```
**Step 3:** Verify
Check that no containers are running:
```bash
docker ps
```
Check restart policies (should show 'no' for each container):
```bash
docker inspect -f '{{.Name}} - {{.HostConfig.RestartPolicy.Name}}' $(docker ps -a -q)
```
## Stopping Dograh Services
##### Stop services or Stop and remove all data (full cleanup)
```bash
docker compose down
docker compose down -v
```