Docs and some improvements

Author: MedAziz11

Dockerfile

@@ -12,8 +12,7 @@ RUN pip install --no-cache-dir -r ./requirements.txt
 
 COPY ./app/ ./
 
-# CMD ["uvicorn", "main:app", "--host=0.0.0.0", "--reload", "--port", "8000"]
-
 RUN chmod +x ./entrypoint.sh
 
 ENTRYPOINT [ "./entrypoint.sh" ]
+# ENTRYPOINT [ "tail", "-f", "/dev/null"]

README.md

@@ -1 +1,81 @@
-# Uptime-Kuma-Web-API
+# Uptime-Kuma-Web-API
+## A REST API wrapper for [Uptime Kuma](https://github.com/louislam/uptime-kuma) using [Uptime-Kuma-API](https://github.com/lucasheld/uptime-kuma-api)
+---
+## EndPoints:
+
+![Alt text](./images/1.png )
+![Alt text](./images/2.png )
+
+
+## How to use it:
+----
+
+### Environment Variables :
+  You have to define these ENV VARS in order to connect to your KUMA server.
+
+        KUMA_SERVER=<your_kuma_server>
+        KUMA_USERNAME=<your_kuma_username>
+        KUMA_PASSWORD=<your_kuma_password>
+        ADMIN_PASSWORD=<your admin password so you can connect with via the api>
+
+  #### Note:
+
+  You have to define your ADMIN_PASSWORD or you wont be able to connect to your rest api.
+
+  You will connect with those credentials:
+
+    username = admin
+    password = <ADMIN_PASSWORD>
+
+### Features:
+  - Multi user Kuma api ( without privilege YET!!) with a small SQLite db
+  - Easy to use REST API with most of the Uptime-Kuma features
+  - Swagger Docs
+  - Dockerized [UptimeKuma_RestAPI Container](https://hub.docker.com/repository/docker/medaziz11/uptimekuma_restapi)
+
+### Example : 
+  You can simply create a docker compose file like this :
+
+```yaml
+        version: '3.9'
+        services:
+        kuma:
+            container_name: uptime-kuma
+            image: louislam/uptime-kuma:latest
+            ports:
+            - "3001:3001"
+            restart: always
+            volumes:
+            - uptime-kuma:/app/data
+
+        api:
+            container_name: backend
+            image: medaziz11/uptimekuma_restapi
+            volumes:
+            - ./db:/db
+            restart: always
+            environment:
+            - KUMA_SERVER=http://kuma:3001
+            - KUMA_USERNAME=test
+            - KUMA_PASSWORD=123test.
+            - ADMIN_PASSWORD=admin
+            depends_on:
+            - kuma
+            ports:
+            - "8000:8000"
+
+        volumes:
+        uptime-kuma:
+```
+### In order for the example to work: You have to run kuma first then create your kuma username and password then re-run the compose file. 
+
+### Example CURL Script:
+---
+
+```bash
+
+    TOKEN=$(curl -X 'POST' -H 'Content-Type: application/x-www-form-urlencoded' --data 'username=admin&password=admin' http://127.0.0.1:8000/login/access-token/ | jq -r ".access_token")
+
+    curl -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" http://127.0.0.1:8000/monitors/
+
+```

app/main.py

@@ -1,4 +1,5 @@
 from fastapi import FastAPI
+from fastapi.responses import RedirectResponse
 import os
 
 from routers import monitor, auth, tags, cert, info, uptime, ping, database, settings as settings, user
@@ -45,6 +46,6 @@ async def startup_event():
 async def shutdown_event():
     await Tortoise.close_connections()
 
-@app.get("/")
+@app.get("/", include_in_schema=False)
 async def root():
-    return {"Foo": "Bar"}
+    return RedirectResponse(url='/docs')

docker-compose.yml

@@ -11,18 +11,19 @@ services:
 
   api:
     container_name: backend
-    build: .
+    image: medaziz11/uptimekuma_restapi
     volumes:
       - ./db:/db
     restart: always
     environment:
-      - PORT=8080
       - KUMA_SERVER=http://kuma:3001
       - KUMA_USERNAME=test
       - KUMA_PASSWORD=123test.
       - ADMIN_PASSWORD=admin
     depends_on:
       - kuma
+    ports:
+      - "8000:8000"
 
 volumes:
   uptime-kuma: