diff --git a/README.md b/README.md index 0f0985e..7debbdf 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ htop-web packages its Angular frontend and Spring Boot WebFlux backend into a si Docker

+## Demo + +https://htop-web.jambotron.com/ + ## Features - **System dashboard** — inspect system information through a browser. @@ -57,6 +61,34 @@ htop-web packages its Angular frontend and Spring Boot WebFlux backend into a si The Angular frontend is built for production and packaged into the Spring Boot application's static resources. Both parts are deployed together as one application container. +## Simple Scenario of using + +```bash +services: + htop-web: + image: gitea.jambotron.com/liosha84/htop-web:latest + container_name: htop-web + restart: unless-stopped + pid: host + volumes: + - /sys:/host/sys:ro + - /:/host/root:ro + labels: + caddy: htop-web.jambotron.com + caddy.reverse_proxy: "{{upstreams 8080}}" + networks: + - jambotron-net + +networks: + jambotron-net: + external: true +``` + +```bash +docker compose up -d +``` + + ## Quick Start ### Requirements