ch-rds 0.1.5

Runtime resource loading and local service orchestration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# ch-rds


`ch-rds` resolves runtime resources and starts conventional local services when
an application uses loopback endpoints.

More information is available in the [API documentation](https://docs.rs/ch-rds).

## High-level features


- Typed loaders for web listeners, MariaDB, and SpacetimeDB
- Explicit production behavior with no local fallback
- Conventional `.env`, `.env.local`, and `services.env` discovery
- Health-gated, protocol-verified Docker Compose startup for loopback resources
- Optional frontend/backend development process orchestration

## Usage


```rust,no_run
#[tokio::main]

async fn main() -> anyhow::Result<()> {
    let runtime = ch_rds::Runtime::bootstrap()?;
    let bind_addr = runtime
        .load(ch_rds::WebBind::builder().addr("127.0.0.1:8080"))
        .await?;

    println!("{bind_addr}");
    Ok(())
}
```

`Runtime` resolves configured remote endpoints directly. Production mode
rejects local fallbacks. `ENV_FILE` selects one explicit dotenv file, while
`PORT` overrides only the port of the fallback listener address.

Conventional layouts auto-discover MariaDB and SpacetimeDB; builders cover
custom stacks. Protocol-level readiness is checked only after Docker reports
the service healthy. One locked service restart remains available for a
previously healthy but persistently broken endpoint; containers are not
restarted while their first initialization is still in progress. SpacetimeDB
updates publish in place to preserve data and identity.

Local stacks use the active Docker context on Windows, macOS, and Linux. When
Docker Desktop is installed on Windows or macOS, `ch-rds` can start it through
the official Docker Desktop CLI. Linux daemon lifecycle remains under the host
service manager.

## Development runner


The `dev` feature provides `ProjectProfile` and `run_project`. Vite owns frontend
hot-module replacement; Watchexec restarts the backend when Rust sources,
manifests, lockfiles, Cargo configuration, or SQL migrations change.

```console
cargo install watchexec-cli --version 2.5.1 --locked
```

## Feature flags


| Feature | Provides |
| --- | --- |
| `dev` | Frontend/backend process orchestration and project profiles |
| `btcpay` | Local BTCPay setup in addition to `dev` |

## Minimum supported Rust version


`ch-rds` requires Rust 1.96 or newer.

## License


Licensed under the Sustainable Use License 1.0. See
[`LICENSE.md`](LICENSE.md).