Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fukamachi/woo
A fast non-blocking HTTP server on top of libev
https://github.com/fukamachi/woo
common-lisp webserver
Last synced: 8 days ago
JSON representation
A fast non-blocking HTTP server on top of libev
- Host: GitHub
- URL: https://github.com/fukamachi/woo
- Owner: fukamachi
- License: mit
- Created: 2014-10-14T12:30:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T01:48:29.000Z (2 months ago)
- Last Synced: 2024-10-16T19:15:44.313Z (23 days ago)
- Topics: common-lisp, webserver
- Language: Common Lisp
- Homepage: http://ultra.wikia.com/wiki/Woo_(kaiju)
- Size: 1.8 MB
- Stars: 1,286
- Watchers: 63
- Forks: 97
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
- curated-awesome-cl - woo - A fast non-blocking HTTP server on top of libev. [MIT][200]. (REPLs ##)
README
# Woo
[](https://github.com/fukamachi/woo/actions/workflows/ci.yml)
Woo is a fast non-blocking HTTP server built on top of [libev](http://software.schmorp.de/pkg/libev.html). Although Woo is written in Common Lisp, it aims to be the fastest web server written in any programming language.
## Warning
This software is still BETA quality.
## How fast?
See [benchmark.md](benchmark.md) for the detail.
## Usage
Use `clack:clackup` or `woo:run` to start a web server. The first argument is a Lack "app". See [Lack's README](https://github.com/fukamachi/lack#readme) for instruction on how to build it.
Remember to pass ":debug nil" to turn off the debugger mode on production environments (it's on by default). Otherwise, your server will go down on internal errors.
### Start a server
```common-lisp
(ql:quickload :woo)
(woo:run
(lambda (env)
(declare (ignore env))
'(200 (:content-type "text/plain") ("Hello, World"))))
```
### Start with Clack
```common-lisp
(ql:quickload :clack)
(clack:clackup
(lambda (env)
(declare (ignore env))
'(200 (:content-type "text/plain") ("Hello, World")))
:server :woo
:use-default-middlewares nil)
```
### Cluster
```common-lisp
(woo:run
(lambda (env)
(declare (ignore env))
'(200 (:content-type "text/plain") ("Hello, World")))
:worker-num 4)
```
### SSL Support
Use SSL key arguments of `woo:run` or `clack:clackup`.
```commonlisp
(woo:run app
:ssl-cert-file #P"path/to/cert.pem"
:ssl-key-file #P"path/to/key.pem"
:ssl-key-password "password")
(clack:clackup app
:ssl-cert-file #P"path/to/cert.pem"
:ssl-key-file #P"path/to/key.pem"
:ssl-key-password "password")
```
To disable the HTTPS support to omit a dependency on CL+SSL, add `woo-no-ssl` to `cl:*features*`.
## Signal handling
When the master process gets these signals, it kills worker processes and quits afterwards.
- QUIT: graceful shutdown, waits for all requests are finished.
- INT/TERM: shutdown immediately.
## Benchmarks
See [benchmark.md](benchmark.md).
## Installation
### Requirements
* UNIX (GNU Linux, Mac, \*BSD)
* SBCL
* [libev](http://libev.schmorp.de)
* OpenSSL or LibreSSL (Optional)
* To turn off SSL, add `:woo-no-ssl` to `cl:*features*` before loading Woo.
### Installing via Quicklisp
```common-lisp
(ql:quickload :woo)
```
## Docker example
* [Dockerfile](https://github.com/quickdocs/quickdocs-api/blob/master/docker/Dockerfile.production) for Quickdocs's API server.
## See Also
* [Lack](https://github.com/fukamachi/lack): Building a web application
* [Clack](https://github.com/fukamachi/clack): An abstraction layer for web servers
* [libev](http://software.schmorp.de/pkg/libev.html)
## Author
* Eitaro Fukamachi ([email protected])
## Copyright
Copyright (c) 2014 Eitaro Fukamachi & [contributors](https://github.com/fukamachi/woo/graphs/contributors)
## License
Licensed under the MIT License.