mongoose/README.md

# <img src="http://cesanta.com/images/mongoose_logo.png" width="64" height="64"> Mongoose Web Server

Mongoose is the most easy to use web server on the planet. A web server of choice for Web developers (PHP, Ruby, Python, etc) and Web designers.

Mongoose is built on top of Libmongoose embedded library, which can turn
anything into a web server in 5 minutes worth of effort and few lines of code.
Libmongoose is used to serve Web GUI on embedded devices, implement RESTful
services, RPC frameworks (e.g. JSON-RPC), handle telemetry data exchange, and
perform many other tasks in various different industries including aerospace,
manufacturing, finance, research, automotive, gaming, IT.


   * [Mailing list](http://groups.google.com/group/mongoose-users)
   * [Downloads](http://cesanta.com/mongoose.shtml)
   * [Documentation](http://cesanta.com/docs.shtml)

Check out our [embedded multi-protocol library](https://github.com/cesanta/fossa) with TCP,UDP,HTTP,Websocket,MQTT,DNS support - designed for Internet Of Things!

# Features

- Works on Windows, Mac, UNIX/Linux, iPhone, Android eCos, QNX
and many other platforms
- CGI, SSI, SSL, Digest auth, Websocket, WEbDAV, Resumed download,
  URL rewrite, file blacklist
- Custom error pages, Virtual hosts, IP-based ACL, Windows service,
  HTTP/HTTPS client
- Simple and clean
  [embedding API](https://github.com/cesanta/mongoose/blob/master/mongoose.h).
  The source is in single
  [mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file
  to make embedding easy
- Extremely lightweight, has a core of under 40kB and tiny runtime footprint
- Asynchronous, non-blocking core supporting single- or multi-threaded usage
- On the market since 2004 with over 1 million cumulative downloads
- Stable, mature and tested, has several man-years invested
  in continuous improvement and refinement

# Screenshots

Download, double-click to start, run browser -- that's all!

![shot1](http://cesanta.com/images/tut_sharing/tut1.png)
![shot2](http://cesanta.com/images/tut_sharing/tut2.png)

![shot3](http://cesanta.com/images/tut_sharing/tut3.png)
![shot4](http://cesanta.com/images/tut_sharing/tut4.png)

# Acknowledgements

Mongoose made better thanks to the contribution of following people:

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.

# Licensing

Mongoose is released under commercial and
[GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) open
source licenses. The GPLv2 open source License does not generally permit
incorporating this software into non-open source programs. 
For those customers who do not wish to comply with the GPLv2 open
source license requirements,
[Cesanta Software](http://cesanta.com) offers a full,
royalty-free commercial license and professional support
without any of the GPL restrictions.

# Other products by Cesanta Software: simple and effective

- [SSL Wrapper](https://github.com/cesanta/ssl_wrapper) - application to
  secure network communications
- [Frozen](https://github.com/cesanta/frozen) - JSON parser and generator
- [SLRE](https://github.com/cesanta/slre) - Super Light Regular Expression
  library
- [Net Skeleton](https://github.com/cesanta/net_skeleton) - framework for
  building network applications
- [SLDR](https://github.com/cesanta/sldr) - Super Light DNS Resolver
Added logo 2014-03-11 06:13:59 +00:00			`# <img src="http://cesanta.com/images/mongoose_logo.png" width="64" height="64"> Mongoose Web Server`
Initial version of readme 2012-08-25 22:48:14 +01:00
README message changed 2014-04-09 18:10:49 +01:00			`Mongoose is the most easy to use web server on the planet. A web server of choice for Web developers (PHP, Ruby, Python, etc) and Web designers.`

			`Mongoose is built on top of Libmongoose embedded library, which can turn`
			`anything into a web server in 5 minutes worth of effort and few lines of code.`
			`Libmongoose is used to serve Web GUI on embedded devices, implement RESTful`
			`services, RPC frameworks (e.g. JSON-RPC), handle telemetry data exchange, and`
			`perform many other tasks in various different industries including aerospace,`
			`manufacturing, finance, research, automotive, gaming, IT.`


Docs updated 2014-01-04 20:12:07 +00:00			`* [Mailing list](http://groups.google.com/group/mongoose-users)`
README message changed 2014-04-09 18:10:49 +01:00			`* [Downloads](http://cesanta.com/mongoose.shtml)`
			`* [Documentation](http://cesanta.com/docs.shtml)`
Mission statement 2013-01-01 23:05:09 +00:00
Update README.md 2014-11-13 13:48:43 +00:00			`Check out our [embedded multi-protocol library](https://github.com/cesanta/fossa) with TCP,UDP,HTTP,Websocket,MQTT,DNS support - designed for Internet Of Things!`

Docs updated 2014-01-04 20:12:07 +00:00			`# Features`
Mission statement 2013-01-01 23:05:09 +00:00
README message changed 2014-04-09 18:10:49 +01:00			`- Works on Windows, Mac, UNIX/Linux, iPhone, Android eCos, QNX`
			`and many other platforms`
			`- CGI, SSI, SSL, Digest auth, Websocket, WEbDAV, Resumed download,`
			`URL rewrite, file blacklist`
			`- Custom error pages, Virtual hosts, IP-based ACL, Windows service,`
			`HTTP/HTTPS client`
Minor wording changes for feeatures 2013-12-27 18:32:24 +00:00			`- Simple and clean`
			`[embedding API](https://github.com/cesanta/mongoose/blob/master/mongoose.h).`
Changed README 2013-01-17 11:07:53 +00:00			`The source is in single`
valenok -> cesanta 2013-09-16 22:45:19 +01:00			`[mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file`
Docs updated 2014-01-04 20:12:07 +00:00			`to make embedding easy`
Added lightweight feature 2013-12-26 09:33:26 +00:00			`- Extremely lightweight, has a core of under 40kB and tiny runtime footprint`
Tyop fix. 2014-03-19 04:49:47 +00:00			`- Asynchronous, non-blocking core supporting single- or multi-threaded usage`
README message changed 2014-04-09 18:10:49 +01:00			`- On the market since 2004 with over 1 million cumulative downloads`
			`- Stable, mature and tested, has several man-years invested`
			`in continuous improvement and refinement`
Initial version of readme 2012-08-25 22:48:14 +01:00
Moved screenshots down 2014-03-11 16:59:17 +00:00			`# Screenshots`

			`Download, double-click to start, run browser -- that's all!`

			`![shot1](http://cesanta.com/images/tut_sharing/tut1.png)`
			`![shot2](http://cesanta.com/images/tut_sharing/tut2.png)`

			`![shot3](http://cesanta.com/images/tut_sharing/tut3.png)`
			`![shot4](http://cesanta.com/images/tut_sharing/tut4.png)`

Added credits section mentioning those great who contributed 2013-09-12 17:30:03 +01:00			`# Acknowledgements`

Docs updated 2014-01-04 20:12:07 +00:00			`Mongoose made better thanks to the contribution of following people:`
Added credits section mentioning those great who contributed 2013-09-12 17:30:03 +01:00
			`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.`
Initial version of readme 2012-08-25 22:48:14 +01:00
Wording and links corrected 2013-10-03 19:34:00 +01:00			`# Licensing`
Initial version of readme 2012-08-25 22:48:14 +01:00
Wording for licensing clarified 2014-06-18 11:30:57 +01:00			`Mongoose is released under commercial and`
			`[GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) open`
			`source licenses. The GPLv2 open source License does not generally permit`
			`incorporating this software into non-open source programs.`
			`For those customers who do not wish to comply with the GPLv2 open`
			`source license requirements,`
			`[Cesanta Software](http://cesanta.com) offers a full,`
			`royalty-free commercial license and professional support`
			`without any of the GPL restrictions.`
License change 2013-08-16 11:28:50 +01:00
Moved other products in a different section 2014-04-30 09:18:55 +01:00			`# Other products by Cesanta Software: simple and effective`

			`- [SSL Wrapper](https://github.com/cesanta/ssl_wrapper) - application to`
			`secure network communications`
			`- [Frozen](https://github.com/cesanta/frozen) - JSON parser and generator`
			`- [SLRE](https://github.com/cesanta/slre) - Super Light Regular Expression`
			`library`
			`- [Net Skeleton](https://github.com/cesanta/net_skeleton) - framework for`
			`building network applications`
			`- [SLDR](https://github.com/cesanta/sldr) - Super Light DNS Resolver`