Files
htop-web/docs/INSTALLATION.md
T
2026-10-28 20:14:56 +01:00

68 lines
1.1 KiB
Markdown

# Installation
## Requirements
- Docker Engine
- Docker Compose
- Java 21 and Node.js/npm if building the application locally
## Build the application
From the repository root:
```bash
cd backend
./gradlew clean build
cd ..
```
The Gradle build also builds the Angular frontend and packages its production assets into the Spring Boot application.
## Start with Docker Compose
```bash
docker compose up -d --build
```
The default Compose configuration maps host port `8088` to container port `8080`.
Open http://localhost:8088 in your browser.
## Check status and logs
```bash
docker compose ps
docker compose logs -f htop-web
```
## Stop the application
```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 down
```