mongoose/README.md

37 lines
2.2 KiB
Markdown
Raw Normal View History

2012-08-25 22:48:14 +01:00
Overview
--------
Mongoose is easy to use web server. It also can be used as embedded web server library to provide web interface to applications.
2012-09-24 09:04:28 +01:00
Mongoose executable does not depend on any external library or configuration. If it is copied to any directory and launched from there, it starts to serve that directory on port 8080 (so to access files, go to http://localhost:8080). If some additional config is required - for example, different listening port or IP-based access control, that can be done via command line flags or configuration file, which should be created in the same directory where mongoose itself lives. This makes Mongoose perfect for all sorts of demos, quick tests, file sharing, and Web programming.
2012-08-25 22:48:14 +01:00
Features
--------
- Crossplatform - works on Windows, MacOS and most flavors of UNIX
- CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV support
2012-12-21 21:47:14 +00:00
- Lua server pages
- Resumed download, URL rewrite support
2012-08-25 22:48:14 +01:00
- IP-based ACL, Windows service, GET, POST, HEAD, PUT, DELETE methods
2012-09-23 15:06:09 +01:00
- Excluding files from serving by URI pattern
- Download speed limit based on client subnet or URI pattern
2012-08-25 22:48:14 +01:00
- Small footprint: executable size is 40 kB on Linux 2.6 i386 system
2012-09-20 14:17:04 +01:00
- Embeddable with simple and clean API ([mongoose.h](https://github.com/valenok/mongoose/blob/master/mongoose.h)). The source is in single [mongoose.c](https://github.com/valenok/mongoose/blob/master/mongoose.c) file to make things easy.
2012-09-20 14:17:28 +01:00
- Embedding examples: [hello.c](https://github.com/valenok/mongoose/blob/master/examples/hello.c), [post.c](https://github.com/valenok/mongoose/blob/master/examples/post.c), [upload.c](https://github.com/valenok/mongoose/blob/master/examples/upload.c), [websocket.c](https://github.com/valenok/mongoose/blob/master/examples/websocket.c)
2012-08-25 22:48:14 +01:00
- Python and C# bindings
2012-12-21 21:47:14 +00:00
- Super-liberal MIT license, great for commercial users!
2012-08-25 22:48:14 +01:00
Mailing list
------------
You can read it online, subscribe to, or send a message at [mongoose-users](http://groups.google.com/group/mongoose-users).
Keep Sergey happy
-----------------
I have a [books wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority) on Amazon. If you feel brave, you can buy me a book!
2012-12-24 11:09:44 +00:00
Many thanks to all who already did so: T.Barmann, D.Hughes, J.C.Sloan and 4 others. Appreciated, guys, you keep my brains going!