README.md
1 CivetWeb
2=======
3
4**The official home of CivetWeb is [https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb)**
5
6
7Continuous integration for Linux and OSX ([Travis CI](https://travis-ci.org/civetweb/civetweb)):
8
9[](https://travis-ci.org/civetweb/civetweb)
10
11Continuous integration for Windows ([AppVeyor](https://ci.appveyor.com/project/civetweb/civetweb)):
12
13[](https://ci.appveyor.com/project/civetweb/civetweb/branch/master)
14
15Test coverage check ([coveralls](https://coveralls.io/github/civetweb/civetweb)) (currently in a setup phase):
16
17[](https://coveralls.io/github/civetweb/civetweb?branch=master)
18
19Static source code analysis ([Coverity](https://scan.coverity.com/projects/5784)):
20
21[](https://scan.coverity.com/projects/5784)
22
23
24
25
26Project Mission
27-----------------
28
29Project mission is to provide easy to use, powerful, C/C++ embeddable web
30server with optional CGI, SSL and Lua support.
31CivetWeb has a MIT license so you can innovate without restrictions.
32
33CivetWeb can be used by developers as a library, to add web server functionality to an existing application.
34It can also be used by end users as a stand-alone web server. It is available as single executable, no installation is required.
35
36
37Where to find the official version?
38-----------------------------------
39
40End users can download CivetWeb at SourceForge
41[https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
42
43Developers can contribute to CivetWeb via GitHub
44[https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb)
45
46Trouble tickets should be filed on GitHub
47[https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
48
49Discussion/support group and announcements are at Google Groups
50[https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb)
51
52
53Quick start documentation
54--------------------------
55
56- [docs/Installing.md](https://github.com/civetweb/civetweb/blob/master/docs/Installing.md) - Install Guide (for end users using pre-built binaries)
57- [docs/UserManual.md](https://github.com/civetweb/civetweb/blob/master/docs/UserManual.md) - End User Guide
58- [docs/Building.md](https://github.com/civetweb/civetweb/blob/master/docs/Building.md) - Building the Server (quick start guide)
59- [docs/Embedding.md](https://github.com/civetweb/civetweb/blob/master/docs/Embedding.md) - Embedding (how to add HTTP support to an existing application)
60- [docs/OpenSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/OpenSSL.md) - Adding HTTPS (SSL/TLS) support using OpenSSL.
61- [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md) - Release Notes
62- [LICENSE.md](https://github.com/civetweb/civetweb/blob/master/LICENSE.md) - Copyright License
63
64
65Overview
66--------
67
68CivetWeb keeps the balance between functionality and
69simplicity by a carefully selected list of features:
70
71- Liberal, commercial-friendly, permissive,
72 [MIT license](http://en.wikipedia.org/wiki/MIT_License)
73- Free from copy-left licenses, like GPL, because you should innovate without
74 restrictions.
75- Forked from [Mongoose](https://code.google.com/p/mongoose/) in 2013, before
76 it changed the licence from MIT to commercial + GPL. A lot of enchancements
77 have been added since that time, see
78 [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md).
79- Works on Windows, Mac, Linux, UNIX, iPhone, Android, Buildroot, and many
80 other platforms.
81- Scripting and database support (Lua scipts, Lua Server Pages, CGI + SQLite
82 database, Server side javascript).
83 This provides a ready to go, powerful web development platform in a one
84 single-click executable with **no dependencies**.
85- Support for CGI, HTTPS (SSL/TLS), SSI, HTTP digest (MD5) authorization, Websocket,
86 WEbDAV.
87- Optional support for authentication using client side X.509 certificates.
88- Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service.
89- Download speed limit based on client subnet or URI pattern.
90- Simple and clean embedding API.
91- The source is in single file to make things easy.
92- Embedding examples included.
93- HTTP client capable of sending arbitrary HTTP/HTTPS requests.
94- Websocket client functionality available (WS/WSS).
95
96
97### Optionally included software
98
99<a href="http://lua.org">
100
101</a>
102<a href="http://sqlite.org">
103
104</a>
105<a href="http://keplerproject.github.io/luafilesystem/">
106
107</a>
108<a href="http://lua.sqlite.org/index.cgi/index">
109
110</a>
111<a href="http://viremo.eludi.net/LuaXML/index.html">
112
113</a>
114<a href="http://duktape.org">
115
116</a>
117
118
119Support
120-------
121
122This project is very easy to install and use. Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
123and have a look at the [examples] (https://github.com/civetweb/civetweb/blob/master/examples/).
124More information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb).
125
126
127Contributions
128---------------
129
130Contributions are welcome provided all contributions carry the MIT license.
131
132DO NOT APPLY fixes copied from Mongoose to this project to prevent GPL tainting.
133Since 2013 CivetWeb and Mongoose are developed independently. By now the code base differs, so patches cannot be safely transfered in either direction.
134
135Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
136
137
138### Authors
139
140CivetWeb is based on the Mongoose project. The original author of Mongoose was
141Sergey Lyubka (Copyright (c) 2004-2013 Sergey Lyubka, MIT license).
142
143However, in August 16, 2013, the [license of Mongoose has been changed](https://groups.google.com/forum/#!topic/mongoose-users/aafbOnHonkI)
144after writing and distributing the original code this project is based on.
145The license change used to be described on the Mongoose Wikipedia page as well, but it's getting deleted there regularly.
146
147CivetWeb has been forked from the last MIT version of Mongoose.
148Since 2013, CivetWeb has seen many improvements from various authors
149(Copyright (c) 2013-2016 the CivetWeb developers, MIT license).
150A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md).
151
152Using the CivetWeb project ensures the MIT licenses terms are applied and
153GPL cannot be imposed on any of this code as long as it is sourced from
154here. This code will remain free with the MIT license protection.
155
156
){kind=link}
){kind=link}
){kind=link}
