stuff
This commit is contained in:
22
README.md
22
README.md
@@ -13,7 +13,7 @@ After initializing the .env file with the MAC addresses of the devices you need
|
||||
The format used in the .env file is
|
||||
|
||||
```sh
|
||||
\# Environment variables
|
||||
# Environment variables
|
||||
WOL_SECRET_KEY="secretkey"
|
||||
WOL_USER_PASS="userpassword"
|
||||
REDIS_URL="redis://localhost:6379/0"
|
||||
@@ -30,7 +30,7 @@ It goes without saying that Wake-On-LAN must be enabled both in the BIOS and the
|
||||
|
||||
The project should also be run as root because the way that it sends Wake-On-LAN packets is similar to how etherwake does it. It doesn't actually send a UDP packet on port 9 but rather raw ethernet frames directly to the NIC of the device you want to wake up.
|
||||
|
||||
## Installation
|
||||
## Installation 🪛
|
||||
|
||||
```sh
|
||||
git clone https://git.konsthol.eu/konsthol/WOL-Ly
|
||||
@@ -39,38 +39,38 @@ chmod +x setup.sh
|
||||
sudo ./setup.sh
|
||||
```
|
||||
|
||||
## Usage
|
||||
## Usage 🖥️
|
||||
|
||||
Wake a device up
|
||||
Wake a device up 🛑💤
|
||||
|
||||
`curl -k "https://username:password@deviceIP:51820/wol/deviceToWakeUpName?key=SecretKey"`
|
||||
|
||||
Ping a device
|
||||
Ping a device 👉
|
||||
|
||||
`curl -k "https://deviceIP:51820/ping/deviceToWakeUpName"`
|
||||
|
||||
Check to see if Redis is connected
|
||||
Check to see if Redis is connected ✔️
|
||||
|
||||
`curl -k "https://username:password@deviceIP:51820/redis_status"`
|
||||
|
||||
Reset the rate limits
|
||||
Reset the rate limits 🙅
|
||||
|
||||
`curl -k "https://username:password@deviceIP:51820/reset_limiter?key=SecretKey"`
|
||||
|
||||
Or you could go to "https://deviceIP:51820" and click the buttons there for the Ping and Wol functions.
|
||||
|
||||
## UI portion
|
||||
## UI portion
|
||||
|
||||

|
||||
|
||||
## Dependencies
|
||||
## Dependencies 📦
|
||||
|
||||
* Python
|
||||
* Redis
|
||||
* Gunicorn
|
||||
* OpenSSL
|
||||
|
||||
## Credits go to
|
||||
## Credits go to 🗒️
|
||||
|
||||
* [CodePen](https://codepen.io/)
|
||||
* [Fernando Cohen](https://codepen.io/designfenix/pen/RwKPapa)
|
||||
@@ -93,6 +93,6 @@ For providing the SplitType library.
|
||||
|
||||
For providing a way to implement the animations used in the 4th CodePen.
|
||||
|
||||
## License
|
||||
## License 📜
|
||||
|
||||
This project as a whole is licensed under GPLv3 but for the UI part that uses Flexbox the license used is Apache License 2.0. The font used is Oswald which is licensed under SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007.
|
||||
|
||||
Reference in New Issue
Block a user