mirror of
https://github.com/Such-Software/adaptive-multi-protocol-gateway.git
synced 2026-10-17 15:41:41 +02:00
3.9 KiB
3.9 KiB
Generated Config Schema
Status: generated | Updated by
python3 -m ampg docs generate| Applies to: AMPG
This file is generated from code. Do not edit it by hand.
| Section | Field | Type | Required | Default | Description |
|---|---|---|---|---|---|
| gateway | state_dir |
path | no | ./.ampg/state | AMPG-owned daemon state and captured address registry root. |
| gateway | cache_dir |
path | no | ./.ampg/cache | AMPG cache root for generated intermediate data. |
| gateway | run_dir |
path | no | ./.ampg/run | Runtime socket and process metadata root for managed daemons. |
| gateway | user |
string | no | - | Preferred service user for generated managed-daemon artifacts. |
| site | id |
string | yes | - | Stable site identifier used in output paths. |
| site | domain |
string | yes | - | Canonical public domain for the site. |
| site.source | kind |
enum | yes | static-html | Source adapter kind. |
| site.source | path |
path | yes | - | Source tree path. |
| site.source | canonical_url |
url | no | - | Canonical clearnet URL. |
| site.outputs | root |
path | yes | - | Generated output root. |
| site.outputs | plan_root |
path | no | ../dist/ampg-plan | Generated plan artifact root. |
| site.interactions | default_tier |
enum | no | static | Default interaction tier for routes. |
| site.interactions | deny_routes |
array | no | [] | Route patterns that must not be published. |
| site.interactions | route_manifest |
path | no | - | JSON route manifest generated or maintained by the application. |
| site.interactions.route | match |
glob | no | - | Route pattern for an explicit interaction policy. |
| site.interactions.route | tier |
enum | no | site.interactions.default_tier | Interaction tier for a route group. |
| site.interactions.route | identity |
enum | no | none | Identity adapter required by a route group. |
| site.interactions.route | payments |
enum | no | none | Payment adapter required by a route group. |
| site.interactions.route | realtime |
boolean | no | false | Whether a route group requires live state or streaming updates. |
| site.interactions.route | public_allowed |
boolean | no | true | Whether this route group may be emitted into public protocol outputs. |
| site.protocols. | enabled |
boolean | no | false | Whether this protocol target is built and planned. |
| site.protocols. | renderer |
enum | no | Renderer profile to use for this protocol. | |
| site.protocols. | daemon |
enum | no | protocol default | Ingress daemon adapter. |
| site.protocols. | daemon_policy |
enum | no | protocol default | Whether AMPG adopts, manages, or only renders config. |
| site.protocols. | fixture_url |
url | no | - | Published URL used in fixture manifests and health plans. |
| site.protocols. | browser_url |
url | no | - | Browser-facing URL alias used when fixture_url is not set. |
| site.protocols. | address_file |
path | no | - | Daemon-written public address file consumed by addresses capture. |
| site.protocols. | max_asset_bytes |
integer | no | 1048576 | Maximum asset size copied by privacy-html render targets. |
| site.protocols. | script_policy |
enum | no | strip | Script handling policy for privacy-html render targets. |
| site.protocols. | max_tier |
enum | no | transport default | Maximum interaction tier this protocol target may expose. |
| profiles. | description |
string | no | - | Human-readable deployment profile description. |
| profiles. | protocols |
array | no | all enabled protocols | Enabled protocols selected by this deployment profile. |
| profiles. | platform |
enum | no | detected platform | Platform provider used by status, doctor, and apply when not overridden. |
| profiles. | write_artifacts |
boolean | no | false | Whether plan/apply dry-run writes review artifacts by default. |