Menu

Docker

The image is based on Alpine Linux and updated automatically.

It’s hosted on GitHub Container Registry.

Supported tags #

• 1, 1-php8.0, latest, latest-php8.0 (PHP 8.0)
• 1-php8.1, latest-php8.1 (PHP 8.1)
• 1-php8.2, latest-php8.2 (PHP 8.2)
• 1-php8.3, latest-php8.3 (PHP 8.3)
• nightly, nightly-php8.0 - latest dev version (PHP 8.0)
• nightly-php8.1 - latest dev version (PHP 8.1)
• nightly-php8.2 - latest dev version (PHP 8.2)
• nightly-php8.3 - latest dev version (PHP 8.3)

Installation #

docker pull ghcr.io/phpstan/phpstan

Alternatively, pull a specific version:

docker pull ghcr.io/phpstan/phpstan:1

If you have your own Docker image and just want to put PHPStan there, you can with this command in your Dockerfile:

COPY --from=ghcr.io/phpstan/phpstan:[TAG] /composer/vendor/phpstan/phpstan/phpstan.phar /app/phpstan.phar

Different PHP version? #

The images are based on PHP 8.0, 8.1, 8.2 or 8.3. To force PHPStan consider the analysed source code to be for a different PHP version, set phpVersion in your phpstan.neon:

parameters:
    phpVersion: 70400 # PHP 7.4

Usage #

We recommend to use the images as a shell alias shortcut.

To use phpstan everywhere in the CLI add this line to your ~/.zshrc, ~/.bashrc, or ~/.profile.

alias phpstan='docker run -v $PWD:/app --rm ghcr.io/phpstan/phpstan'

If you don’t have set the alias, use this command to run the container:

docker run --rm -v /path/to/app:/app ghcr.io/phpstan/phpstan [some arguments for PHPStan]

For example:

docker run --rm -v /path/to/app:/app ghcr.io/phpstan/phpstan analyse /app/src

Install PHPStan extensions #

If you need a PHPStan extension, for example phpstan/phpstan-phpunit, you can simply extend an existing image and add the relevant extension via Composer. In some cases you also need some additional PHP extensions like DOM. (see section below)

Here is an example Dockerfile for phpstan/phpstan-phpunit:

FROM ghcr.io/phpstan/phpstan:latest
RUN composer global require phpstan/phpstan-phpunit

You can update the phpstan.neon file in order to use the extension:

includes:
	- /composer/vendor/phpstan/phpstan-phpunit/extension.neon

Install PHP extensions #

Sometimes your codebase requires some additional PHP extensions like intl or maybe soap.

Therefore you need to know that our Docker image extends the official php:cli-alpine Docker image. So only the default built-in extensions are available (see below).

To solve this issue you can extend our Docker image in a custom Dockerfile like this, for example to add soap and intl:

FROM ghcr.io/phpstan/phpstan:latest
RUN apk --update --progress --no-cache add icu-dev libxml2-dev \
	&& docker-php-ext-install intl soap

Default built-in PHP extensions #

You can use the following command to determine which PHP extensions are already installed in the base image:

docker run --rm php:cli-alpine -m

This should give you an output like this:

[PHP Modules]
Core
ctype
curl
date
dom
fileinfo
filter
ftp
hash
iconv
json
libxml
mbstring
mysqlnd
openssl
pcre
PDO
pdo_sqlite
Phar
posix
readline
Reflection
session
SimpleXML
sodium
SPL
sqlite3
standard
tokenizer
xml
xmlreader
xmlwriter
zlib

[Zend Modules]

Edit this page on GitHub