Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions HOSTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ The hosted tier should monetize managed reliability and familiar continuity, whi

See [Architecture Diagrams](docs/architecture.md) for the hosted vs self-hosted deployment diagram and trust-boundary map.

The lightweight TypeScript webhook deployment bundle now lives in
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook).
It uses this repo's GitHub App manifest and headless contract, then maps
installation/repository IDs to familiar routes through a local JSON policy.
Comment on lines +11 to +12

## Hosted Flow

```mermaid
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ For deeper system, sequence, state, security-boundary, and hosted deployment dia
| `crates/worker` | this repo | Task runner: spawns coven-code, streams progress, posts Check Runs |
| `crates/github` | this repo | GitHub API client: installations, Check Runs, PRs, comments |
| `crates/config` | this repo | Familiar config, installation registry, model routing |
| `coven-github-webhook` | [OpenCoven/coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) | TypeScript deployment bundle for the hosted/self-hostable webhook entrypoint |
| `coven-code` | [OpenCoven/coven-code](https://github.com/OpenCoven/coven-code) | Execution runtime (headless mode) |
| `CovenCave` | [OpenCoven/coven-cave](https://github.com/OpenCoven/coven-cave) | Oversight UI |

Expand Down Expand Up @@ -146,6 +147,11 @@ Prefer containers? A multi-stage [`Dockerfile`](Dockerfile) and

See [docs/self-hosting.md](docs/self-hosting.md) for GitHub App registration, permissions, smoke tests, and troubleshooting. For a minimal familiar route, start from [`examples/familiar-github-starter`](examples/familiar-github-starter/).

For a lightweight TypeScript deployment entrypoint that follows this app
contract, use
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook)
with its `config/example-policy.json` and connection guide.
Comment on lines +150 to +153

---

## Sponsor / Hosted Tier
Expand All @@ -159,6 +165,7 @@ See [Hosted OpenCoven](HOSTED.md) and [Hosted vs self-hosted](docs/hosted-vs-sel
## Related

- [coven-code](https://github.com/OpenCoven/coven-code) — execution runtime
- [coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) — TypeScript webhook deployment bundle
- [coven-cave](https://github.com/OpenCoven/coven-cave) — oversight UI
- [cast-codes](https://github.com/OpenCoven/cast-codes) — local IDE with CastAgent

Expand Down
7 changes: 7 additions & 0 deletions docs/self-hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

This guide walks you through registering a GitHub App and running `coven-github` on your own infrastructure.

If you want the lightweight TypeScript deployment bundle instead of the Rust
service entrypoint, use
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook)
after completing the GitHub App registration steps below. Its connection guide
uses this repo's manifest and maps installation/repository IDs into
`config/example-policy.json`.
Comment on lines +8 to +10

## Prerequisites

- Rust toolchain (`rustup`)
Expand Down
Loading