mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-16 08:25:18 +02:00
feat: add a start docker script (#426)
Adds a start docker script so that we have required values like OSS_JWT_SECRET at runtime
This commit is contained in:
parent
a81cccc68b
commit
97d7103480
7 changed files with 258 additions and 20 deletions
|
|
@ -20,18 +20,27 @@ Watch the video tutorial below for a step-by-step walkthrough of setting up Dogr
|
|||
allowFullScreen
|
||||
></iframe>
|
||||
|
||||
For local development and testing, you can run Dograh AI directly on your machine using Docker with a single command.
|
||||
For local development and testing, you can run Dograh AI directly on your machine using Docker with a small startup script.
|
||||
|
||||
### Quick Start
|
||||
|
||||
Run this single command to download and start Dograh AI:
|
||||
Download the compose file and starter script, then confirm the prompt to start Dograh AI:
|
||||
|
||||
```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 --pull always
|
||||
<CodeGroup>
|
||||
```bash macOS/Linux
|
||||
curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml && curl -o start_docker.sh https://raw.githubusercontent.com/dograh-hq/dograh/main/scripts/start_docker.sh && chmod +x start_docker.sh && ./start_docker.sh
|
||||
```
|
||||
```powershell Windows
|
||||
Invoke-WebRequest -OutFile docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/main/docker-compose.yaml
|
||||
Invoke-WebRequest -OutFile start_docker.ps1 https://raw.githubusercontent.com/dograh-hq/dograh/main/scripts/start_docker.ps1
|
||||
.\start_docker.ps1
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
This command:
|
||||
This setup:
|
||||
- Downloads the latest docker-compose.yaml
|
||||
- Creates `OSS_JWT_SECRET` in `.env` if one does not already exist
|
||||
- Prompts before running Docker Compose
|
||||
- Starts all required services including PostgreSQL, Redis, MinIO, API, and UI
|
||||
- Pulls the latest images automatically
|
||||
|
||||
|
|
@ -43,7 +52,7 @@ http://localhost:3010
|
|||
```
|
||||
|
||||
<Note>
|
||||
You can disable telemetry by setting `ENABLE_TELEMETRY=false` in the command above.
|
||||
You can disable telemetry by setting `ENABLE_TELEMETRY=false` before running `./start_docker.sh` or `.\start_docker.ps1`.
|
||||
</Note>
|
||||
|
||||
### Troubleshooting WebRTC Connectivity
|
||||
|
|
@ -72,7 +81,7 @@ The script will prompt you for:
|
|||
- The host browsers should use to reach TURN (press Enter for `127.0.0.1`; use your LAN IP if testing from another device on the same network)
|
||||
- A shared secret for the TURN server (press Enter to generate a random one)
|
||||
|
||||
It creates `docker-compose.yaml`, a `.env` file with TURN credentials, and the small helper bundle that `dograh-init` uses to render coturn config at startup. Start the stack with the `local-turn` profile so coturn comes up alongside the other services:
|
||||
It creates `docker-compose.yaml`, a `.env` file with JWT and TURN credentials, and the small helper bundle that `dograh-init` uses to render coturn config at startup. Start the stack with the `local-turn` profile so coturn comes up alongside the other services:
|
||||
|
||||
```bash
|
||||
docker compose --profile local-turn up --pull always
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue