Simple-Web-Server/README.md
2015-09-29 14:23:40 +02:00

53 lines
1.8 KiB
Markdown

Simple-Web-Server
=================
A very simple, fast, multithreaded, platform independent HTTP and HTTPS server and client library implemented using C++11 and Boost.Asio. Created to be an easy way to make REST resources available from C++ applications.
See also https://github.com/eidheim/Simple-WebSocket-Server for an easy way to make WebSocket/WebSocket Secure endpoints in C++.
### Features
* Thread pool
* Platform independent
* HTTPS support
* HTTP persistent connection (for HTTP/1.1)
* Client supports chunked transfer encoding
* Timeouts, if any of Server::timeout_request and Server::timeout_content are >0 (default: Server::timeout_request=5 seconds, and Server::timeout_content=300 seconds)
* Simple way to add REST resources using regex for path, and anonymous functions
* Possibility to flush response to clients synchronously (Server::flush).
###Usage
See http_examples.cpp or https_examples.cpp for example usage.
See particularly the JSON-POST (using Boost.PropertyTree) and the GET /match/[number] examples, which are most relevant.
The default_resource includes example use of Server::flush.
### Dependencies
* Boost C++ libraries
* For HTTPS: OpenSSL libraries
### Compile and run
Compile with a C++11 compliant compiler (for instance g++ 4.9):
```
cmake .
make
```
#### HTTP
Run the server and client examples: `./http_examples`
Direct your favorite browser to for instance http://localhost:8080/
#### HTTPS
Before running the server, an RSA private key (server.key) and an SSL certificate (server.crt) must be created. Follow, for instance, the instructions given here (for a self-signed certificate): http://www.akadia.com/services/ssh_test_certificate.html
Run the server and client examples: `./https_examples`
Direct your favorite browser to for instance https://localhost:8080/