syncnexa/trust-adapter repository overview

⁠SyncNexa Trust Adapter

The official SyncNexa Trust Adapter is a lightweight, on‑premise agent that securely connects a school’s Student Information System (SIS) to the SyncNexa identity network. It runs as a single Docker container inside the school’s infrastructure, requiring only a configuration file and certificates.

⁠How it works

1. The school downloads a unique configuration package from their SyncNexa Partner Dashboard.
2. They mount the YAML config and TLS certificates into the container.
3. The adapter starts, sends periodic heartbeats to SyncNexa over mutual TLS, and answers student‑status queries via an encrypted REST endpoint.
4. Schools never expose raw student data – only cryptographically hashed identifiers are used.

⁠Key features

• Plug‑and‑play connectors – HTTP, SQL, or custom plugins for any SIS.
• Mutual TLS – All traffic is encrypted and authenticated both ways.
• Automatic health monitoring – Heartbeat keeps SyncNexa aware of your adapter’s uptime and SIS response time.
• Drop‑in config – One YAML file, one folder of certs; no code changes.

⁠Quick start

1. Download your adapter-config.zip from your school dashboard.
2. Extract it to /opt/syncnexa-adapter.
3. Run the container:

docker run -d --restart always
-v /opt/syncnexa-adapter:/app/config.yaml
-v /opt/syncnexa-adapter/certs:/etc/adapter/certs:ro
-p 8443:8443
syncnexa/trust-adapter:latest

Your adapter will immediately begin sending heartbeats and is ready to handle verification requests from SyncNexa.