mongoose/README.md

43 lines
2.4 KiB
Markdown
Raw Normal View History

2013-01-02 07:05:09 +08:00
Project Mission
---------------
2012-08-26 05:48:14 +08:00
2013-01-02 21:32:07 +08:00
Project mission is to provide simple, functional, embeddable web server to
make it easy for application and device developers to implement web interface for their
2013-01-05 05:25:58 +08:00
application and devices, and to offer a simple web development environment.
2013-01-02 07:05:09 +08:00
Overview
2012-08-26 05:48:14 +08:00
--------
2013-01-02 07:05:09 +08:00
To accomplish it's mission, Mongoose keeps balance on functionality and
simplicity by carefully selected list of features:
2013-01-02 21:35:30 +08:00
- Liberal, commercial-friendly [MIT license](http://en.wikipedia.org/wiki/MIT_License)
2013-01-02 21:48:40 +08:00
- Works on Windows, Mac, UNIX, iPhone, Android, and many other platforms
- Support for CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV
- Lua server pages (PHP-like functionality using Lua), see [page.lp](https://github.com/valenok/mongoose/blob/master/test/page.lp)
2012-12-24 22:09:48 +08:00
- Resumed download, URL rewrite, IP-based ACL, Windows service
- Excluding files from serving by URI pattern (file blacklist)
2012-09-23 22:06:09 +08:00
- Download speed limit based on client subnet or URI pattern
2012-12-24 22:09:48 +08:00
- Small footprint: executable size is 50 kB on Linux 2.6 i386 system
2013-01-02 07:05:09 +08:00
- 130 kilobytes Windows executable with all of the above and no dependencies
2013-01-02 21:48:40 +08:00
- Simple and clean embedding 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 21:17:28 +08: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)
2013-01-04 06:39:48 +08:00
- Extensive documentation in form of [User Manual](https://github.com/valenok/mongoose/blob/master/UserManual.md)
2013-01-02 07:05:09 +08:00
2013-01-02 21:48:40 +08:00
Questions can be asked at
[mongoose-users@google.com](http://groups.google.com/group/mongoose-users) mailing list.
2012-08-26 05:48:14 +08:00
Keep Sergey happy
-----------------
2013-01-02 22:06:28 +08:00
Since 2004, Mongoose is being constantly improved by me, Sergey Lyubka, a software engineer
from Galway, Ireland. My other software I give to the community for free is
[Super Light Regular Expression library](http://code.google.com/p/slre).
2013-01-02 21:50:27 +08:00
If you feel grateful for the stuff I've done, you can buy me a book from my
2013-01-17 18:59:42 +08:00
[Amazon wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority). Many thanks
to all who already did so: T.Barmann, D.Hughes, J.C.Sloan, R.Romeo,
L.E.Spencer, and 4 others. Appreciated guys, you keep my brains going!