portrino / cms-observer-client-typo3
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
Requires
- php: ^8.2
- composer-runtime-api: ^2.0
- doctrine/dbal: ^3.9 || ^4.4
- psr/http-message: ^1.1 || ^2.0
- symfony/console: ^6.4 || ^7.0
- typo3/cms-core: ^12.4 || ^13.4 || ^14.3
Requires (Dev)
- a9f/fractor-composer-json: ^1.0
- a9f/typo3-fractor: ^1.0
- armin/editorconfig-cli: ^2.2
- ergebnis/composer-normalize: ^2.30
- friendsofphp/php-cs-fixer: ^3.14
- helmich/typo3-typoscript-lint: ^3.1
- phpstan/phpstan: ^2.0
- phpstan/phpstan-deprecation-rules: ^2.0
- phpstan/phpstan-strict-rules: ^2.0
- phpunit/phpunit: ^11.5
- seld/jsonlint: ^1.9
- shipmonk/composer-dependency-analyser: ^1.8
- spaze/phpstan-disallowed-calls: ^4.0
- ssch/typo3-rector: ^3.0
- tomasvotruba/cognitive-complexity: ^1.0
- tomasvotruba/type-coverage: ^2.0
- typo3/coding-standards: ^0.9
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-14 23:58:55 UTC
README
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_clientand install the extension.
or
- Download the zip file from TYPO3 extension repository (TER).
π§ Configuration
-
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>" -
In the TYPO3 backend, go to Admin Tools > Settings > Extension Configuration > cms_observer_client and set:
apiUrlβ the Observer's base URL, must usehttps://(no trailing slash)tokenβ the token from step 1
Alternatively set the environment variables
CMS_OBSERVER_API_URLandCMS_OBSERVER_TOKEN. They take precedence over the extension configuration, so a sharedsettings.phpcan 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.