wai-cli: Command line runner for Wai apps (using Warp) with TLS, CGI, socket activation & graceful shutdown

[ library, public-domain, web ] [ Propose Tags ]

Command line runner for Wai apps (using Warp) with support for UNIX domain sockets, TLS (can be turned off with a cabal flag to avoid compiling the TLS library), CGI, socket activation (systemd-compatible, but see https://github.com/myfreeweb/soad for a more interesting (and not linux-only) thing than what systemd does), and graceful shutdown (on TERM signal).


[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.2.0, 0.2.1
Dependencies ansi-terminal, base (>=4.8.0.0 && <5), http-types, iproute, monads-tf, network (>=2.7 && <2.9), options, socket-activation, stm, streaming-commons, unix, wai, wai-extra, wai-handler-fastcgi, warp, warp-tls [details]
License LicenseRef-PublicDomain
Copyright 2017-2019 Greg V <greg@unrelenting.technology>
Author Greg V
Maintainer greg@unrelenting.technology
Revised Revision 1 made by HerbertValerioRiedel at Sat Feb 9 21:42:19 UTC 2019
Category Web
Home page https://github.com/myfreeweb/wai-cli
Source repo head: git clone git://github.com/myfreeweb/wai-cli.git
Uploaded by myfreeweb at Sat Feb 9 18:56:08 UTC 2019
Distributions LTSHaskell:0.1.1, NixOS:0.2.1, Stackage:0.2.1
Downloads 995 total (88 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-02-09 [all 2 reports]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
tls

Include warp-tls

EnabledAutomatic
fastcgi

Include wai-handler-fastcgi

DisabledAutomatic
unixsockets

Enable Unix sockets

EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for wai-cli-0.2.1

[back to package description]

wai-cli Hackage Build Status unlicense

A command line runner for Wai apps (using Warp) with support for:

  • --protocol http --port 8000 TCP sockets
  • --protocol unix --socket /var/run/app/sock UNIX domain sockets
  • --protocol cgi running as a CGI app (the original serverless lambda functions from the 90s)
  • --protocol fastcgi running as a FastCGI app (OPTIONAL! You need to build with the fastcgi cabal flag and you need to have libfcgi (e.g. fcgi-devkit package on FreeBSD) installed)
  • --protocol activate socket activation (systemd-compatible, but not restricted to systemd in any way. see soad for an interesting use of (de)activation!)
  • --protocol (http+tls|unix+tls|activate+tls) --tlskey key.pem --tlscert cert.pem TLS (can be turned off with a cabal flag to avoid compiling the TLS library)
  • --graceful (none|serve-normally|serve-503) graceful shutdown (on TERM signal)
  • --devlogging development logging (from wai-extra)
  • printing a pretty and colorful run message (e.g. Running on http port 3000 with 4 CPUs) (you can replace it with your own, or with nothing)

Extracted from sweetroll and microformats2-parser's demo web app.

Now used in the magicbane framework (which was also extracted from sweetroll).

Usage

Add a dependency on wai-cli and write something like this:

{-# LANGUAGE OverloadedStrings #-}
import Web.Scotty
import Network.Wai.Cli
import Data.Monoid (mconcat)

app = scottyApp $ do
  get "/:word" $ do
    beam <- param "word"
    html $ mconcat ["<h1>Scotty, ", beam, " me up!</h1>"]

main = defWaiMain =<< app

Want to use command line args for your application-specific settings? Don't. Use environment variables instead. Possibly with dotenv to load some of them from a file. envy is a really awesome way to read them.

License

This is free and unencumbered software released into the public domain.
For more information, please refer to the UNLICENSE file or unlicense.org.