README.md
1 Civetweb
2=======
3
4There is a new home!!!
5-----------------
6https://github.com/bel2125/civetweb
7
8Bel has been taking the lead on Civetweb, so the official repository is being
9moved under his control for ease of maintenance.
10
11Project Mission
12-----------------
13
14Project mission is to provide easy to use, powerful, C/C++ embeddable web
15server with optional CGI, SSL and Lua support.
16Civetweb has a MIT license so you can innovate without restrictions.
17
18Where to find the official version?
19-----------------------------------
20
21End users can download Civetweb at SourceForge
22https://sourceforge.net/projects/civetweb/
23
24Developers can contribute to CivetWeb via GitHub
25https://github.com/bel2125/civetweb
26
27Trouble tickets should be filed on GitHub
28https://github.com/bel2125/civetweb/issues
29
30Discussion/support group and announcements are at Google Groups
31https://groups.google.com/d/forum/civetweb
32
33Quick start documentation
34--------------------------
35
36- [docs/Installing.md](https://github.com/bel2125/civetweb/blob/master/docs/Installing.md) - Install Guide
37- [docs/UserManual.md](https://github.com/bel2125/civetweb/blob/master/docs/UserManual.md) - End User Guide
38- [docs/Building.md](https://github.com/bel2125/civetweb/blob/master/docs/Building.md) - Buildiing the Server Quick Start
39- [docs/Embedding.md](https://github.com/bel2125/civetweb/blob/master/docs/Embedding.md) - Embedding Quick Start
40- [RELEASE_NOTES.md](https://github.com/bel2125/civetweb/blob/master/RELEASE_NOTES.md) - Release Notes
41- [LICENSE.md](https://github.com/bel2125/civetweb/blob/master/LICENSE.md) - Copyright License
42
43Overview
44--------
45
46Civetweb keeps the balance between functionality and
47simplicity by a carefully selected list of features:
48
49- Liberal, commercial-friendly, permissive,
50 [MIT license](http://en.wikipedia.org/wiki/MIT_License)
51- Free from copy-left licenses, like GPL, because you should innovate without
52 restrictions.
53- Forked from [Mongoose](https://code.google.com/p/mongoose/) in 2013, before
54 it changed the licence from MIT to commercial + GPL. A lot of enchancements
55 have been added since that time, see
56 [RELEASE_NOTES.md](https://github.com/bel2125/civetweb/blob/master/RELEASE_NOTES.md).
57- Works on Windows, Mac, Linux, UNIX, iPhone, Android, Buildroot, and many
58 other platforms.
59- Scripting and database support (Lua scipts, Lua Server Pages, CGI + SQLite
60 database).
61 This provides a ready to go, powerful web development platform in a one
62 single-click executable with **no dependencies**.
63- Support for CGI, HTTPS/SSL, SSI, HTTP digest (MD5) authorization, Websocket,
64 WEbDAV.
65- Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service.
66- Download speed limit based on client subnet or URI pattern.
67- Simple and clean embedding API.
68- The source is in single file to make things easy.
69- Embedding examples included.
70- HTTP client capable of sending arbitrary HTTP/HTTPS requests.
71
72
73### Optionally included software
74
75<a href="http://lua.org">
76
77</a>
78<a href="http://sqlite.org">
79
80</a>
81<a href=http://keplerproject.github.io/luafilesystem/">
82
83</a>
84<a href=http://lua.sqlite.org/index.cgi/index">
85
86</a>
87<a href=http://viremo.eludi.net/LuaXML/index.html">
88
89</a>
90
91Support
92-------
93
94This project is very easy to install and use. Please read the [documentation](https://github.com/bel2125/civetweb/blob/master/docs/)
95and have a look at the [examples] (https://github.com/bel2125/civetweb/blob/master/examples/).
96More information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb).
97
98
99Contributions
100---------------
101
102Contributions are welcome provided all contributions carry the MIT license.
103
104DO NOT APPLY fixes copied from Mongoose to this project to prevent GPL tainting.
105
106### Author
107
108Civetweb is based on the Mongoose project - the original Author was Sergey Lyubka. He still
109controls the original Mongoose project. However, he has changed or said he would
110change licenses after writing and distributing the original code this
111project is based on.
112
113Using this project ensures the MIT licenses terms are applied and
114GPL cannot be imposed on any of this code as long as it is sourced from
115here. This code will remain free with the MIT license protection.
116
117A list of authors can be found in [CREDITS.md](https://github.com/bel2125/civetweb/blob/master/CREDITS.md)
118
119
