Skip to content

Doc one click client install#5663

Draft
catalinaadam wants to merge 5 commits into
doc-3.9.0from
doc-one-click-client-install
Draft

Doc one click client install#5663
catalinaadam wants to merge 5 commits into
doc-3.9.0from
doc-one-click-client-install

Conversation

@catalinaadam

Copy link
Copy Markdown
Contributor

Ticket number: PMM-0

Feature build: SUBMODULES-0

If this PR adds, removes or alters one or more API endpoints, please review and update the relevant API documentation as well:

  • API Docs updated

If this PR is related to other PRs, contributions, or ongoing work in this or other repositories, please reference them here:

  • Links to related work items (optional).

- A database monitoring user with the appropriate permissions for your database type.
- The PMM Server must be reachable from the database host over HTTPS.

## Generate and run the install command

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add some screenshots for this new page

sudo -E bash '/tmp/install-pmm-client.sh' \
--pmm-server-url 'https://service_token:<token>@<pmm-server>' \
--tech '<technology>'
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curl -fsSLk -o '/tmp/install-pmm-client.sh' 'https:///pmm-static/install-pmm-client.sh'
sudo -E bash '/tmp/install-pmm-client.sh'
--pmm-server-url 'https://service_token:@'
--tech 'technology'
--pmm-server-insecure-tls

Please refer this for the command

2. Select your database technology: **MySQL**, **PostgreSQL**, **MongoDB**, or **Valkey**.

For detailed instructions and more information on the command arguments, see the [HAProxy topic](../install-pmm/install-pmm-client/connect-database/haproxy.md).
3. Click **Generate token**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click "Generate short-lived token"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After wording changes it's "Generate install token"


4. Check the **PMM host** field. It is pre-filled with the current server's hostname. Change it only if your database host connects to PMM Server at a different address. Do not include http/https or paths.

5. Click **Generate install token**. PMM creates a temporary Admin-level token and fills it into the **Service token** field automatically. The token expires in 15 minutes. Do not share the generated command as it contains an Admin-level token.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click "Generate short-lived token"

{ .power-number}

=== ":material-debian: Debian-based"
Once PMM Server is running, install PMM Client on your database host and connect your first database using the **Quick-Install PMM Client** page in the PMM UI.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since "One-Click Install" isn't production ready, do we want to advertise for a quickstart?

2. Select your database technology: **MySQL**, **PostgreSQL**, **MongoDB**, or **Valkey**.

For detailed instructions and more information on the command arguments, see the [HAProxy topic](../install-pmm/install-pmm-client/connect-database/haproxy.md).
3. Click **Generate token**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After wording changes it's "Generate install token"

@catalinaadam
catalinaadam marked this pull request as draft July 21, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants