mongoose/README.md

74 lines
3.4 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-07-22 16:54:02 +08:00
Project mission is to provide easy to use, powerful, embeddable web server.
2013-01-02 07:05:09 +08:00
2013-08-20 23:26:33 +08:00
# Downloads
Sources, binaries and bundles are available for download at
2013-09-08 03:20:11 +08:00
[mongoose downloads](http://cesanta.com/downloads.html).
2013-08-20 23:26:33 +08:00
2013-02-08 18:49:29 +08:00
# Overview
2012-08-26 05:48:14 +08:00
2013-07-22 16:54:02 +08:00
Mongoose keeps the balance between functionality and
2013-01-02 07:05:09 +08:00
simplicity by carefully selected list of features:
2013-01-02 21:48:40 +08:00
- Works on Windows, Mac, UNIX, iPhone, Android, and many other platforms
2013-07-22 16:27:47 +08:00
- Scripting and database support (Lua Server Pages + Sqlite, see
2013-09-17 05:45:19 +08:00
[page.lp](https://github.com/cesanta/mongoose/blob/master/test/page.lp) ),
2013-07-22 16:27:47 +08:00
which provides ready to go, powerful web development platform in
one single-click executable with **no dependencies**: forget LAMP!
2013-07-22 16:30:01 +08:00
- Support for CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV
- Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service
2012-09-23 22:06:09 +08:00
- Download speed limit based on client subnet or URI pattern
2013-01-17 19:07:53 +08:00
- Simple and clean embedding API,
2013-09-17 05:45:19 +08:00
[mongoose.h](https://github.com/cesanta/mongoose/blob/master/mongoose.h).
2013-01-17 19:07:53 +08:00
The source is in single
2013-09-17 05:45:19 +08:00
[mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file
2013-07-22 16:24:17 +08:00
to make things easy. Embedding examples:
2013-09-17 05:45:19 +08:00
[hello.c](https://github.com/cesanta/mongoose/blob/master/examples/hello.c),
[post.c](https://github.com/cesanta/mongoose/blob/master/examples/post.c),
[upload.c](https://github.com/cesanta/mongoose/blob/master/examples/upload.c),
[websocket.c](https://github.com/cesanta/mongoose/blob/master/examples/websocket.c)
2013-07-22 16:24:17 +08:00
- HTTP client capable of sending arbitrary HTTP/HTTPS requests
2013-09-20 20:27:48 +08:00
- [User documentaion](http://cesanta.com/docs.html)
2013-01-02 07:05:09 +08:00
2013-07-21 17:09:47 +08:00
Note that Windows and MacOS binaries have following 3rd party software
compiled in:
<a href="http://wolfssl.com">WolfSSL lightweight SSL library</a>,
<a href="http://sqlite.org">SQLite embedded database</a>,
<a href="http://lua.org">Lua embedded scripting engine</a>.
2013-01-02 21:48:40 +08:00
Questions can be asked at
[mongoose-users@googlegroups.com](http://groups.google.com/group/mongoose-users)
2013-01-17 19:07:53 +08:00
mailing list.
2012-08-26 05:48:14 +08:00
# Acknowledgements
Author is grateful to the following people who made their contribution:
Arnout Vandecappelle, Benoît Amiaux, Boris Pek, Cody Hanson, Colin Leitner,
Daniel Oaks, Eric Bakan, Erik Oomen, Filipp Kovalev, Ger Hobbelt,
Hendrik Polczynski, Igor Okulist, Jay, Joe Mucchiello, John Safranek,
José Miguel Gonçalves, Shueng Chuan, Katerina Blinova, Konstantin Sorokin,
Marin Atanasov, Matt Healy, Mitch Hendrickson, Nigel Stewart, Pavel Khlebovich,
Sebastian Reinhard, Stefan Doehla, abadc0de, nullable.type,
T.Barmann, D.Hughes, J.C.Sloan, R.Romeo, L.E.Spencer, S.Kotay, R.M.Shorter,
W.Mar, J.Wilander, Santa from Memphis, S.Davies, C.Beck,
O.M.Vilhunen, C.Radik, G.Woodcock, M.Szczepkowski,
Eternal Lands Dev Team, T.Tollet, C.Tangerino, G.Karsai, A.Bourgett,
C.Blakemore, D.Fonaryov, T.Andrle, O.IJsselmuiden, R.Womack, M.Tomlinson,
A.Slåttå, L.Farrell, J.D.P.Ballestero, V.Albaev, B.Harker, T.Scheffel, H.Klein,
R.Merit, T.Bennett, H.Solis, A.Zincenko, M.S., S.Krul, K.Cooke, S.McCallum,
F.Morenius, and 10 others.
2012-08-26 05:48:14 +08:00
2013-08-16 18:28:50 +08:00
# License
2012-08-26 05:48:14 +08:00
2013-08-16 18:28:50 +08:00
Mongoose is dual-licensed. It is available under the terms of
[GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) license
license for free, or under the terms of standard commercial license provided
by [Cesanta Software](http://cesanta.com).
[Super Light Regular Expression library](https://github.com/cesanta/slre) is
another project by Cesanta Software, developed with the same philosophy
2013-08-16 18:28:50 +08:00
of functionality and simplicity.