godzil/nodemcu-httpserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor updates

Browse Source
This commit is contained in:
Marcos Kirsch 2015-07-19 18:21:51 -05:00
parent dcc8df4960
commit 1918e8af96
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -9,7 +9,7 @@ A (very) simple web server written in Lua for the ESP8266 running the NodeMCU fi
* Server-side execution of Lua scripts * Server-side execution of Lua scripts
* Query string argument parsing * Query string argument parsing
* Serving .gz compressed files * Serving .gz compressed files
* HTTP basic authentication * HTTP Basic Authentication
## How to use ## How to use
@ -52,9 +52,15 @@ A (very) simple web server written in Lua for the ESP8266 running the NodeMCU fi
then index.html is served. By the way, unlike most HTTP servers, nodemcu_httpserver treats the URLs in a then index.html is served. By the way, unlike most HTTP servers, nodemcu_httpserver treats the URLs in a
case-sensitive manner. case-sensitive manner.
4. Enable http basic authentication. 4. How to use HTTP Basic Authentication.
Enable and configure http basic authentication in "httpserver-conf.lua" file. Enable and configure HTTP Basic Authentication by editing "httpserver-conf.lua" file.
When enabled, HTTP Basic Authentication is global to every file served by the server.
Remember that HTTP Basic Authentication is a very basic authentication protocol, and should not be
considered secure if the server is not using encryption, as your username and password travel
in plain text.
## How to create dynamic Lua scripts ## How to create dynamic Lua scripts
@ -116,18 +122,18 @@ A (very) simple web server written in Lua for the ESP8266 running the NodeMCU fi
#### Security implications #### Security implications
Be careful permanently installing something like this in your home. The Be careful permanently installing something like this in your home. The server provides
scripts use no authentication and no encryption. Your only layer of no encryption. Your only layer of security is the WiFi network and anyone with access
security is the wifi network and anyone with access to it could open to it could open or close your garage, enter your home, and steal your flatscreen TV.
or close your garage, enter your home, and steal your flatscreen TV.
This script is provided simply as an educational example and you should This script is provided simply as an educational example and you should treat accordingly.
treat accordingly.
## Not supported ## Not supported
* Other methods: HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH * Other methods: HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH
* Encryption * Encryption
* Multiple users (HTTP Basic Authentication)
* Only protect certain directories (HTTP Basic Authentication)
## Notes on memory usage. ## Notes on memory usage.