Convoy Configuration Files

convoy-dependencies.json

{
  "environment": "development",
  "multiple_tenants": true,
  "database": {
    "type": "mongodb",
    "dsn": "<insert-mongodb-dsn>"
  },
  "queue": {
    "type": "redis",
    "redis": {
      "dsn": "<insert-redis-dsn>"
    }
  },
  "server": {
    "http": {
      "ssl": true,
      "ssl_cert_file": "/root/cert.pem",
      "ssl_key_file": "/root/cert.key",
      "port": 443
    }
  },
  "group": {
    "signature": {
      "header": "X-Convoy-Signature",
      "hash": "SHA256"
    },
    "strategy": {
      "type": "default",
      "default": {
        "intervalSeconds": 20,
        "retryLimit": 3
      }
    }
  },
  "smtp": {
    "provider": "sendgrid",
    "url": "smtp.sendgrid.net",
    "port": 2525,
    "username": "apikey",
    "password": "<api-key-from-sendgrid>",
    "from": "support@frain.dev"
  },
  "disable_endpoint": false,
  "auth": {
    "require_auth": true,
    "file": {
      "basic": [
        {
          "username": "default",
          "password": "default",
          "role": {
            "type": "super_user"
          }
        }
      ]
    },
    "native": {
      "enabled": true
    }
  }
}

convoy-docker.yml

version: "3"

services:
  web:
    image: ghcr.io/frain-dev/convoy:v0.4.10
    ports:
      - 5005:5005
    restart: on-failure
    volumes:
      - ./convoy-docker.json:/convoy.json
    depends_on:
      - mongodb
      - redis_server

  mongodb:
    image: mongo:latest
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: rootpassword
    volumes:
      - ./data/mongo:/data/db

  redis_server:
    image: redis:alpine
    ports:
      - "8379:6379"

convoy.json

{
  "environment": "development",
  "multiple_tenants": false,
  "database": {
    "type": "in-memory",
    "dsn": "db.db"
  },
  "queue": {
    "type": "in-memory"
  },
  "server": {
    "http": {
      "ssl": false,
      "ssl_cert_file": "",
      "ssl_key_file": "",
      "port": 5006
    }
  },
  "group": {
    "signature": {
      "header": "X-Convoy-Signature",
      "hash": "SHA256"
    },
    "strategy": {
      "type": "default",
      "default": {
        "intervalSeconds": 20,
        "retryLimit": 3
      }
    }
  },
  "smtp": {
    "provider": "sendgrid",
    "url": "smtp.sendgrid.net",
    "port": 2525,
    "username": "apikey",
    "password": "<api-key-from-sendgrid>",
    "from": "support@frain.dev"
  },
  "disable_endpoint": false,
  "auth": {
    "require_auth": true,
    "file": {
      "basic": [
        {
          "username": "default",
          "password": "default",
          "role": {
            "type": "super_user"
          }
        }
      ],
      "api_key": [
        {
          "api_key": "<insert-api-key>",
          "role": {
            "type": "super_user"
          }
        }
      ]
    },
    "native": {
      "enabled": true
    }
  }
}