Skip to content

Commit 0157cc8

Browse files
rasifrclaude
authored andcommitted
docs: fix config key names, add missing CDC key, update install version
- Fix cert_auth key names: user_cert_file/user_key_file → ace_user_cert_file/ace_user_key_file to match YAML struct tags - Add missing mtree.cdc.cdc_metadata_flush_seconds to config table - Update hardcoded v1.5.3 → v1.9.0 with a note to keep it current Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9f9e239 commit 0157cc8

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

docs/configuration.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The [`ace.yaml` file](https://github.com/pgEdge/ace/blob/main/ace.yaml) defines
3636
| mtree → cdc --> slot_name | Logical decoding slot name for mtree CDC. **Default: "ace_mtree_slot"** |
3737
| mtree → cdc --> publication_name | Publication used for mtree CDC. **Default: "ace_mtree_pub"** |
3838
| mtree → cdc --> cdc_processing_timeout | CDC processing timeout (s). **Default: 30** |
39+
| mtree → cdc --> cdc_metadata_flush_seconds | How often (s) CDC metadata is flushed to disk. **Default: 10** |
3940
| mtree --> schema | Schema used for mtree metadata/objects. **Default: "spock"** |
4041
| mtree → diff --> min_block_size | Minimum Merkle diff block size. **Default: 1000** |
4142
| mtree → diff --> block_size | Target Merkle diff block size. **Default: 100000** |
@@ -45,8 +46,8 @@ The [`ace.yaml` file](https://github.com/pgEdge/ace/blob/main/ace.yaml) defines
4546
| (root) --> schedule_jobs | Array of job definitions consumed by the scheduler (see [Scheduling ACE Runs](scheduling.md)). **Default: []** |
4647
| (root) --> schedule_config | Array of cadence settings (`run_frequency` or `crontab_schedule`) that reference entries in `schedule_jobs`. **Default: []** |
4748
| cert_auth --> use_cert_auth | Use client certificate authentication. **Default: true** |
48-
| cert_auth --> user_cert_file | Path to user/client certificate. **Default: "data/pg16/pki/admin-cert/admin.crt"** |
49-
| cert_auth --> user_key_file | Path to user/client private key. **Default: "data/pg16/pki/admin-cert/admin.key"** |
49+
| cert_auth --> ace_user_cert_file | Path to user/client certificate. **Default: "data/pg16/pki/admin-cert/admin.crt"** |
50+
| cert_auth --> ace_user_key_file | Path to user/client private key. **Default: "data/pg16/pki/admin-cert/admin.key"** |
5051
| cert_auth --> ca_cert_file | Path to CA certificate. **Default: "data/pg16/pki/ca.crt"** |
5152
| (root) --> debug_mode | Enable verbose/diagnostic logging. **Default: false** |
5253

docs/install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Requires Go 1.26+. No CGO or system SQLite libraries needed — the project uses
1414
# Latest release
1515
go install github.com/pgedge/ace/cmd/ace@latest
1616

17-
# Specific version
18-
go install github.com/pgedge/ace/cmd/ace@v1.5.3
17+
# Specific version — update to the latest tag from GitHub Releases
18+
go install github.com/pgedge/ace/cmd/ace@v1.9.0
1919
```
2020

2121
The binary lands in `GOBIN` if set, otherwise `$GOPATH/bin` (defaults to `~/go/bin`). Add that to your `PATH`:
@@ -29,7 +29,7 @@ export PATH="$(go env GOBIN || go env GOPATH)/bin:$PATH"
2929
Grab the prebuilt archive for your platform from GitHub Releases and unpack the `ace` binary:
3030

3131
```sh
32-
ACE_VER=v1.5.3
32+
ACE_VER=v1.9.0 # update to the latest tag from GitHub Releases
3333
OS=Linux # or Darwin or Windows
3434
ARCH=x86_64 # or arm64
3535

0 commit comments

Comments
 (0)