mirror of
https://github.com/Such-Software/adaptive-multi-protocol-gateway.git
synced 2026-10-17 07:31:32 +02:00
4.0 KiB
4.0 KiB
Configuration
Status: draft | Updated 2026-07-05 | Applies to:
gateway.toml
AMPG is configured from one TOML file. The file declares global paths, sites, source adapters, render targets, and daemon policy.
Minimal Wownero pilot config
[gateway]
state_dir = "/var/lib/ampg"
cache_dir = "/var/cache/ampg"
run_dir = "/run/ampg"
user = "ampg"
[[site]]
id = "wownero"
domain = "wownero.org"
[site.source]
kind = "static-html"
path = "../wownero.org-website"
canonical_url = "https://wownero.org"
[site.outputs]
root = "/var/www/ampg/wownero"
[site.interactions]
default_tier = "static"
deny_routes = ["/admin/*", "/internal/*", "/webhooks/*"]
[site.protocols.clearnet]
enabled = true
renderer = "clearnet"
daemon = "caddy"
daemon_policy = "adopt"
[site.protocols.tor]
enabled = true
renderer = "privacy-html"
daemon = "tor"
daemon_policy = "auto"
local_port = 18080
onion_location = "auto"
[site.protocols.i2p]
enabled = false
renderer = "privacy-html"
daemon = "i2pd"
daemon_policy = "auto"
local_port = 18081
[site.protocols.gemini]
enabled = false
renderer = "gemtext"
daemon = "agate"
daemon_policy = "auto"
port = 1965
[site.protocols.reticulum]
enabled = false
renderer = "micron"
daemon = "rnsd"
daemon_policy = "auto"
aspect = "web"
Defaults
Selected protocols default to daemon_policy = "auto" unless the protocol is clearnet.
Clearnet defaults to adopt, because most operators already have a web server and TLS
workflow.
| Protocol | Default renderer | Default daemon | Default policy |
|---|---|---|---|
| clearnet | clearnet |
caddy |
adopt |
| tor | privacy-html |
tor |
auto |
| i2p | privacy-html |
i2pd |
auto |
| gemini | gemtext |
agate |
auto |
| reticulum | micron |
rnsd |
auto |
Renderer defaults
privacy-html removes:
<script>blocks and event handler attributes.- remote fonts, analytics, and third-party embeds.
- localStorage/sessionStorage assumptions.
- non-local asset references unless explicitly allowed.
gemtext defaults:
- one
.gmipage per HTML or Markdown page. - inline links emitted after the paragraph that referenced them.
- images and PDFs emitted as links with file size metadata when known.
micron defaults:
- one
.mupage per high-value page. - headings converted to terminal-safe emphasis.
- images omitted unless the site config opts into small downloadable assets.
Daemon policy values
external- Build outputs and print config. Never inspect, write, start, or reload daemons.
adopt- Use a configured or detected daemon. Fail with a clear diagnostic if missing.
manage- Create an AMPG-owned daemon instance and supervise it.
auto- Adopt a healthy daemon when one is found. Otherwise create an AMPG-owned instance.
Interactive app config
Applications can declare route groups and upstreams. AMPG only exposes the tiers each transport can safely support.
[[site]]
id = "shop_platform"
domain = "example-shop.net"
[site.source]
kind = "reverse-proxy"
upstream = "http://127.0.0.1:8000"
openapi = "http://127.0.0.1:9000/openapi.json"
[site.interactions]
default_tier = "forms"
session_policy = "http-only-cookie"
deny_routes = ["/admin/*", "/api/internal/*", "/webhooks/*"]
[[site.interactions.route]]
match = "/admin/*"
tier = "internal"
[[site.interactions.route]]
match = "/checkout/*"
tier = "sessions"
[[site.interactions.route]]
match = "/catalog/*"
tier = "forms"
[site.protocols.tor]
enabled = true
renderer = "privacy-html"
daemon_policy = "auto"
allow_javascript = false
[site.protocols.gemini]
enabled = true
renderer = "gemtext"
daemon_policy = "auto"
max_tier = "forms"
max_tier is a hard cap. If a route needs a higher tier than the protocol allows, AMPG
omits it or renders a safe alternate page.
Reusable checklist
- Keep paths explicit in production configs.
- Use
ampg planbeforeampg apply. - Use
daemon_policy = "external"for package-maintainer examples. - Use
daemon_policy = "auto"for single-box deployments.