Logo
stable

The Project

  • Quick Start Guide
    • Scenario
    • Limitations and Constraints
    • The Desired Solution
      • Accessing via SSH to External Host
      • Develop and Deploy a Custom Solution
      • Using Kapow! (spoiler: it’s the winner!)
    • Using Kapow!
      • Install Kapow!
      • Write an Init Program ping-route
      • Launch the Service
      • Consume the Service
      • Under the Hood
  • Security Concerns Working with Parameters
    • Parameter Injection Attacks
    • Parameter Mangling Attacks
  • Installing Kapow!
    • Download and Install a Binary
      • GNU/Linux
      • macOS
      • Windows®
    • Install the package with go get
    • Include Kapow! in your Container Image

Tutorial

  • Kapow! Tutorial
  • Your First Day at Work
  • Let’s Backup that Database!
  • What have we done?
  • We need to filter
  • I Need my Report!
  • Sharing the Stats
  • Securing the server

Usage Examples

  • Working with Init Scripts
    • Starting Kapow! using an init script
    • Writing Multiline Routes
    • Keeping Things Tidy
    • Debugging Init Programs/Scripts
  • Managing Routes
    • Adding New Routes
      • GET route
      • POST route
      • Capturing Parts of the URL
    • Listing Routes
    • Deleting Routes
  • Handling HTTP Requests
    • Add or Modify an HTTP Header
    • Upload Files
      • Example #1
      • Example #2
    • Sending HTTP error codes
    • How to redirect using HTTP
    • Manage Cookies
  • Using JSON
    • Modify JSON by Using Shell Commands
      • Example #1
      • Example #2
  • Shell Tricks
    • How to Execute Two Processes in Parallel
    • Script debugging
  • Using HTTPS and mTLS with Kapow!
    • Using Kapow! built in capabilities
      • Enabling HTTPS
      • Enabling mTLS
    • Kapow! Behind a Reverse Proxy
      • Caddy
      • HAProxy
      • nginx

Concepts

  • Kapow! HTTP Interfaces
    • HTTP User Interface
    • HTTPS Control Interface
    • HTTP Data Interface
  • Philosophy
    • Single Static Binary
    • Shell Agnostic
    • Not a Silver Bullet
    • Interoperability over Performance
  • Request Life Cycle
    • 1. request
    • 2. spawn
    • 3. kapow set /response/body banana
    • 4. exit
    • 5. response
  • The Kapow! Resource Tree
    • Overview
    • Resources
      • /request/method Resource
      • /request/host Resource
      • /request/version Resource
      • /request/path Resource
      • /request/remote Resource
      • /request/matches/<name> Resource
      • /request/params/<name> Resource
      • /request/headers/<name> Resource
      • /request/cookies/<name> Resource
      • /request/form/<name> Resource
      • /request/files/<name>/filename Resource
      • /request/files/<name>/content Resource
      • /request/body Resource
      • /ssl/client/i/dn Resource
      • /route/id Resource
      • /server/log/<prefix>
      • /response/status Resource
      • /response/headers/<name> Resource
      • /response/cookies/<name> Resource
      • /response/body Resource
  • Route Matching
  • Routes
    • Elements
      • id Route Element
      • method Route Element
      • url_pattern Route Element
      • entrypoint Route Element
      • command Route Element
    • Matching Algorithm
Kapow!
  • Docs »
  • Search
  • Edit on GitHub

© Copyright 2019, BBVA Innovation Labs Revision 7ac53758.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
v0.7.1
v0.7.1-rc6
v0.7.1-rc5
v0.7.1-rc4
v0.7.1-rc3
v0.7.1-rc2
v0.7.1-rc1
v0.7.0
v0.6.0
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.0
v0.3.0
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.