Commit 711bf969 authored by Tiago Medicci's avatar Tiago Medicci

New documentation at README.md

parent 13ead540
# Simple HTTP server # Simple HTTP/HTTPS server
This is a very minimal HTTP server I use in some of the projects.
Absolutely not ready for any kind of production use.
This is a very minimal HTTP server. Optionally supports HTTPS server based on mbedTLS server example.
# How to use # How to use
Really, please see above note.
This directory is an ESP-IDF component. Clone it (or add it as a submodule) into the component directory of the project. This directory is an ESP-IDF component. Clone it (or add it as a submodule) into the component directory of the project.
Enable TLS/SSL HTTPS server by uncommenting the `#define HTTPS_SERVER` line at `https_server.h`, otherwise it will implement unsecured http server. Server certificate and private key are loaded at `https_server.c` directly into flash code as in the [`open_ssl_server`](https://github.com/espressif/esp-idf/tree/master/examples/protocols/openssl_server) example from ESP-IDF repository. Don't forget to insert [`cacert.pem`](https://github.com/espressif/esp-idf/blob/master/examples/protocols/openssl_server/main/cacert.pem) and [`prvtkey.pem`](https://github.com/espressif/esp-idf/blob/master/examples/protocols/openssl_server/main/prvtkey.pem) at your main application directory if you want to run GET/POST examples.
# Documentation # Documentation
None yet, but I tried to make the comments in the header file helpful. None yet, but I tried to make the comments in the header file helpful.
# Examples # Examples
Examples functions at http server Examples functions at http server:
## GET Method Example ## GET Method Example
...@@ -42,5 +36,4 @@ Increasing log level to "Verbose" should produce lots of output related to reque ...@@ -42,5 +36,4 @@ Increasing log level to "Verbose" should produce lots of output related to reque
# License # License
GPL, see [LICENSE](LICENSE) file. Mostly because this is a very early version. Will be relicensed as something more reasonable later. GPL, see [LICENSE](LICENSE) file. Mostly because this is a very early version. Will be relicensed as something more reasonable later. mbedTLS are Apache 2.0 licensed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment