pulse/docs/DOCKER.md

🐳 Docker Guide

Pulse is distributed as a lightweight, Alpine-based Docker image.

Paid Pulse Pro / Relay / legacy customers: The public rcourtman/pulse Docker image is the community build. It can accept an activation key, but it does not include the private Pulse Pro runtime hooks. Use https://pulserelay.pro/download.html with your activation key, then run the private registry login and PULSE_IMAGE=license.pulserelay.pro/pulse-pro:<version> compose commands shown there. Those commands require the compose file image line to use the PULSE_IMAGE variable, as shown below. If your compose file hardcodes image: rcourtman/pulse:..., replace that line with the variable form or with the private image shown on the download page before restarting.

🚀 Quick Start

docker run -d \
  --name pulse \
  -p 7655:7655 \
  -v pulse_data:/data \
  -e PULSE_DEPLOYMENT_METHOD=docker_run \
  --restart unless-stopped \
  rcourtman/pulse:vX.Y.Z

Access at http://<your-ip>:7655.

---

📦 Docker Compose

Create a docker-compose.yml file:

services:
  pulse:
    image: ${PULSE_IMAGE:-rcourtman/pulse:vX.Y.Z}
    container_name: pulse
    restart: unless-stopped
    ports:
      - "7655:7655"
    volumes:
      - pulse_data:/data
    environment:
      - TZ=Europe/London
      - PULSE_DEPLOYMENT_METHOD=docker_compose

volumes:
  pulse_data:

Run with: docker compose up -d

Leave authentication overrides unset for a new install and complete bootstrap-token setup in your browser. Do not add a shared example password to the Compose file. If automation must skip setup, use a private deployment-managed credential source; the private Docker authentication file example is for docker run, not Compose interpolation.

The PULSE_IMAGE variable lets the same compose file run either the public community image or, for eligible paid customers, the private Pulse Pro image shown on https://pulserelay.pro/download.html.

---

⚙️ Configuration

Pulse is configured via the UI (system.json) with optional environment overrides.

Variable	Description	Default
TZ	Timezone	UTC
PULSE_AUTH_USER	Admin Username	(unset)
PULSE_AUTH_PASS	Admin Password	(unset)
DISCOVERY_SUBNET	Custom CIDR to scan	(auto)
ALLOWED_ORIGINS	CORS allowed origin (* or a single origin). Empty = same-origin only.	(unset)
LOG_LEVEL	Log verbosity (debug, info, warn, error)	info
PULSE_DISABLE_DOCKER_UPDATE_ACTIONS	Disable container image-update actions; does not disable start/stop/restart	false
PULSE_METRICS_DB_PATH	Optional path for only metrics.db, useful with tmpfs	/data/metrics.db
PULSE_METRICS_ROLLUP_INTERVAL	Metrics aggregation cadence; minimum 5 minutes	15m

Tip

: Set LOG_LEVEL=warn to reduce log volume while still capturing important events. Note: API tokens are managed in the UI and stored in api_tokens.json. Note: Plain text values in PULSE_AUTH_PASS are hashed for authentication at startup, but remain in the container environment and deployment file. Docker administrators can read those values. Prefer bootstrap setup; never share full docker inspect or resolved Compose output.

For SSD-sensitive installs, keep /data persistent and put only metrics history on tmpfs:

services:
  pulse:
    environment:
      PULSE_METRICS_DB_PATH: /metrics-tmpfs/metrics.db
    tmpfs:
      - /metrics-tmpfs:size=512m,uid=1000,gid=1000,mode=0700

Metrics history stored this way is lost on container restart.

Advanced: Resource Limits & Healthcheck

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

---

🔄 Updates

These steps update the Pulse server, not the containers it monitors. Record the current image and take a consistent private backup of the mounted Pulse data before changing it. Keep the previous image and data backup for recovery; do not delete volumes.

docker inspect pulse --format '{{.Config.Image}} {{.Image}}'

Run commands from the original Compose project directory. First set the exact target in your Compose image: line, or persist PULSE_IMAGE in the project's .env if the file uses image: ${PULSE_IMAGE:-rcourtman/pulse:vX.Y.Z}. Setting PULSE_IMAGE has no effect on a hardcoded image line. Community uses rcourtman/pulse:vX.Y.Z; paid Pro installs must keep the private image and existing registry login from https://pulserelay.pro/download.html. Do not replace Pro with the Community image or post registry credentials.

For the pulse service in the examples above:

(
set -e
docker compose pull pulse
docker compose up -d --no-deps pulse
)

If pulling fails, stop rather than recreating with an unverified or old image. Pulling a different tag alone does not update your configured image. There is no need to bring the whole Compose project down. Use your actual service and container names if they differ; legacy docker-compose users can substitute that command name.

For docker run or an app UI, change the image in the existing saved deployment and recreate it with the same data mount, ports and settings; do not start a second Pulse against that data. Check the running image again, Pulse's displayed server version and service health after recreation. See rollback and backup scope before reverting a version: an image change alone does not undo data migrations.

---

🔄 Docker / Podman Updates

These actions update monitored containers, not the Pulse server. Pulse can detect image updates without command execution; applying an update requires a separately enabled command channel and administrator review. Leave command execution disabled when you only need monitoring.

Before updating a workload

• Plan for downtime: a running container is stopped and replaced, not updated in place. Check the application's upgrade and data-migration requirements.
• Take an independent, consistent backup of its application data, including volumes and bind mounts, using the application's backup procedure. The renamed old container is not a backup of mounted data: the replacement uses those same mounts and can change their contents.
• Keep the previous image identity and your deployment definition privately. For Compose, Yacht or another deployment manager, prefer that manager's update procedure so its saved definition records the intended image. Pulse's recreation does not edit your Compose file or manager's desired state.
• Do not use an update as a diagnostic test or start another container against the same writable data to check a failure.

How It Works

1. Update Detection: Pulse compares the local image digest with the latest digest from the container registry
2. Visual Indicator: Containers with available updates show a blue upward arrow icon
3. Reviewed Update: Review the target and approve the action, then verify the application yourself

Updating a Container

1. Open Docker → Overview (/docker/overview) and find the host and container
2. Look for containers with a blue update arrow (⬆️)
3. Click the update button and approve the action in the review dialog (admin approval required)
4. Pulse attempts to:
   • Pull the latest image
   • Stop the current container if it was running
   • Rename the original container with the _pulse_backup_ suffix
   • Recreate the container from its inspected configuration, reusing its data mounts
   • Start it only if the original was running, then perform a short runtime check
   • Schedule removal of the renamed old container after a successful update

Afterwards, check the actual image, container state, application readiness and data through your normal administration tools. A successful action is not an end-to-end application or data-integrity test.

Batch Updates

Updates run as reviewed per-container actions, so there is currently no bulk update flow: update each container individually with its own update button. The "Update all" button in the host drawer only points you to the per-container buttons.

Safety Features

• Temporary old container: the _pulse_backup_ name retains the old container, not a separate copy of its volumes or bind mounts. Current agents schedule removal five minutes after a successful update; periodic cleanup also removes old backup containers. Do not rely on a 15-minute recovery window or on a remaining container as a durable backup.
• Best-effort rollback: when recreation, network attachment or the early runtime check fails, Pulse attempts to restore the original name and running state. Removal, rename or restart can fail too. A failed banner does not prove that the original container is running or that no change occurred.
• Limited verification: the running replacement is inspected after a short wait and rejected if stopped or explicitly unhealthy. A missing healthcheck or a starting health status is not proof that the application is ready.
• Inspected configuration: Pulse reuses container settings and mounts; it does not reconcile your deployment manager or roll back application data migrations. Verify networks, ports, mounts and the application after the change.

If the result is failed or uncertain, check the current state before retrying. Retain the action error and time, old/new container and image identities, and any rollback error. Inspect these locally; do not post full docker inspect output, environments or registry credentials. Do not delete the old container or volumes to clear a warning. Recover through the application's and deployment manager's procedures using a verified matching data backup where required; returning to the old image alone does not undo a data migration.

Requirements

• Unified agent running on the Docker host with Docker monitoring enabled
• Command execution enabled on the agent (--enable-commands or PULSE_ENABLE_COMMANDS=true) — updates run as reviewed actions through the agent's command channel, the same as container lifecycle actions, and share their requirements and limitations (admin approval, authorization-plugin block)
• Agent must have Docker socket access (/var/run/docker.sock)
• Registry must be accessible for update detection (public registries work automatically)

Private Registries

For private registries, log in with Docker on the container host as the user the agent runs as (the installer's systemd service runs the agent as root, so use sudo docker login):

docker login registry.example.com

Pulling updates goes through the Docker daemon, which reads these credentials natively. Update detection reads the same credential store: config.json auths entries, configured credsStore/credHelpers credential helpers, and Podman's auth.json (REGISTRY_AUTH_FILE and DOCKER_CONFIG overrides are honored). The agent presents the stored login to the registry when it rejects anonymous digest checks, so private images get real update detection instead of a permanent failed check. Credentials never leave the host — they are only sent to the registry itself and are never reported to the Pulse server.

To keep update detection anonymous-only (no credential store reads, no credential helper execution), set PULSE_DISABLE_REGISTRY_CREDENTIALS=true (or pass --disable-registry-credentials) on the agent.

Paid Pulse Pro Docker installs use the private Pulse Pro registry rather than the public rcourtman/pulse image. Open https://pulserelay.pro/download.html, enter your activation key in the page and use its registry login instructions on the host that already runs Pulse. Persist the private image for both pull and recreation as described in server updates; an image override used for only the pull does not select it for the later recreation.

Disabling Update Features

Pulse provides granular control over update features via environment variables on the Pulse server:

Variable	Description
PULSE_DISABLE_DOCKER_UPDATE_ACTIONS	Disables image-update actions while still detecting updates. Start/stop/restart have separate controls.

Example - Disable image updates (continue detecting updates):

services:
  pulse:
    image: ${PULSE_IMAGE:-rcourtman/pulse:vX.Y.Z}
    environment:
      - PULSE_DISABLE_DOCKER_UPDATE_ACTIONS=true

This setting is not a monitoring-only security boundary: it does not disable container lifecycle actions or revoke agent command permissions. For monitoring-only installs, leave command execution disabled on the agent and do not grant command execution permission to monitoring tokens. See container lifecycle requirements.

To disable registry checks entirely, set PULSE_DISABLE_DOCKER_UPDATE_CHECKS=true on the agent.

You can also toggle "Hide Docker Update Buttons" from the UI in Settings → System → General under Docker / Podman updates.

---

▶️ Container Lifecycle Actions

Pulse can start, stop, and restart Docker / Podman containers directly from the UI. Running containers offer stop and restart; stopped containers offer start.

Requirements

• Pulse Agent installed on the container host (see Unified Agent) and currently connected
• Command execution enabled on the agent — it is disabled by default. Either:
  • start the agent with --enable-commands (or PULSE_ENABLE_COMMANDS=true), or
  • tick Enable Pulse command execution in Settings → Infrastructure before copying the install command, which adds the flag and grants the token the command execution permission
• Admin approval: every lifecycle action requires confirmation by an admin in the UI before it runs. The agent then verifies the container's state before the change and confirms it actually reached the requested state afterwards.

Limitations

• If the Docker daemon has authorization plugins configured, Pulse blocks all daemon-mutating commands on that host (see advisory GO-2026-4887) and the lifecycle buttons are not offered. Podman hosts are not affected.
• Actions are unavailable while the host's Docker inventory is stale or the agent is disconnected.

---

🛠️ Troubleshooting

• Forgot Password? Follow the password recovery guide. Update the active credential source; do not delete .env, remove the data volume or repeat setup. A deployment-supplied password overrides the generated file, and changing Docker's managed environment needs a recreate/redeploy, not just a restart. SSO accounts and temporary lockouts have separate paths.

• Logs

  docker logs -f pulse
  

• Shell Access

  docker exec -it pulse /bin/sh