Baipyrus/Matrix
1
0
Fork 0
mirror of https://gitlab1.ptb.de/waltem01/Matrix synced 2024-12-26 03:51:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved API warning

Browse Source
This commit is contained in:
waltem01 2024-01-11 14:39:17 +01:00
parent 159255836f
commit 30f16e0a63
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
API/README.md
View File

@ -2,6 +2,8 @@
REST API to access the Raspberry PI RGB LED Matrix over HTTP. 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 ## How to run
**Note:** Once run, you should not simply kill the process. Graceful shutdown is work-in-progress. **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. 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 ### GET Endpoints
- `/clear`: Clear the buffered canvas - `/clear`: Clear the buffered canvas