diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..fa0736f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Oleksiy Mykhailovych Yenuschenkov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index a1ddef6..7debbdf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # htop-web +![htop-web](htop-web.gif) + **A self-hosted, browser-based system monitoring dashboard powered by Angular and Spring Boot.** htop-web packages its Angular frontend and Spring Boot WebFlux backend into a single Docker container, providing a web interface for viewing system metrics and process information. @@ -11,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. @@ -55,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 diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 1e4d044..96ab2f1 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -40,3 +40,30 @@ docker compose logs -f htop-web ```bash docker compose down ``` + +## 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 +``` \ No newline at end of file diff --git a/htop-web.gif b/htop-web.gif new file mode 100644 index 0000000..610e98e Binary files /dev/null and b/htop-web.gif differ