|
@@ -14,7 +14,7 @@ Continuous integration for Windows ([AppVeyor](https://ci.appveyor.com/project/c
|
|
|
|
|
|
[](https://ci.appveyor.com/project/civetweb/civetweb/branch/master)
|
|
[](https://ci.appveyor.com/project/civetweb/civetweb/branch/master)
|
|
|
|
|
|
-Test coverage check ([coveralls](https://coveralls.io/github/civetweb/civetweb), [codecov](https://codecov.io/gh/civetweb/civetweb/branch/master)) (currently in a setup and evaluation phase):
|
|
|
|
|
|
+Test coverage check ([coveralls](https://coveralls.io/github/civetweb/civetweb), [codecov](https://codecov.io/gh/civetweb/civetweb/branch/master)) (using different tools/settings):
|
|
|
|
|
|
[]()
|
|
[]()
|
|
[](https://coveralls.io/github/civetweb/civetweb?branch=master)
|
|
[](https://coveralls.io/github/civetweb/civetweb?branch=master)
|
|
@@ -32,18 +32,18 @@ Static source code analysis ([Coverity](https://scan.coverity.com/projects/5784)
|
|
Project Mission
|
|
Project Mission
|
|
-----------------
|
|
-----------------
|
|
|
|
|
|
-Project mission is to provide easy to use, powerful, C/C++ embeddable web
|
|
|
|
-server with optional CGI, SSL and Lua support.
|
|
|
|
|
|
+Project mission is to provide easy to use, powerful, C (C/C++) embeddable web server with optional CGI, SSL and Lua support.
|
|
CivetWeb has a MIT license so you can innovate without restrictions.
|
|
CivetWeb has a MIT license so you can innovate without restrictions.
|
|
|
|
|
|
CivetWeb can be used by developers as a library, to add web server functionality to an existing application.
|
|
CivetWeb can be used by developers as a library, to add web server functionality to an existing application.
|
|
-It can also be used by end users as a stand-alone web server. It is available as single executable, no installation is required.
|
|
|
|
|
|
+
|
|
|
|
+It can also be used by end users as a stand-alone web server running on a Windows or Linux PC. It is available as single executable, no installation is required.
|
|
|
|
|
|
|
|
|
|
Where to find the official version?
|
|
Where to find the official version?
|
|
-----------------------------------
|
|
-----------------------------------
|
|
|
|
|
|
-End users can download CivetWeb releases at SourceForge
|
|
|
|
|
|
+End users can download CivetWeb binaries / releases from SourceForge
|
|
[https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
|
|
[https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
|
|
|
|
|
|
Developers can contribute to CivetWeb via GitHub
|
|
Developers can contribute to CivetWeb via GitHub
|
|
@@ -53,7 +53,9 @@ Trouble tickets should be filed on GitHub
|
|
[https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
|
|
[https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
|
|
|
|
|
|
Announcements are at Google Groups
|
|
Announcements are at Google Groups
|
|
-[https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb). Some older support and discussion threads are there as well. However, recently support questions and discussions are usually [GitHub issues](https://github.com/civetweb/civetweb/issues).
|
|
|
|
|
|
+[https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb).
|
|
|
|
+Some older support and discussion threads are there as well.
|
|
|
|
+However, recently support questions and discussions are usually [GitHub issues](https://github.com/civetweb/civetweb/issues).
|
|
|
|
|
|
Source releases can be found on GitHub
|
|
Source releases can be found on GitHub
|
|
[https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
|
|
[https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
|
|
@@ -67,7 +69,7 @@ Getting The Source
|
|
Download the source code by running the following code in your command prompt:
|
|
Download the source code by running the following code in your command prompt:
|
|
|
|
|
|
$ git clone https://github.com/civetweb/civetweb.git
|
|
$ git clone https://github.com/civetweb/civetweb.git
|
|
-or simply grab a copy of the source code as a Zip file.
|
|
|
|
|
|
+or simply grab a copy of the source code as a ZIP or TGZ file.
|
|
|
|
|
|
|
|
|
|
Quick start documentation
|
|
Quick start documentation
|
|
@@ -99,14 +101,16 @@ simplicity by a carefully selected list of features:
|
|
[RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md).
|
|
[RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md).
|
|
- Works on Windows, Mac, Linux, UNIX, iPhone, Android, Buildroot, and many
|
|
- Works on Windows, Mac, Linux, UNIX, iPhone, Android, Buildroot, and many
|
|
other platforms.
|
|
other platforms.
|
|
-- Scripting and database support (Lua scripts, Lua Server Pages, CGI + SQLite
|
|
|
|
- database, Server side javascript).
|
|
|
|
|
|
+- Scripting and database support (CGI, SQLite database, Lua Server Pages,
|
|
|
|
+ Server side Lua scripts, Server side JavaScript).
|
|
This provides a ready to go, powerful web development platform in a one
|
|
This provides a ready to go, powerful web development platform in a one
|
|
single-click executable with **no dependencies**.
|
|
single-click executable with **no dependencies**.
|
|
-- Support for CGI, HTTPS (SSL/TLS), SSI, HTTP digest (MD5) authorization, Websocket,
|
|
|
|
|
|
+- Support for CGI, SSI, HTTP digest (MD5) authorization, WebSocket,
|
|
WebDAV.
|
|
WebDAV.
|
|
|
|
+- HTTPS (SSL/TLS) support using [OpenSSL](https://www.openssl.org/).
|
|
- Optional support for authentication using client side X.509 certificates.
|
|
- Optional support for authentication using client side X.509 certificates.
|
|
-- Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service.
|
|
|
|
|
|
+- Resumed download, URL rewrite, file blacklist, IP-based ACL.
|
|
|
|
+- May run as Windows service.
|
|
- Download speed limit based on client subnet or URI pattern.
|
|
- Download speed limit based on client subnet or URI pattern.
|
|
- Simple and clean embedding API.
|
|
- Simple and clean embedding API.
|
|
- The source is in single file to make things easy.
|
|
- The source is in single file to make things easy.
|
|
@@ -136,9 +140,13 @@ Support
|
|
This project is very easy to install and use.
|
|
This project is very easy to install and use.
|
|
Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
|
|
Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
|
|
and have a look at the [examples](https://github.com/civetweb/civetweb/blob/master/examples/).
|
|
and have a look at the [examples](https://github.com/civetweb/civetweb/blob/master/examples/).
|
|
-More information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb).
|
|
|
|
|
|
|
|
-Note: I do not take any liability or warranty for any linked contents. Visit these pages and try the community support suggestions at your own risk.
|
|
|
|
|
|
+Some information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb),
|
|
|
|
+However, since questions and discussions moved to [GitHub issues](https://github.com/civetweb/civetweb/issues), information there may be out of date.
|
|
|
|
+
|
|
|
|
+Note: We do not take any liability or warranty for any linked contents. Visit these pages and try the community support suggestions at your own risk.
|
|
|
|
+Any link provided in this project (including source and documentation) is provided in the hope that this information will be helpful.
|
|
|
|
+However, we cannot accept any responsibility for any content on an external page.
|
|
|
|
|
|
|
|
|
|
Contributions
|
|
Contributions
|
|
@@ -155,21 +163,21 @@ Some guidelines can be found in [docs/Contribution.md](https://github.com/civetw
|
|
|
|
|
|
### Authors
|
|
### Authors
|
|
|
|
|
|
|
|
+CivetWeb has been forked from the last MIT version of Mongoose in 2013.
|
|
|
|
+Since then, CivetWeb has seen many improvements from various authors
|
|
|
|
+(Copyright (c) 2013-2020 the CivetWeb developers, MIT license).
|
|
|
|
+
|
|
|
|
+A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md).
|
|
|
|
+
|
|
CivetWeb is based on the Mongoose project. The original author of Mongoose was
|
|
CivetWeb is based on the Mongoose project. The original author of Mongoose was
|
|
Sergey Lyubka (Copyright (c) 2004-2013 Sergey Lyubka, MIT license).
|
|
Sergey Lyubka (Copyright (c) 2004-2013 Sergey Lyubka, MIT license).
|
|
-
|
|
|
|
-However, in August 16, 2013, the [license of Mongoose has been changed](https://groups.google.com/forum/#!topic/mongoose-users/aafbOnHonkI)
|
|
|
|
|
|
+However, on August 16, 2013, the [license of Mongoose has been changed](https://groups.google.com/forum/#!topic/mongoose-users/aafbOnHonkI)
|
|
after writing and distributing the original code this project is based on.
|
|
after writing and distributing the original code this project is based on.
|
|
The license change and CivetWeb used to be mentioned on the Mongoose
|
|
The license change and CivetWeb used to be mentioned on the Mongoose
|
|
[Wikipedia](https://en.wikipedia.org/wiki/Mongoose_(web_server))
|
|
[Wikipedia](https://en.wikipedia.org/wiki/Mongoose_(web_server))
|
|
page as well, but it's getting deleted (and added again) there every
|
|
page as well, but it's getting deleted (and added again) there every
|
|
now and then.
|
|
now and then.
|
|
|
|
|
|
-CivetWeb has been forked from the last MIT version of Mongoose.
|
|
|
|
-Since 2013, CivetWeb has seen many improvements from various authors
|
|
|
|
-(Copyright (c) 2013-2017 the CivetWeb developers, MIT license).
|
|
|
|
-A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md).
|
|
|
|
-
|
|
|
|
Using the CivetWeb project ensures the MIT licenses terms are applied and
|
|
Using the CivetWeb project ensures the MIT licenses terms are applied and
|
|
GPL cannot be imposed on any of this code, as long as it is sourced from
|
|
GPL cannot be imposed on any of this code, as long as it is sourced from
|
|
here. This code will remain free with the MIT license protection.
|
|
here. This code will remain free with the MIT license protection.
|