mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-19 08:28:10 +02:00
chore: add dograh plugin in documentations
This commit is contained in:
parent
3d1886c450
commit
a849c9b244
5 changed files with 73 additions and 0 deletions
11
README.md
11
README.md
|
|
@ -84,6 +84,17 @@ An honest comparison on the axes that matter most to teams evaluating voice AI p
|
|||
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
|
||||
```
|
||||
|
||||
> **⚡ Prefer an AI agent to set it up for you?**
|
||||
> If you use **Claude Code** or **Codex**, install the official [Dograh setup skill](https://github.com/dograh-hq/dograh-plugins) and let your agent handle installation, configuration, and troubleshooting — it detects your OS, picks the right deploy path, runs Dograh's own setup scripts, and verifies the result.
|
||||
>
|
||||
> ```text
|
||||
> # In Claude Code
|
||||
> /plugin marketplace add dograh-hq/dograh-plugins
|
||||
> /plugin install dograh@dograh
|
||||
> ```
|
||||
>
|
||||
> Then start a new session and ask it to _"set up Dograh"_ (or run `/dograh-setup`). Codex is supported too — see the [plugin repo](https://github.com/dograh-hq/dograh-plugins#install).
|
||||
|
||||
> **Note**
|
||||
> First startup may take 2-3 minutes to download all images. Once running, open http://localhost:3010 to create your first AI voice assistant!
|
||||
> For common issues and solutions, see 🔧 **[Troubleshooting](docs/troubleshooting.md)**.
|
||||
|
|
|
|||
|
|
@ -84,6 +84,17 @@
|
|||
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
|
||||
```
|
||||
|
||||
> **⚡ 想让 AI 智能体帮你完成部署?**
|
||||
> 如果你使用 **Claude Code** 或 **Codex**,可以安装官方的 [Dograh 部署技能(skill)](https://github.com/dograh-hq/dograh-plugins),让智能体替你完成安装、配置与排障——它会识别你的操作系统、选择合适的部署方式、运行 Dograh 自带的部署脚本并验证结果。
|
||||
>
|
||||
> ```text
|
||||
> # 在 Claude Code 中
|
||||
> /plugin marketplace add dograh-hq/dograh-plugins
|
||||
> /plugin install dograh@dograh
|
||||
> ```
|
||||
>
|
||||
> 然后开启一个新会话,让它 _"set up Dograh"_(或运行 `/dograh-setup`)。Codex 同样支持——详见[插件仓库](https://github.com/dograh-hq/dograh-plugins#install)。
|
||||
|
||||
> **提示**
|
||||
> 首次启动需要 2-3 分钟拉取所有镜像。启动完成后,打开 http://localhost:3010 即可创建你的第一个 AI 语音助手!
|
||||
> 常见问题及解决方案请参见 🔧 **[故障排查](docs/troubleshooting.md)**。
|
||||
|
|
|
|||
|
|
@ -6,6 +6,23 @@ description: Set up the Dograh contributor environment with the devcontainer-fir
|
|||
If the steps below do not work for you, please open an issue on [GitHub](https://github.com/dograh-hq/dograh/issues).
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
**Using Claude Code or Codex?** Install the official Dograh setup skill and let your agent walk you through the contributor setup — it covers both the devcontainer and host-managed paths, runs Dograh's own scripts, and verifies the stack is healthy.
|
||||
|
||||
<CodeGroup>
|
||||
```text Claude Code
|
||||
/plugin marketplace add dograh-hq/dograh-plugins
|
||||
/plugin install dograh@dograh
|
||||
```
|
||||
```text Codex
|
||||
codex plugin marketplace add dograh-hq/dograh-plugins
|
||||
codex plugin add dograh@dograh
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Start a new session, then ask it to *"set up Dograh for development"* (or run `/dograh-setup develop` in Claude Code). More at [dograh-hq/dograh-plugins](https://github.com/dograh-hq/dograh-plugins).
|
||||
</Tip>
|
||||
|
||||
### Recommended: Devcontainer Setup
|
||||
|
||||
#### System Requirements
|
||||
|
|
|
|||
|
|
@ -8,6 +8,23 @@ Dograh AI can be deployed using Docker in two main configurations. Choose the op
|
|||
- **Option 1**: For local development and testing on your own machine
|
||||
- **Option 2**: For remote server deployment with HTTPS (using IP address). If you also have a custom domain, you can first deploy Dograh stack on your server using steps in this document and then proceed to the [Custom Domain](deployment/custom-domain) section.
|
||||
|
||||
<Tip>
|
||||
**Using Claude Code or Codex?** Install the official Dograh setup skill and let your agent drive either deployment below — it orients to your OS, picks local vs remote, runs Dograh's own setup scripts, and verifies the result with a built-in health check.
|
||||
|
||||
<CodeGroup>
|
||||
```text Claude Code
|
||||
/plugin marketplace add dograh-hq/dograh-plugins
|
||||
/plugin install dograh@dograh
|
||||
```
|
||||
```text Codex
|
||||
codex plugin marketplace add dograh-hq/dograh-plugins
|
||||
codex plugin add dograh@dograh
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Start a new session, then ask it to *"set up Dograh"* (or run `/dograh-setup` in Claude Code). More at [dograh-hq/dograh-plugins](https://github.com/dograh-hq/dograh-plugins).
|
||||
</Tip>
|
||||
|
||||
## Option 1: Local Docker Deployment
|
||||
|
||||
Watch the video tutorial below for a step-by-step walkthrough of setting up Dograh AI locally with Docker.
|
||||
|
|
|
|||
|
|
@ -39,6 +39,23 @@ Invoke-WebRequest -OutFile start_docker.ps1 https://raw.githubusercontent.com/do
|
|||
```
|
||||
</CodeGroup>
|
||||
|
||||
<Tip>
|
||||
**Using an AI coding agent?** If you work in **Claude Code** or **Codex**, install the official Dograh setup skill and let your agent handle installation, configuration, and troubleshooting for you. It orients to your OS, picks the right deploy path, runs Dograh's own setup scripts, and verifies the result. Install it once:
|
||||
|
||||
<CodeGroup>
|
||||
```text Claude Code
|
||||
/plugin marketplace add dograh-hq/dograh-plugins
|
||||
/plugin install dograh@dograh
|
||||
```
|
||||
```text Codex
|
||||
codex plugin marketplace add dograh-hq/dograh-plugins
|
||||
codex plugin add dograh@dograh
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
Then start a new session and ask it to *"set up Dograh"* (in Claude Code you can also run `/dograh-setup`). See [dograh-hq/dograh-plugins](https://github.com/dograh-hq/dograh-plugins) for details.
|
||||
</Tip>
|
||||
|
||||
Please check [Prerequisites](getting-started/prerequisites) for the system requirements and [Troubleshooting](getting-started/troubleshooting) for common issues.
|
||||
|
||||
## Next Steps
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue