File System HTTP Server

Easily deploy a robust HTTP(S) server from contents on your file system.

Features include:

• Content Security Policy (CSP)
• Single page applications (SPA); React, Svelte, Vue, etc.
• OpenTelemetry monitoring
• Error reporting (using Sentry)
• TLS
• Gzip compression
• Cache
• Robust logging
• PROXY protocol detection
• Flexible CORS capabilities

Quick start

Run a server instance on port 8080 with default settings from contents on your /var/www local directory.

serve run -p 8080 /var/www

Configuration

You can adjust the settings available using a YAML configuration file. The file is loaded automatically if available at:

• pwd/config.yaml
• ${HOME}/.config.yaml
• /etc/serve/config.yaml

otel:
  service_name: "serve"
  service_version: "0.1.0"
  collector: "" # OTEL collector endpoint, if not provided output will be discarded
  attributes:
    environment: dev
    host: "my-local-host"
  sentry:
    dsn: "" # Sentry DNS, if not provided output will be discarded
    environment: dev
server:
  port: 9090
  cache: 3600
  proxy_protocol: false
  tls:
    enabled: false
    system_ca: true
    cert: /etc/serve/tls/tls.crt
    key: /etc/serve/tls/tls.key
    custom_ca: []
  csp:
    enabled: true
    allow_eval: false
  middleware:
    gzip: 7
    metadata:
      headers:
        - authorization
        - x-api-key
    otel:
      enabled: true
      trace_header: "x-request-id"
    cors:
      max_age: 300
      options_status_code: 200
      allow_credentials: true
      ignore_options: false
      allowed_headers:
        - authorization
        - content-type
        - x-api-key
      allowed_methods:
        - get
        - head
        - post
        - options
      allowed_origins:
        - "*"
      exposed_headers:
        - authorization
        - x-api-key