mongoose/README.md

61 lines
3.0 KiB
Markdown
Raw Normal View History

2013-02-08 18:49:29 +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
2013-01-17 19:07:53 +08:00
make it easy for application and device developers to implement web interface
for their application and devices, and to offer a simple web development
environment.
2013-01-02 07:05:09 +08:00
2013-02-08 18:49:29 +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-17 19:07:53 +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
2013-01-17 19:07:53 +08:00
- 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-17 19:07:53 +08:00
- Simple and clean embedding API,
2013-01-24 07:48:07 +08:00
[mongoose.h](https://github.com/valenok/mongoose/blob/master/mongoose.h).
2013-01-17 19:07:53 +08:00
The source is in single
[mongoose.c](https://github.com/valenok/mongoose/blob/master/mongoose.c) file
2013-01-24 07:42:46 +08:00
to make things easy
2013-01-17 19:07:53 +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-24 07:43:59 +08:00
- HTTP client functionality for embedded usage, capable of
sending arbitrary HTTP/HTTPS requests
2013-02-08 17:17:59 +08:00
- [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
2013-01-17 19:07:53 +08:00
[mongoose-users@google.com](http://groups.google.com/group/mongoose-users)
mailing list.
2012-08-26 05:48:14 +08:00
2013-02-08 18:49:29 +08:00
# Keep Sergey happy
2012-08-26 05:48:14 +08:00
2013-01-24 07:34:01 +08:00
I am Sergey Lyubka, a software engineer from Galway, Ireland. I started
2013-01-24 17:35:11 +08:00
working on Mongoose in 2004, and since then continuously improving it,
2013-02-05 04:18:07 +08:00
investing thousands of hours of work. My other project I'm contributing to the
2013-01-17 19:07:53 +08:00
community for free is
2013-01-02 22:06:28 +08:00
[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,
2013-02-05 04:18:07 +08:00
L.E.Spencer, S.Kotay, B.Fjukstad and 6 others.
2013-02-08 17:17:21 +08:00
Appreciated guys, you keep my brains going! Cash is also appreciated indeed.
Press [<img src="http://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif">](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DGZ2FMP95TAL6)
2013-02-08 16:21:05 +08:00
button to donate. Donation progress: 24/1000 &euro;
(thanks to O.M.Vilhunen, C.Radik, G.Woodcock, M.Szczepkowski)
2013-02-05 04:18:07 +08:00
2013-02-08 16:21:05 +08:00
![Progress](http://chart.googleapis.com/chart?chxr=0,0,1000&chxt=x&chbh=30,0,0&chs=300x35&cht=bhs&chco=90c0f0&chd=t:2.4)