example.yaml

# Validate this file by running `bin/sphinxd --validate /path/to/conf`
proxy:
  handler: http             # can be {http,httplogger}
  host: http://httpbin.org  # URI for the http(s) backend we are proxying to
  listen: :6634             # bind to host:port. default: height of the Great Sphinx of Giza
  allow-on-error: Yes       # become passive proxy if error detected? (optional, default=No)

storage:
  type: memory      # must be one of {redis, dynamodb, memory}
  host: localhost   # redis hostname. required for redis
  port: 6379        # redis port.     required for redis
  table: table      # table name.     required for dynamodb
  region: us-west-1 # table region.   required for dynamodb

health-check:
  enabled: true
  port: 60002
  endpoint: "/health/check"

limits:
  bearer-special:
    interval: 15  # in seconds
    max: 200      # number of requests allowed in interval
    keys:
      # buckets are keyed on concatnated values of these params
      headers:
        encrypt: "the_salt"
        names:
          - "Authorization"
      ip: ""      # ip keys require no configuration
      global: ""  # global keys have NO affect when used with other key types
    matches:
      # both headers and paths matches should be true for limit to apply
      headers:
        match_any:
          - name: "Authorization"
            match: "Bearer.*"
          - name: "X-Forwarded-For"
      paths:
        match_any:
          - "/special/resources/.*"

  global-limit:
    interval: 15
    max: 500
    keys:
      global: ""  # global key has no configuration
    matches:
      paths:
        match_any:
          - "/generic/resources/.*"

  basic-simple:
    interval: 15
    max: 200
    keys:
      headers:
        names:
          - "Authorization"
    matches:
      headers:
        match_any:
          - name: "Authorization"
            match: "Basic.*"
    excludes:
       # excludes are evaluated before matches and requests that
       # match excludes are ignored
      paths:
        match_any:
          - "/special/resources/.*"

  basic-special:
    interval: 15
    max: 200
    keys:
      headers:
        names:
          - "Authorization"
    matches:
      paths:
        match_any:
          - "/special/resources/.*"
      headers:
        match_any:
          - name: "Authorization"
            match: "Basic.*"

  bearer-simple:
    interval: 15
    max: 200
    keys:
      headers:
        names:
          - "Authorization"
    matches:
      headers:
        match_any:
          - name: "Authorization"
            match: bearer
    excludes:
      paths:
        match_any:
          - "/special/resources/.*"