mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-27 08:31:28 +00:00
968e0a7b3d
Addresses issue #861 - syslog flooded on docker host Many routine operational messages were being logged at INFO level, causing excessive log volume when monitoring multiple VMs/containers. These messages are now logged at DEBUG level: - Guest threshold checking (every guest, every poll cycle) - Storage threshold checking (every storage, every poll cycle) - Host agent linking messages - Filesystem inclusion in disk calculation - Guest agent disk usage replacement - Polling start/completion messages - Alert cleanup and save messages Users can set LOG_LEVEL=debug to see these messages if needed for troubleshooting. The default INFO level now produces significantly less log output. Also updated documentation in CONFIGURATION.md and DOCKER.md to: - Clarify what each log level includes - Add tip about using LOG_LEVEL=warn for minimal logging
123 lines
2.3 KiB
Markdown
123 lines
2.3 KiB
Markdown
# 🐳 Docker Guide
|
|
|
|
Pulse is distributed as a lightweight, Alpine-based Docker image.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name pulse \
|
|
-p 7655:7655 \
|
|
-v pulse_data:/data \
|
|
--restart unless-stopped \
|
|
rcourtman/pulse:latest
|
|
```
|
|
|
|
Access at `http://<your-ip>:7655`.
|
|
|
|
---
|
|
|
|
## 📦 Docker Compose
|
|
|
|
Create a `docker-compose.yml` file:
|
|
|
|
```yaml
|
|
services:
|
|
pulse:
|
|
image: rcourtman/pulse:latest
|
|
container_name: pulse
|
|
restart: unless-stopped
|
|
ports:
|
|
- "7655:7655"
|
|
volumes:
|
|
- pulse_data:/data
|
|
environment:
|
|
- TZ=Europe/London
|
|
# Optional: Pre-configure auth (skips setup wizard)
|
|
# - PULSE_AUTH_USER=admin
|
|
# - PULSE_AUTH_PASS=secret123
|
|
|
|
volumes:
|
|
pulse_data:
|
|
```
|
|
|
|
Run with: `docker compose up -d`
|
|
|
|
---
|
|
|
|
## ⚙️ Configuration
|
|
|
|
Pulse is configured via environment variables.
|
|
|
|
| Variable | Description | Default |
|
|
|----------|-------------|---------|
|
|
| `TZ` | Timezone | `UTC` |
|
|
| `PULSE_AUTH_USER` | Admin Username | *(unset)* |
|
|
| `PULSE_AUTH_PASS` | Admin Password | *(unset)* |
|
|
| `API_TOKENS` | Comma-separated API tokens | *(unset)* |
|
|
| `DISCOVERY_SUBNET` | Custom CIDR to scan | *(auto)* |
|
|
| `ALLOWED_ORIGINS` | CORS allowed domains | *(none)* |
|
|
| `LOG_LEVEL` | Log verbosity (`debug`, `info`, `warn`, `error`) | `info` |
|
|
|
|
> **Tip**: Set `LOG_LEVEL=warn` to reduce log volume while still capturing important events.
|
|
|
|
<details>
|
|
<summary><strong>Advanced: Resource Limits & Healthcheck</strong></summary>
|
|
|
|
```yaml
|
|
services:
|
|
pulse:
|
|
deploy:
|
|
resources:
|
|
limits:
|
|
cpus: '0.5'
|
|
memory: 256M
|
|
healthcheck:
|
|
test: ["CMD", "wget", "--spider", "-q", "http://localhost:7655/api/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
retries: 3
|
|
```
|
|
</details>
|
|
|
|
---
|
|
|
|
## 🔄 Updates
|
|
|
|
To update Pulse to the latest version:
|
|
|
|
```bash
|
|
docker pull rcourtman/pulse:latest
|
|
docker stop pulse
|
|
docker rm pulse
|
|
# Re-run your docker run command
|
|
```
|
|
|
|
If using Compose:
|
|
```bash
|
|
docker compose pull
|
|
docker compose up -d
|
|
```
|
|
|
|
---
|
|
|
|
## 🛠️ Troubleshooting
|
|
|
|
- **Forgot Password?**
|
|
```bash
|
|
docker exec pulse rm /data/.env
|
|
docker restart pulse
|
|
# Access UI again. Pulse will require a bootstrap token for setup.
|
|
# Get it with:
|
|
docker exec pulse /app/pulse bootstrap-token
|
|
```
|
|
|
|
- **Logs**
|
|
```bash
|
|
docker logs -f pulse
|
|
```
|
|
|
|
- **Shell Access**
|
|
```bash
|
|
docker exec -it pulse /bin/sh
|
|
```
|