jyapayne/Simple-Web-Server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Ole Christian Eidheim 2014-07-12 21:29:11 +02:00
commit 024d449e34
1 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,20 +1,19 @@
Simple-Web-Server
=================
A very simple, fast, multithreaded and platform independent HTTP server implemented using C++11 and Boost.Asio. Created to be an easy way to make REST resources available from C++ applications.
A very simple, fast, multithreaded and platform independent HTTP and HTTPS server implemented using C++11 and Boost.Asio. Created to be an easy way to make REST resources available from C++ applications.
### Features
* Thread pool
* Platform independent
* HTTPS support
* HTTP persistent connection (for HTTP/1.1)
* Simple way to add REST resources using regex for path, and anonymous functions
HTTPS is not yet supported, but take a look at http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/example/cpp03/ssl/server.cpp. It does not seem that server.hpp require significant modifications to support HTTPS.
###Usage
See main.cpp for example usage.
See main_http.cpp or main_https.cpp for example usage.
See particularly the JSON-POST (using Boost.PropertyTree) and the GET /match/[number] examples, which are most relevant.
@ -22,14 +21,27 @@ See particularly the JSON-POST (using Boost.PropertyTree) and the GET /match/[nu
Boost C++ libraries must be installed, go to http://www.boost.org for download and instructions.
For HTTPS: OpenSSL libraries from https://www.openssl.org are required.
Will update to use C++17 networking instead in the future when it is supported by g++.
### Compile and run
Compile with a C++11 compiler supporting regex (for instance g++ 4.9):
g++ -O3 -std=c++11 -lboost_system main.cpp -o httpserver
## HTTP
Then to run the server: ./httpserver
g++ -O3 -std=c++11 -lboost_system main_http.cpp -o http_server
Then to run the server: ./http_server
Finally, direct your favorite browser to for instance http://localhost:8080/
## HTTPS
g++ -O3 -std=c++11 -lboost_system -lssl -lcrypto main_https.cpp -o https_server
Then to run the server: ./https_server
Finally, direct your favorite browser to for instance https://localhost:8080/