Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 1.67 KB

README.md

File metadata and controls

83 lines (66 loc) · 1.67 KB
Raw

Carnivore HTTP

Provides HTTP Carnivore::Source

Usage

HTTP

All requests are processed via single source

require 'carnivore'
require 'carnivore-http'

Carnivore.configure do
  source = Carnivore::Source.build(
    :type => :http,
    :args => {
      :port => 8080
    }
  )
end

HTTP with configured end points

All point builder definitions are hooked into source:

require 'carnivore'
require 'carnivore-http'

Carnivore.configure do
  source = Carnivore::Source.build(
    :type => :http_endpoints,
    :args => {
      :auto_respond => false
    }
  )
end.start!

HTTP paths

Multiple sources share same listener, and incoming messages are matched based on HTTP method + path

require 'carnivore'
require 'carnivore-http'

Carnivore.configure do
  source = Carnivore::Source.build(
    :type => :http_paths,
    :args => {
      :port => 8080,
      :path => '/test',
      :method => 'get'
    }
  )
end

Available options for :args

  • :bind address to bind
  • :port port to listen
  • :auto_respond confirm request immediately
  • :ssl ssl configuration
    • :cert path to cert file
    • :key path to key file
  • :authorization access restrictors
    • :allowed_origins list of IP or IP ranges
    • :htpasswd htpasswd for authentication
    • :credentials username/password key pair for authentication
    • :valid_on 'any' match any restrictor, 'all' match all restrictors
  • :endpoint specific uri to transmit (can include auth + path)
  • :method HTTP method for transmission

Info