From 30f16e0a630ae19c883e192fb6377d27e772a41e Mon Sep 17 00:00:00 2001 From: waltem01 Date: Thu, 11 Jan 2024 14:39:17 +0100 Subject: [PATCH] improved API warning --- API/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/API/README.md b/API/README.md index 0373d44..9b979b8 100644 --- a/API/README.md +++ b/API/README.md @@ -2,6 +2,8 @@ REST API to access the Raspberry PI RGB LED Matrix over HTTP. +**Note:** This webserver should _never_ be exposed to the outside of the system it's running on, since it's meant to be combined with the provided `SvelteKit` webserver to serve a GUI. Although it can still be run in standalone, please make sure you set up a firewall or other kinds of access rules to **forbid any connections** from outside of this machine (localhost). + ## How to run **Note:** Once run, you should not simply kill the process. Graceful shutdown is work-in-progress. @@ -47,8 +49,6 @@ REST API to access the Raspberry PI RGB LED Matrix over HTTP. The script will host a `waitress` webserver on port `8080` of the machine it's running on. -**Note:** This webserver should _never_ be exposed to the outside of the system it's running on, since it's meant to be combined with the provided `SvelteKit` webserver to serve a GUI. For this reason, please make sure you set up a firewall or other kinds of access rules to **forbid any connections** from outside of this machine (localhost). - ### GET Endpoints - `/clear`: Clear the buffered canvas