Quick Start Guide

This guide gives you a high-level overview of the steps required to get PMP4PG up and running — from installation to monitoring your first PostgreSQL server.

For detailed instructions on each step, follow the links to the dedicated sections.

Overview

Setting up PMP4PG involves four main phases:

Phase 1 — Set up the repository
         ↓
Phase 2 — Deploy the backend and frontend
         ↓
Phase 3 — Deploy an agent on a PostgreSQL server
         ↓
Phase 4 — Connect and start monitoring

Phase 1 — Set up the Repository

The PMP repository is a PostgreSQL database that stores all metrics collected by the agents.

Install PostgreSQL 14+ and TimescaleDB on your repository host
Create a dedicated database and user for PMP4PG
Run the schema initialization script

# Create the PMP repository database
psql -U postgres -c "CREATE DATABASE pmp4pg_repo;"
psql -U postgres -c "CREATE USER pmp4pg WITH PASSWORD 'your_password';"
psql -U postgres -c "GRANT ALL PRIVILEGES ON DATABASE pmp4pg_repo TO pmp4pg;"

# Initialize the schema
psql -U pmp4pg -d pmp4pg_repo -f pmp4pg-schema-v1.0.0.sql

📖 Full details → Repository Setup

Phase 2 — Deploy the Backend and Frontend

Backend

Copy pmp4pg-backend-v1.0.0.jar to your server
Configure application.yml with your repository connection details
Start the backend service

# Start the backend
java -jar pmp4pg-backend-v1.0.0.jar --spring.config.location=application.yml

📖 Full details → Backend Installation

Frontend

Extract pmp4pg-frontend-v1.0.0.tar.gz to your web server document root
Configure Nginx to serve the Angular app and proxy API requests to the backend
Reload Nginx

# Extract frontend bundle
tar -xzf pmp4pg-frontend-v1.0.0.tar.gz -C /var/www/pmp4pg

# Reload Nginx
systemctl reload nginx

📖 Full details → Frontend Installation

Phase 3 — Deploy an Agent

Repeat this phase for each PostgreSQL server you want to monitor.

Copy the agent binary to the target server
Create the monitoring user in PostgreSQL
Configure config.yml with the PostgreSQL connection and backend details
Register the agent with the platform (first run)
Start the agent as a system service

# Extract the agent
tar -xzf pmp4pg-agent-v1.0.0-linux-amd64.tar.gz -C /opt/pmp4pg-agent

# Run registration (first time only)
./pmp4pg-agent --config config.yml --register

# Start the agent service
systemctl enable --now pmp4pg-agent

📖 Full details → Agent Installation

Phase 4 — Connect and Start Monitoring

Open your browser and navigate to http://pmp.data-resilience.fr
Log in with your administrator credentials
The newly registered server will appear in the Global Dashboard
Click on the server to access Server Detail, ASH Viewer, AWR Viewer and Trends

{screenshot: quick-start-first-login}

📖 Full details → Accessing the Platform

Estimated Setup Time

Task	Estimated Time
Repository setup	~15 minutes
Backend deployment	~10 minutes
Frontend deployment	~10 minutes
First agent deployment	~10 minutes
Total (first install)	~45 minutes

Additional agent deployments take approximately 5–10 minutes each once you have a working config.yml template.

Next Steps

Ready to go deeper? Follow the full installation guide:

Overview​

Phase 1 — Set up the Repository​

Phase 2 — Deploy the Backend and Frontend​

Backend​

Frontend​

Phase 3 — Deploy an Agent​

Phase 4 — Connect and Start Monitoring​

Estimated Setup Time​

Next Steps​