mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-10-08 03:10:26 +00:00
Add Integrations and Deployment stub pages to docs sidebar
Add Integrations group (GitHub, Daytona, Slack, exe.dev, Brave Search) to Documentation tab above Reference. Replace generic Deployment page with platform-specific stubs (Railway, Render, Fly.io, Digital Ocean) in the Guides tab. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
4cefad86eb
commit
8d60411e49
11 changed files with 69 additions and 109 deletions
6
docs/administration/deploy-digital-ocean.mdx
Normal file
6
docs/administration/deploy-digital-ocean.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Digital Ocean"
|
||||
description: "Deploy Arc to Digital Ocean"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/administration/deploy-fly-io.mdx
Normal file
6
docs/administration/deploy-fly-io.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Fly.io"
|
||||
description: "Deploy Arc to Fly.io"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/administration/deploy-railway.mdx
Normal file
6
docs/administration/deploy-railway.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Railway"
|
||||
description: "Deploy Arc to Railway"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/administration/deploy-render.mdx
Normal file
6
docs/administration/deploy-render.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Render"
|
||||
description: "Deploy Arc to Render"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
|
|
@ -1,108 +0,0 @@
|
|||
---
|
||||
title: "Deployment"
|
||||
description: "Running Arc in production: TLS, systemd, health checks, and tuning"
|
||||
---
|
||||
|
||||
## Binding and TLS
|
||||
|
||||
By default, `arc serve` binds to `127.0.0.1:3000` (localhost only). For production, either:
|
||||
|
||||
1. **Reverse proxy** — Keep the default binding and place nginx, Caddy, or an ALB in front:
|
||||
|
||||
```nginx
|
||||
upstream arc {
|
||||
server 127.0.0.1:3000;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name arc.example.com;
|
||||
|
||||
ssl_certificate /etc/tls/cert.pem;
|
||||
ssl_certificate_key /etc/tls/key.pem;
|
||||
|
||||
location / {
|
||||
proxy_pass http://arc;
|
||||
proxy_http_version 1.1;
|
||||
|
||||
# Required for SSE event streams
|
||||
proxy_set_header Connection '';
|
||||
proxy_buffering off;
|
||||
proxy_cache off;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. **Direct TLS** — Configure TLS in `server.toml`:
|
||||
|
||||
```toml
|
||||
[api.tls]
|
||||
cert = "/etc/arc/tls/cert.pem"
|
||||
key = "/etc/arc/tls/key.pem"
|
||||
ca = "/etc/arc/tls/ca.pem"
|
||||
```
|
||||
|
||||
<Note>
|
||||
If you use a reverse proxy, set `api.base_url` in `server.toml` to the external URL so that API responses include correct links.
|
||||
</Note>
|
||||
|
||||
## Running as a service
|
||||
|
||||
Example systemd unit:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Arc API Server
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=arc
|
||||
WorkingDirectory=/opt/arc
|
||||
EnvironmentFile=/opt/arc/.env
|
||||
ExecStart=/opt/arc/bin/arc serve --host 0.0.0.0 --port 3000 --config /etc/arc/server.toml
|
||||
Restart=on-failure
|
||||
RestartSec=5
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
## Health checks
|
||||
|
||||
The API server exposes a health endpoint at `GET /health` that returns `{"status": "ok"}`. No authentication is required. Use this for load balancer health checks, container orchestration probes, or uptime monitoring.
|
||||
|
||||
```bash
|
||||
curl http://localhost:3000/health
|
||||
```
|
||||
|
||||
## Concurrency tuning
|
||||
|
||||
| Setting | Default | Where |
|
||||
|---|---|---|
|
||||
| Max concurrent runs | 5 | `--max-concurrent-runs` or `max_concurrent_runs` in `server.toml` |
|
||||
| Max parallel branches per node | 4 | `max_parallel` attribute on parallel nodes in DOT |
|
||||
| Subagent depth | 1 | Hardcoded (subagents can spawn one level deep) |
|
||||
| Max tool rounds per turn | 200 | Hardcoded |
|
||||
| Default retries | 3 | `default_max_retry` graph attribute (or `max_retries` per node) |
|
||||
|
||||
## Stall watchdog
|
||||
|
||||
Arc cancels a run if no handler events are emitted for a configurable duration. This protects against hung agents or unresponsive LLM providers.
|
||||
|
||||
| Setting | Default | Where |
|
||||
|---|---|---|
|
||||
| `stall_timeout` | `600s` (10 min) | Graph attribute: `graph [stall_timeout="300s"]` |
|
||||
|
||||
Set to `0s` to disable: `graph [stall_timeout="0s"]`.
|
||||
|
||||
## Log files
|
||||
|
||||
Arc writes two kinds of logs:
|
||||
|
||||
- **Application logs** — `~/.arc/logs/YYYY-MM-DD.log` (structured, controlled by `ARC_LOG`)
|
||||
- **Run logs** — `~/.arc/logs/{run_id}/progress.jsonl` (one event per line)
|
||||
|
||||
The logs directory is not currently configurable and has no automatic retention. For production, set up external log rotation (e.g. `logrotate`) or periodic cleanup of old run directories.
|
||||
|
||||
See [Observability](/execution/observability) for the full event schema and analysis tools.
|
||||
|
|
@ -72,6 +72,17 @@
|
|||
"agents/outputs"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Integrations",
|
||||
"icon": "puzzle-piece",
|
||||
"pages": [
|
||||
"integrations/github",
|
||||
"integrations/daytona",
|
||||
"integrations/slack",
|
||||
"integrations/exe-dev",
|
||||
"integrations/brave-search"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Reference",
|
||||
"icon": "book",
|
||||
|
|
@ -120,7 +131,10 @@
|
|||
"group": "Deployment",
|
||||
"icon": "server",
|
||||
"pages": [
|
||||
"administration/deployment"
|
||||
"administration/deploy-railway",
|
||||
"administration/deploy-render",
|
||||
"administration/deploy-fly-io",
|
||||
"administration/deploy-digital-ocean"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
|
|
|||
6
docs/integrations/brave-search.mdx
Normal file
6
docs/integrations/brave-search.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Brave Search"
|
||||
description: "Give Arc agents web search capabilities via the Brave Search API"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/integrations/daytona.mdx
Normal file
6
docs/integrations/daytona.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Daytona"
|
||||
description: "Run Arc workflows in sandboxed Daytona development environments"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/integrations/exe-dev.mdx
Normal file
6
docs/integrations/exe-dev.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "exe.dev"
|
||||
description: "Connect Arc with exe.dev for cloud-based workflow execution"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/integrations/github.mdx
Normal file
6
docs/integrations/github.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "GitHub"
|
||||
description: "Integrate Arc with GitHub for repository access and pull request workflows"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
6
docs/integrations/slack.mdx
Normal file
6
docs/integrations/slack.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "Slack"
|
||||
description: "Send notifications and interact with Arc workflows from Slack"
|
||||
---
|
||||
|
||||
Coming soon.
|
||||
Loading…
Add table
Reference in a new issue