Search by

portrino / cms-observer-client-typo3

portrino-dev

CMS Observer Client - Reports TYPO3 core, PHP/DB version and installed extensions to a CMS Observer instance

Package info

github.com/portrino/cms-observer-client-typo3

Language:Shell

Type:typo3-cms-extension

pkg:composer/portrino/cms-observer-client-typo3

Statistics

Installs: 2

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.1.0 2026-11-14 23:57 UTC

This package is auto-updated.

Last update: 2026-11-14 23:58:55 UTC


README

Latest Stable Version TYPO3 12.4 13.4 14.3 PHP 8.2 - 8.5 Total Downloads Monthly Downloads License CI

This extension provides a client to report a site's TYPO3 core version, PHP + DB versions, and installed extension versions to a central CMS Observer instance.

Important

Without a central CMS Observer instance this extension is somewhat useless. So setup your central CMS Observer instance first and then connect any number of TYPO3 instances by using this client.

πŸ”₯ Installation

Composer

The recommended way to install the extension is using composer.

Run the following command within your Composer based TYPO3 project:

composer require portrino/cms-observer-client-typo3

TER

  • Open the TYPO3 Extension Manager, search for cms_observer_client and install the extension.

or

πŸ”§ Configuration

  1. On the Observer, register a new site (using command line or web interface) and copy the printed token:

    php bin/console app:site:create "<name>" typo3 "<site-url>"
    
  2. In the TYPO3 backend, go to Admin Tools > Settings > Extension Configuration > cms_observer_client and set:

    • apiUrl – the Observer's base URL, must use https:// (no trailing slash)
    • token – the token from step 1

    Alternatively set the environment variables CMS_OBSERVER_API_URL and CMS_OBSERVER_TOKEN. They take precedence over the extension configuration, so a shared settings.php can serve several environments.

Tip

Set the token per environment via CMS_OBSERVER_TOKEN, and give staging its own site on the Observer (or no token at all). Otherwise a staging copy, e.g. one whose scheduler task came along with a production database dump, reports as production. As a safety net the client sends the domains of all site configurations, and the Observer rejects reports whose domains don't match the site's URL. That only helps if staging has its own domain (e.g. via baseVariants).

πŸš€ Run

vendor/bin/typo3 cms-observer:push

Schedule it with TYPO3's built-in Scheduler using the Execute console commands task type (command: cms-observer:push), or via system cron.

To check what would be sent without sending it:

vendor/bin/typo3 cms-observer:push --dry-run

πŸ’Ž Credits

This project is highly inspired by the t3monitoring_client and the SYSSY monitoring with its syssy-typo3-extension.

πŸ§‘β€πŸ’» Contributing

Please have a look at CONTRIBUTING.md.