Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cobular/flare-discordpy
A dead-simple cog to add easy uptime monitoring to your discord bot!
https://github.com/cobular/flare-discordpy
Last synced: about 2 months ago
JSON representation
A dead-simple cog to add easy uptime monitoring to your discord bot!
- Host: GitHub
- URL: https://github.com/cobular/flare-discordpy
- Owner: Cobular
- License: mit
- Created: 2021-04-01T08:20:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-02T18:21:29.000Z (over 3 years ago)
- Last Synced: 2024-05-02T06:17:59.895Z (8 months ago)
- Language: Python
- Size: 570 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Flare
An easy-to-use, dead-simple cog to add a tiny, simple, fast webpage to your bot in order to enable uptime monitoring with something like UptimeRobot.
Heavily inspired from this StackOverflow answer: https://stackoverflow.com/a/62481294/5623598. Thanks random internet person!!
## Usage
Simply install the cog with `pip install flare` and then import it: `from Flare import Flare`. Finally, load the cog with `bot.add_cog(Flare(bot))` and you're off to the races!!
Take a look at http://localhost:5000/ to see the bot's status page.
#### Example
For an example implementation, take a look at `example_bot/bot.py`, where there is a minimum viable bot implementing this page.
## Configuration
The cog has three env vars, but the defaults work fine for a plug and play setup. If you want to change them, here's what you need to know:
* `FLARE_PORT` is the port the webserver is exposed on, and it defaults to 5000. Set it to any number to change the port to your heart's desire.
* `FLARE_PATH` is the path to the page. This defaults to `/`, but you can change it with this var to whatever you choose.
* `FLARE_HOST` is the host to listen on, defaults to `None` which in this case means all interfaces. You can set it to a specific IP if you would like to change this configuration.