diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..025b2aa --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# weeb + +weeb is a web microframework for GNU Guile built on [FastCGI](FastCGI). +It aims to provide a comprehensive library for building dynamic websites +in Scheme, while being leaner, faster, and more stable than Guile's +`(web server)` module, and integrating well with common web servers like +[Apache](https://en.wikipedia.org/wiki/Apache_HTTP_Server) and +[nginx](https://en.wikipedia.org/wiki/Nginx). + +API is subject to change. + +## Requirements + +- GNU Guile 3.0 or later with `--enable-regex` +- `libfcgi-2.4.1` +- A web server with FCGI proxy support + +## Building + +There is one small wrapper library for `libfcgi` that needs to be built. +Just run `make`. + +## Using + +```sh +$ spawn-fcgi -s /tmp/guile-fcgi.sock -- ... +``` + +Where `...` is however you would invoke Guile to run your program. + +### Apache Vhost + +```xml +<VirtualHost *:80> + ServerName mysite.local + ProxyPassMatch ^/ unix:/tmp/guile-fcgi.sock|fcgi://localhost/ +</VirtualHost> + +``` |