configuration (#35)

* feat: add configuration * chore: use crontab instead of custom script * doc: edit readme * chore: change github.com/404 as its status is 200 --------- Co-authored-by: Domenico Blanco <[email protected]>
UNICT-DMI · Nov 10, 2023 · 49b49f9 · 49b49f9
1 parent 1b41d9d
commit 49b49f9
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Custom
+config/settings.yaml
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 A simple Python script to verify if a service is up. Whenever the service falls, a message will be sent to a user/group/channel with Telegram
 
 ## How to use?
-Just set two env variables:
+- Just set two env variables:
 - `QDBotToken`, your bot token
 - `QDBotIDs`, the ID(s) the bot will use to communicate any downtime. It's possible to set multiple IDs, semicolon separated without any space
 
@@ -20,6 +20,16 @@ export QDBotIDs="10000000"                                      # Single ID
 export QDBotIDs="10000000;10000001;10000002"                    # Multiple IDs
 ```
 
+### Run it every 5 minutes using crontab
+- Open crontab using:
+```bash
+$ crontab -e
+```
+- Add the following line
+```bash
+*/5 * * * * cd /path/to/Healthcheck-bot/ && python3 src/main.py > checks.log 2> errors.log    
+```
+
 ## Write Unit Tests
 In order to write Unit Tests, you have to put it inside `tests`.
 There are many possibilities, 

diff --git a/config/settings.yaml.dist b/config/settings.yaml.dist
diff --git a/src/urls.json b/src/urls.json
@@ -1,4 +1,12 @@
 { 
-    "get": ["https://duckduckgo.com/", "https://google.com/"], 
-    "ping": ["https://duckduckgo.com/", "https://google.com/"]
+    "get": [
+        "https://api-opis.unictdev.org/", 
+        "https://telegram.unictdev.org/",
+        "https://open-job-dmi.unictdev.org/"
+    ], 
+    "ping": [
+        "https://api-opis.unictdev.org/", 
+        "https://telegram.unictdev.org/",
+        "https://open-job-dmi.unictdev.org/"
+    ]
 }
diff --git a/tests/main_test.py b/tests/main_test.py
@@ -14,7 +14,7 @@
     {
         'func': main.check_ok,
         'expected_res': False,
-        'arg': ('https://github.com/404',),
+        'arg': ('https://github.com/IDontThinkThisPageWillEverExist',),
         'is_async': True
     },
     {