Plesk Widget

Plesk Widget 

With EXT:plesk_widget you get some cool EXT:dashboard widgets to show various information about your plesk server and PHP information of one specific domain.

Introduction 

Here you will learn what is possible with plesk_widget.

Installation 

Explains how to install this extension in Composer-based and Classic TYPO3 installations.

Configuration 

Learn how to configure this extension from an administrator perspective.

Adding widgets 

Learn how to add dashboard widgets from a user perspective.

Introduction 

What does it do? And for whom? 

This extension provides useful widgets for the TYPO3 Dashboard, offering a quick overview of various information from your Plesk system.

It's designed for administrators, developers, and TYPO3 integrators who manage Plesk-hosted websites. It can also serve as a monitoring tool for Plesk parameters, even if the TYPO3 installation itself is not hosted on a Plesk server.

The extension delivers some widgets for TYPO3 DashBoard to show various information from your website which is hosted on a plesk system.

  • Show current disk usage (%, MB or GB)
  • Show owner
  • Show some PHP information
  • Show internal/external IP addresses
  • Button to Plesk (auto-login). On failure, button will link to plesk login screen. After successful authorization with the configured username and password, the extension can generate an auto-login link via the Plesk API, allowing the user to be directly logged into their Plesk panel in the browser.

Screenshots 

DashBoard Widget showing free and used webspace

This widget shows a doughnut chart about your free and used webspace.

DashBoard Widget showing server information

This widget shows the registered user, some ip addresses, and a button with a direct login to your plesk customer panel. On error, this button will redirect you to the plesk login form.

DashBoard Widget showing PHP settings of a specific domain

This widget will only work, if you have configured a "domain" in extension settings. If set, you will see some interesting PHP settings of the selected domain.

Installation 

Install with Composer 

If your TYPO3 installation works in composer mode, please execute following command:

composer req stefanfroemken/plesk-widget
vendor/bin/typo3 extension:setup --extension=plesk_widget
Copied!

If you work with DDEV please execute this command:

ddev composer req stefanfroemken/plesk-widget
ddev exec vendor/bin/typo3 extension:setup --extension=plesk_widget
Copied!

See also Installing extensions, TYPO3 Getting started.

Install in Classic Mode 

On non composer based TYPO3 installations you can install plesk_widget still over the ExtensionManager:

  1. Login

    Login to backend of your TYPO3 installation as an administrator or system maintainer.

  2. Open ExtensionManager

    Click on Extensions from the left menu to open the ExtensionManager.

  3. Update Extensions

    Choose Get Extensions from the upper selectbox and click on the Update now button at the upper right.

  4. Install plesk_widget

    Use the search field to find plesk_widget. Choose the plesk_widget line from the search result and click on the cloud icon to install plesk_widget.

Next step 

Configure plesk_widget.

Configuration 

Configuring Plesk Server Access 

The plesk_widget extension uses dedicated records to store Plesk server access information. This allows you to configure multiple Plesk servers and select them individually for your dashboard widgets.

To configure a Plesk server:

  1. Navigate to the TYPO3 backend module Records to manage your records. These records (type Plesk Server) can only be created on the root page (PID 0) and are therefore only manageable by a TYPO3 administrator.
  2. Create a new record of type Plesk Server.

  3. Fill in the following fields:

    title

    title
    Type
    string
    Required
    true

    A descriptive title for this Plesk server configuration. This title will be displayed when selecting the server in dashboard widgets.

    Example: My Main Plesk Server

    host

    host
    Type
    string
    Required
    true

    Enter the hostname or IP address where this extension can access the Plesk system. If not known, you may try your website domain name (without scheme, path, and port).

    Example: plesk.example.com or 192.168.1.100

    port

    port
    Type
    int
    Default
    8443
    Required
    true

    Enter the port of your Plesk system.

    Example: 8443

    username

    username
    Type
    string
    Required
    true

    Set the username of your customer account on the Plesk system.

    Example: max.mustermann

    password

    password
    Type
    string
    Required
    true

    Set the password of your customer account on the Plesk system. This password is stored encrypted.

    domain

    domain
    Type
    string
    Required
    false

    If you want to use the dashboard widget that displays PHP settings, you must set this value to the exact domain name as it is registered in your customer account of the Plesk server.

    Example: 124.example.com

Configuring Dashboard Widgets 

When adding or editing a plesk_widget dashboard widget, you will be prompted to select one of your configured Plesk Server records.

Additionally, for widgets displaying disk usage, you can now specify the display format directly within the widget's settings:

  • Disk Usage Type: Choose whether to display disk usage in percent (%), MegaByte (MB), or GigaByte (GB). This setting is specific to each widget.

    Example: MB

Add Widget 

  1. Visit the new TYPO3 DashBoard

    In most cases you will find it in the left menu as the most upper menu entry. If not, please ask your admin to activate that module for you.

  2. Click the + icon at the lower right

    Shows an empty dashboard with the add-button at lower right

    After opening the dashboard you will find the add-button for widgets at the lower right.

  3. Switch to section System Information

    Please select category "System Information" from the left sidebar. On older TYPO3 versions this section was displayed as a tab above the widget selector area.

  4. Choose one of the plesk widgets

    Shows some panels with selectable widgets. Plesk widgets are highlighted

    Here you can choose one of the delivered widgets (marked in red rects) on to your dashboard.

Frequently Asked Questions (FAQ) 

I only have access to a Plesk Obsidian server. Can not say, if this extension will work on other plesk versions.

As a normal TYPO3 backend user it may happen that your administrator does not give you access rights to add these dashboard widgets. Please ask him to add the missing rights.

EXT:plesk_widget is working with the Plesk XML API. In user context there is no possibility to retrieve an access token. This is only possible as an Plesk administrator. Only he can create an access token for user context. Maybe I will find time to implement such a possibility in future. But I'm pretty sure most hosters wont generate an access token for you.

ChangeLog 

Version 3.0.1

  • Add builder pattern for ExtConf
  • Add functial tests for ExtConf

Version 3.0.0

  • Add TYPO3 13 compatibility

Version 2.0.1

  • Update documentation
  • Add images to documentation
  • New implementation to read from extension settings
  • Add functional tests

Version 2.0.0

  • Add TYPO3 12 compatibility
  • Remove TYPO3 11 compatibility
  • Remove TYPO3 10 compatibility
  • Add PHP Information Widget
  • Separate Server Information into its own widget

Version 1.2.1

  • Set EXT:dashboard as requirement

Version 1.2.0

  • Add TYPO3 11 compatibility
  • Remove PHP 7.2 and 7.3 compatibility
  • Add PHP 8.0 and 8.1 compatibility
  • Update Plesk SDK to version 1.1.2

Version 1.1.0

  • Button to Plesk will login customer automatically

Version 1.0.1

  • Add missing extension icon

Version 1.0.0

  • Initial upload

Upgrade Notes 

This document provides important information for upgrading the plesk_widget extension to newer versions. Please read the relevant sections carefully before performing an upgrade, especially if you are skipping multiple major versions.

General Upgrade Advice 

  • Always create a backup of your TYPO3 installation and database before upgrading.
  • Test upgrades on a development or staging environment first.
  • Clear all TYPO3 caches (frontend and backend) after an upgrade.
  • Run the "Upgrade Wizards" in the TYPO3 Install Tool if available.

Migration of Extension Configuration 

With the upgrade from version 3.x to 4.0.0, the way the plesk_widget extension is configured fundamentally changed.

Previously, global settings for Plesk server access (host, port, username, password, and the domain for PHP settings) were managed through the TYPO3 Install Tool (extension configuration). Additionally, the diskUsageType (%, MB, or GB) was also a global setting.

These global settings have been removed in favor of a more flexible, record-based configuration.

Breaking Changes 

  • Removed Global Extension Settings: The global extension settings for Plesk server access (host, port, username, password, domain) and diskUsageType are no longer available.
  • Plesk API Library Update: The underlying plesk/api-php-lib dependency has been updated from version 1.1.2 to 2.2.1. This updated version is also directly included for Classic/ZIP package installations.

Migration Steps 

  1. Create Plesk Server Records: You must now create dedicated "Plesk Server" records in the TYPO3 backend. These records (stored in the tx_pleskwidget_server table) can only be created on the root page (PID 0) and are therefore only manageable by a TYPO3 administrator. They will hold the host, port, username, password, and domain for each Plesk server you wish to monitor.
  2. Configure Widgets Individually: The diskUsageType setting is now configured directly within each individual Dashboard Widget. When adding or editing a Plesk widget, you will select the desired Plesk Server record and specify the disk usage display type.

Important: There is no automated upgrade wizard for this configuration migration. Users of the extension must manually re-create their Plesk server configurations as records and adjust their Dashboard Widgets accordingly.