bMorgan/MetricsApi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Ben Morgan 2023-08-21 18:57:28 -06:00 • committed by GitHub
parent 57cac30f59
commit 043793aeec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -32,3 +32,8 @@ To run MetricsAPI you will need to install Flask.
MetricsAPI gets its data from shell commands. You will need to install the following with your package manager: MetricsAPI gets its data from shell commands. You will need to install the following with your package manager:
`sysstat` `sysstat`
`sensors` `sensors`
### Try It!
I run the following command to start the API. Keep in mind that I only run this on my local network and the API is not open to the internet. As per Flask documention --app run is not intended for production. You should follow a Flask app deployment procedure (there are tons of them online) if you wish to open your API to the WWW.
`flask --app main run --host=0.0.0.0`