PHPackages                             worlddirect/buildinfo - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps &amp; Deployment](/categories/devops)
4. /
5. worlddirect/buildinfo

ActiveTypo3-cms-extension[DevOps &amp; Deployment](/categories/devops)

worlddirect/buildinfo
=====================

Contains system information messages for showing informations about the current build.

2.1.0(3mo ago)07.2k↓46.2%11GPL-2.0-onlyPHPCI failing

Since Nov 12Pushed 3mo ago2 watchersCompare

[ Source](https://github.com/world-direct-cms/wd-ext-buildinfo)[ Packagist](https://packagist.org/packages/worlddirect/buildinfo)[ RSS](/packages/worlddirect-buildinfo/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (8)Versions (24)Used By (1)

TYPO3 Extension: Buildinfo
==========================

[](#typo3-extension-buildinfo)

[![TYPO3](https://camo.githubusercontent.com/88f378d23e239d0b909abc0eb7719b31bfb646f12b6f48c1bc519042994db581/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5459504f332d31312532302537432532303132253230253743253230313325323025374325323031342d6f72616e67652e737667)](https://typo3.org/)[![License](https://camo.githubusercontent.com/fc7ef0bd4e7daa962ca0072e865f9970ee5441edb26f5fca76d6e7f0d3805a70/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d47504c2d2d322e302d626c75652e737667)](LICENSE)

Display build information in the TYPO3 backend system information toolbar, including build numbers, timestamps, and Git version tags.

Table of Contents
-----------------

[](#table-of-contents)

- [TYPO3 Extension: Buildinfo](#typo3-extension-buildinfo)
    - [Table of Contents](#table-of-contents)
    - [Features](#features)
    - [Requirements](#requirements)
    - [Installation](#installation)
        - [Via Composer (recommended)](#via-composer-recommended)
    - [Configuration](#configuration)
        - [Extension Configuration](#extension-configuration)
        - [File Locations](#file-locations)
    - [How It Works](#how-it-works)
        - [Display Logic](#display-logic)
        - [Build Information Display](#build-information-display)
    - [Usage Examples](#usage-examples)
        - [CI/CD Integration](#cicd-integration)
            - [GitLab CI Example](#gitlab-ci-example)
            - [GitHub Actions Example](#github-actions-example)
        - [Docker Builds](#docker-builds)
            - [Dockerfile Example](#dockerfile-example)
        - [Manual Setup](#manual-setup)
        - [Advanced: Custom File Locations](#advanced-custom-file-locations)
    - [Troubleshooting](#troubleshooting)
        - [Information Not Showing](#information-not-showing)
        - [Wrong Timestamp Format](#wrong-timestamp-format)
        - [File Permission Errors](#file-permission-errors)
        - [Docker Container Issues](#docker-container-issues)
    - [Support](#support)
    - [License](#license)
    - [Credits](#credits)
        - [Development](#development)

Features
--------

[](#features)

- **Build Number Display**: Shows current build number in the backend toolbar
- **Build Timestamp**: Displays when the current build was created with age indicator
- **Git Version**: Shows the Git tag or commit version
- **Flexible Configuration**: Customize file locations via extension configuration
- **CI/CD Ready**: Perfect for Docker-based deployments with automated builds
- **Non-Intrusive**: Only displays information when files are present
- **Auto-Formatting**: Timestamps are automatically formatted as human-readable dates with age
- **Backend Integration**: Seamlessly integrates with TYPO3's system information toolbar

Requirements
------------

[](#requirements)

- TYPO3 11.0 - 14.9
- PHP 7.4 or higher

Installation
------------

[](#installation)

### Via Composer (recommended)

[](#via-composer-recommended)

```
composer require worlddirect/buildinfo
```

Configuration
-------------

[](#configuration)

### Extension Configuration

[](#extension-configuration)

Configure file locations through the TYPO3 Extension Manager or by adding to your site's configuration.

SettingDescriptionDefault**buildNumberFile**File containing the build number`buildNumber.txt`**buildTimestampFile**File containing the build timestamp (Unix)`buildTimestamp.txt`**gitVersionFile**File containing the Git version/tag`gitVersion.txt`**Important**: All file paths are relative to your TYPO3 project root directory (`Environment::getProjectPath()`).

### File Locations

[](#file-locations)

By default, the extension looks for files in the project root:

```
/var/www/html/
├── buildNumber.txt
├── buildTimestamp.txt
├── gitVersion.txt
├── public/
└── vendor/

```

You can configure different paths:

```
config/build/buildNumber.txt
config/build/buildTimestamp.txt
config/build/gitVersion.txt

```

How It Works
------------

[](#how-it-works)

### Display Logic

[](#display-logic)

The extension uses TYPO3's PSR-14 `SystemInformationToolbarCollectorEvent` to inject build information into the backend toolbar:

1. **File Check**: For each configured file, the extension checks if it exists
2. **Content Reading**: If a file exists, its content is read
3. **Formatting**: Timestamps are formatted as human-readable dates (e.g., "18.02.2026 14:30:00 (3 days old)")
4. **Toolbar Display**: Information is added to the system information dropdown
5. **Missing Files**: If a file doesn't exist, that information is simply not displayed

### Build Information Display

[](#build-information-display)

[![Buildinfo Screenshot](Resources/Public/Images/documentation/buildinfo-screenshot.png)](Resources/Public/Images/documentation/buildinfo-screenshot.png)

The toolbar shows:

- **Build Number**: Arbitrary version or build identifier
- **Build Date**: Formatted timestamp with age calculation
- **Git Version**: Tag, branch, or commit hash

Usage Examples
--------------

[](#usage-examples)

### CI/CD Integration

[](#cicd-integration)

#### GitLab CI Example

[](#gitlab-ci-example)

```
build:
  stage: build
  script:
    # Generate build number
    - echo "${CI_PIPELINE_ID}" > buildNumber.txt

    # Generate build timestamp
    - date +%s > buildTimestamp.txt

    # Generate Git version
    - git describe --tags --always > gitVersion.txt

    # Build your project
    - docker build -t myapp:${CI_PIPELINE_ID} .
```

#### GitHub Actions Example

[](#github-actions-example)

```
- name: Generate Build Information
  run: |
    echo "${{ github.run_number }}" > buildNumber.txt
    date +%s > buildTimestamp.txt
    git describe --tags --always > gitVersion.txt
```

### Docker Builds

[](#docker-builds)

#### Dockerfile Example

[](#dockerfile-example)

```
FROM php:8.3-apache

# Your build steps...

# Add build information
ARG BUILD_NUMBER
ARG GIT_VERSION
RUN echo "${BUILD_NUMBER}" > /var/www/html/buildNumber.txt && \
    date +%s > /var/www/html/buildTimestamp.txt && \
    echo "${GIT_VERSION}" > /var/www/html/gitVersion.txt

COPY . /var/www/html/
```

Build with:

```
docker build \
  --build-arg BUILD_NUMBER=$(git rev-list --count HEAD) \
  --build-arg GIT_VERSION=$(git describe --tags --always) \
  -t myapp:latest .
```

### Manual Setup

[](#manual-setup)

For development or manual deployments:

```
# Build number (e.g., incremental number or version)
echo "1.2.3" > buildNumber.txt

# Build timestamp (Unix timestamp)
date +%s > buildTimestamp.txt

# Git version (current tag or commit)
git describe --tags --always > gitVersion.txt
```

### Advanced: Custom File Locations

[](#advanced-custom-file-locations)

Configure via extension settings to use a custom directory:

```
builds/current/number.txt
builds/current/timestamp.txt
builds/current/version.txt

```

Troubleshooting
---------------

[](#troubleshooting)

### Information Not Showing

[](#information-not-showing)

**Problem**: Build information doesn't appear in the backend toolbar

**Solutions:**

- Verify files exist in the configured location (default: project root)
- Check file permissions (must be readable by web server)
- Ensure files contain valid content (not empty)
- Clear TYPO3 caches: **Admin Tools → Flush Caches**
- Check exact file paths in Extension Manager configuration

### Wrong Timestamp Format

[](#wrong-timestamp-format)

**Problem**: Timestamp shows incorrectly or not at all

**Solutions:**

- Ensure timestamp file contains a Unix timestamp (seconds since epoch)
- Generate with: `date +%s > buildTimestamp.txt`
- Verify file content is numeric: `cat buildTimestamp.txt`
- File should contain only the number, no extra whitespace or newlines

### File Permission Errors

[](#file-permission-errors)

**Problem**: PHP can't read the build information files

**Solutions:**

```
# Set appropriate permissions
chmod 644 buildNumber.txt buildTimestamp.txt gitVersion.txt

# Ensure web server user can read
chown www-data:www-data build*.txt gitVersion.txt
```

### Docker Container Issues

[](#docker-container-issues)

**Problem**: Files not present in Docker container

**Solutions:**

- Verify files are created during Docker build process
- Check files are in correct location within container
- Use `docker exec` to inspect container: `docker exec -it container ls -la /var/www/html/`
- Ensure files aren't excluded by `.dockerignore`

Support
-------

[](#support)

- **Issues**: [GitHub Issues](https://github.com/world-direct-cms/wd-ext-buildinfo/issues)
- **Source Code**: [GitHub Repository](https://github.com/world-direct-cms/wd-ext-buildinfo)
- **Author**: Klaus Hörmann-Engl
- **Company**: [World-Direct eBusiness solutions GmbH](https://www.world-direct.at)

License
-------

[](#license)

This extension is licensed under GPL-2.0-only. See [LICENSE](LICENSE) file for details.

Credits
-------

[](#credits)

Developed and maintained by **Klaus Hörmann-Engl** at [World-Direct eBusiness solutions GmbH](https://www.world-direct.at).

---

**Happy Building! 🚀**

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance82

Actively maintained with recent releases

Popularity24

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~87 days

Recently: every ~217 days

Total

23

Last Release

90d ago

Major Versions

0.5.7 → 1.0.02023-03-28

1.3.0 → 2.0.02025-03-11

### Community

Maintainers

![](https://www.gravatar.com/avatar/9507faf38c65faa7454c5a3b5241d005d0972612bcd071ef0503be63fac2d12a?d=identicon)[World-Direct CMS](/maintainers/World-Direct%20CMS)

![](https://www.gravatar.com/avatar/89a848e19f4fbebccdda1291250a7db9933315594a707a9becc0266f9030f58a?d=identicon)[hoermannklaus](/maintainers/hoermannklaus)

---

Top Contributors

[![hoermannklaus](https://avatars.githubusercontent.com/u/5311695?v=4)](https://github.com/hoermannklaus "hoermannklaus (71 commits)")

---

Tags

dockerversioningtypo3buildinfo

###  Code Quality

Static AnalysisPsalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/worlddirect-buildinfo/health.svg)

```
[![Health](https://phpackages.com/badges/worlddirect-buildinfo/health.svg)](https://phpackages.com/packages/worlddirect-buildinfo)
```

###  Alternatives

[spatie/docker

Run a docker container in your PHPUnit tests

478120.2k12](/packages/spatie-docker)[ryoluo/sail-ssl

Laravel Sail plugin to enable SSL (HTTPS) connection with Nginx.

188672.6k2](/packages/ryoluo-sail-ssl)[aschmelyun/fleet

Run multiple Laravel Sail websites on your local environment

33269.5k](/packages/aschmelyun-fleet)[testcontainers/testcontainers

Testcontainers implementation in PHP

199184.7k17](/packages/testcontainers-testcontainers)[sourcebroker/deployer-extended-typo3

Customisation for `sourcebroker/deployer-typo3-\*` stack

38201.6k2](/packages/sourcebroker-deployer-extended-typo3)[contributte/bootstrap

Extra contrib to nette/boostrap

111.5M3](/packages/contributte-bootstrap)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
