SincroX Agent
Lightweight SQL bridge that runs next to your database. Connects your database to the SincroX platform securely — only SELECT queries are allowed, with HMAC authentication and configurable timeouts.
Quick Install
curl -fsSL https://sincrox.com/install.sh | bash
Or with Docker directly:
docker run -d \
--name sincrox-agent \
--restart unless-stopped \
-e DATABASE_URL="postgresql://user:pass@host:5432/db" \
-e HMAC_SECRET="your-secret-from-dashboard" \
-p 8001:8001 \
ghcr.io/eljoesb/sincrox-agent:latest
Or with pip:
pip install sincrox-agent
DATABASE_URL="postgresql://..." HMAC_SECRET="..." sincrox-agent
Configuration
| Variable | Required | Default | Description |
|---|---|---|---|
DATABASE_URL |
Yes | — | Database connection string (PostgreSQL, MySQL, or MSSQL) |
HMAC_SECRET |
Yes | — | Shared secret from your SincroX dashboard (min 32 chars) |
AGENT_PORT |
No | 8001 |
Port the agent listens on |
AGENT_HOST |
No | 0.0.0.0 |
Host to bind to |
QUERY_TIMEOUT_SECONDS |
No | 10 |
Max query execution time |
MAX_ROWS |
No | 1000 |
Max rows returned per query |
Supported Databases
- PostgreSQL (
postgresql://...) - MySQL (
mysql+pymysql://...) - SQL Server (
mssql+pyodbc://...)
Endpoints
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /health |
None | Health check |
| POST | /introspect |
HMAC | Returns database schema |
| POST | /execute |
HMAC | Executes a SELECT query |
Security
- Only
SELECTandWITH(CTE) queries are allowed - All other SQL operations (INSERT, UPDATE, DELETE, DROP, etc.) are blocked
- Requests are authenticated via HMAC-SHA256 signatures
- Query timeout and row limits are enforced
1 maintainer
Metadata
1 maintainer
Release files for sincrox-agent 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sincrox_agent-0.1.0.tar.gz | 15.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sincrox_agent-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.8 kB
Release files / sincrox_agent-0.1.0.tar.gz
| Download URL | sincrox_agent-0.1.0.tar.gz |
|---|---|
| Size | 15.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7498b9dc9a80ab964292bf005ce47c83d8f6a22af3df56fa3eb1a9f752fb8e59
|
|
BLAKE2b-256 checksum How to use checksums |
c261a2fc43475854865ebca048d47ca1572ad71ec4a7720a88cc0147c6582991
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 6, 2026.
Transparency logRelease files / sincrox_agent-0.1.0-py3-none-any.whl
| Download URL | sincrox_agent-0.1.0-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0353005391e4785f0d670cd939bba137e33c863a1054fcae91e6d1dcaafe66d5
|
|
BLAKE2b-256 checksum How to use checksums |
ea06c68635666bdc7e94a0630fe67dec665fda1daaa76bea9bb6c81cd5b9ea95
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 6, 2026.
Transparency log
