Skip to content

Fortified IDDocs

Configuration

Configure an SDK Access Point instance with Docker Compose, PostgreSQL, tenant identity, TLS trust and secrets.

Configure the access point as its own instance. This guide uses the signed Docker Compose delivery for closed testing and the external PostgreSQL example. Copy the templates from the same release archive you plan to install. Use synthetic identities, test keys and test packages for this profile.

  • External PostgreSQL. Use compose.yaml and copy examples/installation.external.json. Provide a database reachable from the container, a trusted database CA and separate runtime and migration roles. The example uses hostname-verified database TLS.
  • Synthetic PostgreSQL. Use the release’s synthetic installation example and compose.synthetic.yaml for an isolated database. Supply a separate database admin password for this profile in addition to the runtime and migration passwords.

Copy the chosen example to installation.json. The example below shows the external profile, including the host ports and the synthetic participant ID. Replace instance names, paths, role names and participant IDs with values for your test environment.

{
"schema_version": 1,
"mode": "closed_preparation",
"production_authorized": false,
"configuration": {
"instance": "secureflow-ap-stage",
"profile": "external",
"config_dir": "/etc/secureflow/secureflow-ap-stage",
"runtime_dir": "/run/secureflow/secureflow-ap-stage",
"as4_port": 18443,
"internal_port": 19443,
"memory_mb": 1536,
"heap_mb": 512,
"database_runtime_role": "secureflow_runtime",
"served_participants": [
"0203:receiver.test"
]
}
}
Field What to set
instance A unique name for the installation.
config_dir, runtime_dir Host directories for configuration and runtime secret delivery. Keep both outside the release directory.
as4_port, internal_port Distinct host ports for AS4 and the private API. The closed Compose profile publishes both on IPv4 loopback.
memory_mb, heap_mb Container memory and JVM heap bounds. The example values are for testing.
database_runtime_role The PostgreSQL login used by the runtime. Match database.user in runtime.properties.
served_participants Participant IDs served by this instance. The installer passes the list to the runtime as AP_SERVED_PARTICIPANTS.

Copy the matching runtime and migrator templates to runtime.properties and migrator.properties. These lines are an excerpt from the external runtime template. Replace the example hostname and database details, and mount the database CA at the configured path.

tenant.id=tenant-a
bearer.token.env=AP_BEARER_TOKEN
database.url=jdbc:postgresql://postgres.example.invalid:5432/secureflow?currentSchema=ap&connectTimeout=5&socketTimeout=15&sslmode=verify-full&sslrootcert=/run/ap-keys/database/ca.crt
database.user=secureflow_runtime
database.password.env=AP_DATABASE_PASSWORD

Use the same database and schema in both files. Set database.user in the migrator file to the migration login. The runtime uses a restricted role and starts after the explicit migration succeeds. Each process resolves AP_DATABASE_PASSWORD from its own secret file. Set tenant.id to the tenant served by the instance and configure the private server and client certificates according to that tenant’s trust configuration.

File or directory Contents
runtime.properties and migrator.properties Database, tenant, TLS and message key settings. Reference credentials by environment variable name.
public-pki.properties Trust anchors, intermediates and revocation sources for the configured trust realms.
internal-tls.properties Server key store and client trust store for the private Interface C listener.
health.properties Keystore and truststore for the private readiness client.
config_dir/keys/ Certificate and key material mounted in the container under /run/ap-keys. Keep issuer private signing keys outside the access point.

For example, the private listener template references these container paths and secret names. Match the alias to the key entry in the supplied keystore.

keyStore.path=/run/ap-keys/internal/pki/receiver-b.p12
keyStore.password.env=AP_INTERNAL_KEYSTORE_PASSWORD
key.alias=receiver-b
trustStore.path=/run/ap-keys/internal/pki/receiver-trust.p12
trustStore.password.env=AP_INTERNAL_TRUSTSTORE_PASSWORD

Supply one file per value under runtime_dir/common-secrets/:

  • AP_BEARER_TOKEN
  • AP_TLS_KEYSTORE_PASSWORD and AP_TLS_TRUSTSTORE_PASSWORD
  • AP_MESSAGE_KEYSTORE_PASSWORD and AP_MESSAGE_TRUSTSTORE_PASSWORD
  • AP_INTERNAL_KEYSTORE_PASSWORD and AP_INTERNAL_TRUSTSTORE_PASSWORD
  • AP_HEALTH_KEYSTORE_PASSWORD and AP_HEALTH_TRUSTSTORE_PASSWORD

Put the two database passwords in runtime-secrets/AP_DATABASE_PASSWORD and migrator-secrets/AP_DATABASE_PASSWORD under runtime_dir. The synthetic profile also uses admin-secrets/AP_DATABASE_PASSWORD. Secret files must be plain UTF-8, 1–4096 bytes, with at most one trailing line feed. Follow the archive’s Linux ownership and permissions instructions before running preflight.

Choose a PKCS#12 store or a PKCS#11 device for AS4 message keys. Use separate TLS identities for the two listeners. Key management and PKI includes the PKCS#11 configuration example, certificate roles and revocation settings. Runtime settings lists the listener, AS4 and discovery parameters.

  1. Run the installer’s preflight after importing the signed delivery. Replace the example paths and digest with the values for your instance.

    Terminal window
    python3 -E -s /opt/secureflow/releases/RELEASE/install.py preflight \
    --delivery /opt/secureflow/releases/RELEASE \
    --public-key /etc/secureflow/trust/publisher.pub \
    --expected-manifest-sha256 MANIFEST_SHA256 \
    --installation /etc/secureflow/INSTANCE/installation.json
  2. Run the explicitly authorized migration and then start the instance. If the release or instance material changes after migration, repeat the installation checks before starting.

  3. Use the supplied health client to check private readiness, then send a synthetic message and verify both the AS4 receipt and retrieval. Installation procedure · Delivery checks