WebServerConfig

Web server configuration

The configuration can be optionally loaded from Akka's application.conf file.

The following example configuration file:

  akka-config-example {
    server-name=AkkaConfigExample
    hostname=localhost
    port=9000

    # Optional web log. If not supplied, web server activity logging is turned off.
    web-log {

      # Optional path of actor to which web log events will be sent for writing. If not specified, the default
      # web log writer will be created
      custom-actor-path = "akka://my-system/user/web-log-writer"

      # Optional web log format for the default web log writer: Common, Combined or Extended.
      # If no specified, Common is the default.
      format = Common
    }

    # Optional SSL. If not supplied, ssl is turned off.
    ssl {

      # Path to key store (server cert.)
      key-store-file=/tmp/ks.dat

      # Password to key store
      key-store-password=kspwd

      # Optional path to trust store (client cert.)
      trust-store-file=/tmp/ts.dat

      # Optional password to trust store
      trust-store-password=tspwd
    }

    # Optional HTTP protocol configuration. If not supplied, defaults are used.
    http {

      # Maximum size of HTTP request. Defaults to 4MB.
      max-length-in-mb=4

      # Maximum length of the HTTP initial line. Defaults to 4096 bytes (4K).
      max-initial-line-length=4096

      # Maximum size of HTTP headers. Defaults to 8192 bytes (8K).
      max-header-size-in-bytes=8192

      # Maximum size of HTTP chunks. Defaults to 8192 bytes (8K).
      max-chunk-size-in-bytes=8192

      # Flag to indicate if HTTP chunk requests should be aggregated and presented
      # as a single HTTP request. Defaults to true.
      aggregate-chunks=true

      # Content under this size is not compressed. Defaults to 1024 bytes (1K).
      # Set to -1 to turn off compression; or 0 to compress all content.
      min-compressible-content-size-in-bytes=1024

      # Content over this size is not compressed. Defaults to 1MB
      max-compressible-content-size-in-bytes=60

      # Only content with the specified MIME type will be compressed
      compressible-content-types=[
        "text/plain", "text/html", "text/xml", "text/css",
        "application/xml", "application/xhtml+xml", "application/rss+xml",
        "application/json", "application/jsonml+json",
        "application/javascript", "application/x-javascript"]

      # Enable SPDY protocol or not. Defaults to `false`. If `true`, you must also enable SSL.
      spdy=false
    }

    # Optional TCP protocol configuration. If not supplied, defaults are used.
    tcp {

      # Disable Nagle's algorithm. Defaults to `true` if not supplied.
      no-delay=

      # Set a hint the size of the underlying buffers for outgoing network I/O.
      send-buffer-size=

      # Get the size of the buffer actually used by the platform when receiving in data on this socket
      receive-buffer-size=

      # Turn on socket keep-alive. `true` or `false`.
      keep-alive=

      # Enable reuse address for a socket and not throw an "already bind exception". `true` or `false`.
      reuse-address=

      # Specify a linger-on-close timeout.
      so-linger=

      # Sets the type-of-service or traffic class field in the IP header for a TCP or UDP socket.
      traffic-class=

      # The number of requests that can be queued.
      accept-backlog=
    }
  }

can be loaded as follows:

  object MyWebServerConfig extends ExtensionId[WebServerConfig] with ExtensionIdProvider {
    override def lookup = MyWebServerConfig
    override def createExtension(system: ExtendedActorSystem) =
      new WebServerConfig(system.settings.config, "akka-config-example")
  }

  val myWebServerConfig = MyWebServerConfig(actorSystem)
  val webServer = new WebServer(myWebServerConfig, routes)
  webServer.start()