hivehub/synap repository overview

# Pull the image
docker pull hivehub/synap:latest

# Run a simple instance (all three protocols)
docker run -d \
  --name synap \
  -p 15500:15500 \
  -p 15501:15501 \
  -p 6379:6379 \
  -v synap-data:/data \
  hivehub/synap:latest

# Check health
curl http://localhost:15500/health

version: '3.8'

services:
  synap:
    image: hivehub/synap:latest
    container_name: synap-server
    ports:
      - "15500:15500"  # HTTP/REST API + StreamableHTTP
      - "15501:15501"  # SynapRPC binary protocol (synap://)
      - "6379:6379"    # RESP3 Redis-compatible (resp3://)
    volumes:
      - synap-data:/data
      - ./config.yml:/app/config.yml:ro
    restart: unless-stopped
    # No healthcheck block needed — the image ships its own HEALTHCHECK. Do not
    # override it with a wget/curl probe: the image is built `FROM scratch` and
    # has no shell and no wget, so such a probe can only ever report unhealthy.

volumes:
  synap-data:

# HTTP/REST — universal, any HTTP client
curl http://localhost:15500/kv/get/mykey

# SynapRPC — lowest latency, use Synap SDKs (Rust, TypeScript, Python, etc.)
# Rust SDK:
#   let client = SynapClient::new(SynapConfig::new("synap://localhost:15501"))?;

# RESP3 — Redis-compatible, any Redis client
redis-cli -p 6379 GET mykey

# Set a key
curl -X POST http://localhost:15500/kv/set \
  -H "Content-Type: application/json" \
  -d '{"key": "user:1", "value": "John Doe", "ttl": 3600}'

# Get a key
curl http://localhost:15500/kv/get/user:1

# Delete a key
curl -X DELETE http://localhost:15500/kv/delete/user:1

# Publish a message
curl -X POST http://localhost:15500/queue/publish \
  -H "Content-Type: application/json" \
  -d '{
    "queue": "tasks",
    "message": "process-video",
    "priority": 1
  }'

# Consume a message
curl http://localhost:15500/queue/consume/tasks

# Acknowledge a message
curl -X POST http://localhost:15500/queue/ack \
  -H "Content-Type: application/json" \
  -d '{"queue": "tasks", "message_id": "msg-123"}'

# Publish an event
curl -X POST http://localhost:15500/stream/publish \
  -H "Content-Type: application/json" \
  -d '{
    "room": "chat-room-1",
    "event": "message",
    "data": {"text": "Hello, World!"}
  }'

# Consume events
curl http://localhost:15500/stream/consume/chat-room-1?offset=0&limit=10

# Publish to a topic
curl -X POST http://localhost:15500/pubsub/publish \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "notifications.email",
    "message": "New order received"
  }'

docker run -d \
  --name synap \
  -p 15500:15500 \
  -p 15501:15501 \
  -p 6379:6379 \
  -v synap-data:/data \
  -e SYNAP_AUTH_ENABLED=true \
  -e SYNAP_AUTH_REQUIRE_AUTH=true \
  -e SYNAP_AUTH_ROOT_USERNAME=admin \
  -e SYNAP_AUTH_ROOT_PASSWORD=SecurePassword123! \
  -e SYNAP_AUTH_ROOT_ENABLED=true \
  hivehub/synap:latest

# Basic Auth
curl -X POST http://localhost:15500/kv/set \
  -u admin:SecurePassword123! \
  -H "Content-Type: application/json" \
  -d '{"key": "test", "value": "data"}'

# API Key (Bearer Token)
curl -X POST http://localhost:15500/kv/set \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key": "test", "value": "data"}'

version: '3.8'

services:
  synap-master:
    image: hivehub/synap:latest
    ports:
      - "15500:15500"  # HTTP/REST
      - "15501:15501"  # SynapRPC
      - "6379:6379"    # RESP3
      - "15600:15600"  # Replication (internal)
    volumes:
      - master-data:/data
      - ./config-master.yml:/app/config.yml:ro
    restart: unless-stopped

volumes:
  master-data:

version: '3.8'

services:
  synap-replica:
    image: hivehub/synap:latest
    ports:
      - "15510:15500"  # HTTP/REST
      - "15511:15501"  # SynapRPC
      - "6380:6379"    # RESP3
    volumes:
      - replica-data:/data
      - ./config-replica.yml:/app/config.yml:ro
    environment:
      - SYNAP_MASTER_ADDRESS=master-host:15600
    restart: unless-stopped
    depends_on:
      - synap-master

volumes:
  replica-data:

# Check server health
curl http://localhost:15500/health

# Response: {"service":"synap","status":"healthy","version":"1.2.0"}

# Expose metrics endpoint (if enabled in config)
curl http://localhost:15500/metrics

# Get server stats
curl http://localhost:15500/info

# Get KV store stats
curl http://localhost:15500/kv/stats

# Get queue stats
curl http://localhost:15500/queue/stats/queue-name

# Create custom config.yml
cat > config.yml <<EOF
server:
  host: "0.0.0.0"
  port: 15500

kv_store:
  max_memory_mb: 1024
  eviction_policy: "lru"

queue:
  enabled: true
  max_depth: 100000

# Binary protocols (enabled by default)
synap_rpc:
  enabled: true
  host: "0.0.0.0"
  port: 15501

resp3:
  enabled: true
  host: "0.0.0.0"
  port: 6379

persistence:
  enabled: true
  wal:
    enabled: true
    path: "/data/wal/synap.wal"
  snapshot:
    enabled: true
    directory: "/data/snapshots"
    interval_secs: 300
EOF

# Run with custom config
docker run -d \
  --name synap \
  -p 15500:15500 \
  -p 15501:15501 \
  -p 6379:6379 \
  -v synap-data:/data \
  -v $(pwd)/config.yml:/app/config.yml:ro \
  hivehub/synap:latest

version: '3.8'

services:
  synap:
    image: hivehub/synap:1.2.0
    container_name: synap-production
    ports:
      - "15500:15500"  # HTTP/REST
      - "15501:15501"  # SynapRPC
      - "6379:6379"    # RESP3
    volumes:
      - /var/lib/synap/data:/data
      - /etc/synap/config.yml:/app/config.yml:ro
    environment:
      - SYNAP_SERVER_ADDR=0.0.0.0:15500
      - SYNAP_AUTH_ENABLED=true
      - SYNAP_AUTH_REQUIRE_AUTH=true
      - SYNAP_AUTH_ROOT_USERNAME=${SYNAP_ROOT_USER}
      - SYNAP_AUTH_ROOT_PASSWORD=${SYNAP_ROOT_PASS}
    restart: always
    # The image's built-in HEALTHCHECK already probes /health every 30s using the
    # server binary itself. Override it only with `synap-server --health-check`,
    # never with wget or curl — neither exists in a `scratch` image.
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"
    deploy:
      resources:
        limits:
          cpus: '2'
          memory: 2G
        reservations:
          cpus: '1'
          memory: 1G

# Check logs
docker logs synap

# Check if port is already in use
netstat -tuln | grep 15500

# Verify data directory permissions
ls -la /var/lib/synap/data

# Check memory usage
docker stats synap

# Check disk I/O
docker exec synap df -h /data

# Monitor slow queries (if enabled)
curl http://localhost:15500/slowlog

# Check replication status
curl http://localhost:15500/info | jq .replication

# Check replica connection
docker logs synap-replica | grep replication

# Verify network connectivity
docker exec synap-replica ping synap-master