Skip to content

Main Configuration

The main configuration file (config.yaml) controls the global settings of the Apify instance.

Structure

# Global datasource configuration
datasource:
  sqlite1:
    driver: sqlite
    database: ./apify.sqlite
    max_pool_size: 5

# Global consumer (API key) configuration
auth:
  - name: default-api-keys
    type: api-key
    enabled: true
    config:
      source: header
      key_name: X-Api-Key
      consumers:
        - name: default
          keys:
            - dev-key-123

# HTTP listeners
listeners:
  - port: 3000
    ip: 0.0.0.0
    protocol: HTTP
    apis:
      - path: openapi/users.yaml
        datasource: sqlite1

Sections

Datasource

Defines database connections available to APIs.

Auth

Configures global authentication providers.

Listeners

Configures HTTP servers and maps APIs to them.