Merge remote-tracking branch 'origin/main' into 4.0.0-todo

Author: michalpokusa

README.rst

@@ -95,6 +95,13 @@ Or the following command to update an existing version:
 
     circup update
 
+Security
+========
+
+The HTTP server implementation in this package is not robust and should only be deployed on trusted networks.
+For instance, there are trivial denial of service attacks against adafruit_httpserver.
+Pull requests that improve the server's security and robustness are of course welcome.
+
 Contributing
 ============
 

docs/examples.rst

@@ -1,10 +1,10 @@
-Simple file serving
+Simple Test
 -------------------
 
-Serving the content of index.html from the filesystem.
+Serving a simple static text message.
 
-.. literalinclude:: ../examples/httpserver_simple_serve.py
-    :caption: examples/httpserver_simple_serve.py
+.. literalinclude:: ../examples/httpserver_simpletest.py
+    :caption: examples/httpserver_simpletest.py
     :linenos:
 
 If you want your code to do more than just serve web pages,

examples/httpserver_simple_serve.py examples/httpserver_simpletest.pyexamples/httpserver_simple_serve.py renamed to examples/httpserver_simpletest.py

@@ -27,10 +27,11 @@
 @server.route("/")
 def base(request: HTTPRequest):
     """
-    Serve the default index.html file.
+    Serve a default static plain text message.
     """
-    with HTTPResponse(request, content_type=MIMEType.TYPE_HTML) as response:
-        response.send_file("index.html")
+    with HTTPResponse(request, content_type=MIMEType.TYPE_TXT) as response:
+        message = "Hello from the CircuitPython HTTPServer!"
+        response.send(message)
 
 
 print(f"Listening on http://{wifi.radio.ipv4_address}:80")