mongoose/README.md

43 lines
2.2 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-02 21:34:07 +08:00
application and devices, and to offer a simple 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)
- Mongoose is crossplatform, and works on Windows, Mac, UNIX, iPhone, Android, and many other platforms
- CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV support
2013-01-02 07:05:09 +08:00
- Lua server pages support (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
2012-09-20 21:17:04 +08: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 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-02 07:05:09 +08:00
See [manual](https://github.com/valenok/mongoose/wiki/Manual) for more information.
2012-08-26 05:48:14 +08: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
-----------------
2013-01-02 07:05:09 +08:00
I have a [books wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority) on
Amazon. If you feel brave, you can buy me a book! Many thanks to all who
already did so: T.Barmann, D.Hughes, J.C.Sloan, R.Romeo and 4 others.
Appreciated, guys, you keep my brains going!