Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Brew & manage PHP versions in pure PHP at HOME
PHP Shell Other
Failed to load latest commit information.
assets Update release json
bin Fixed no-progress option issue #389
completion update completion
flavors/command Import command flavor for genphp
screenshots Add screenshots
scripts Merge branch 'master' into develop
sh Moved files to sh directory
shell remove unused var
src/PhpBrew dries `ext clean` + gives status in all failure cases
tests fixes build #513
.gitignore ignore ctags file generated by tests
.hhconfig Add .hhconfig for vim-hack plugin
.pharcc.yml EOF with new line [skip ci]
.travis.yml cache .phpbrew/php directory
CHANGES.md bumps version && regenerates phar
CONTRIBUTORS.md Replace patches using sed and perl with pure php.
Doxyfile Update Doxyfile for QUIET mode
HACKING.md Add CONTRIBUTORS and HACKING.md
LICENSE Happy New Year
Makefile Remove onion dependency, we now have a built-in compile command.
README.ja.md add a description about disabling the settings for apache modules.
README.md bumps version and regenerates phar
build.xml Use bin/phpbrew to test cli commands for Jenkins
composer.json also bump the version set in composer.json
package.ini Bump version to 1.9.3
package.xml Update package.xml
phpbrew bumps to 1.19.7 and rebuild completion files
phpdox.xml Add build.xml for Jenkins CI
phprelease.ini Remove scripts/compile from phprelease.ini since it doesn't exist any…
phpunit.xml.dist Update phpunit.xml.dist config
todo.md update todo

README.md

PHPBrew

Read this in other languages: English, 日本語.

Build Status Coverage Status

phpbrew builds and installs multiple version php(s) in your $HOME directory.

phpbrew also manage the environment variables, so you can use, switch php version whenever you need.

What phpbrew can do for you:

  • Configure options are simplified into variants, no worries about the path anymore!
  • Build php with different variants like PDO, mysql, sqlite, debug ...etc.
  • Compile apache php module and separate them by different versions.
  • Build and install php(s) in your home directory, so you don't need root permission.
  • Switch versions very easily and is integrated with bash/zsh shell.
  • Automatic feature detection.
  • Install & enable php extensions into current environment with ease.
  • Install multiple php into system-wide environment.
  • Path detection optimization for HomeBrew and MacPorts.

Requirement

Please see Requirement before you get started. you need to install some development packages for building PHP.

Install phpbrew

Just download it:

curl -L -O https://github.com/phpbrew/phpbrew/raw/master/phpbrew
chmod +x phpbrew
sudo mv phpbrew /usr/bin/phpbrew

Basic usage

Init a bash script for your shell environment:

$ phpbrew init

Then add these lines to your .bashrc or .zshrc file:

$ source ~/.phpbrew/bashrc

You may setup your prefered default prefix for looking up libraries, available options are macports, homebrew, debian, ubuntu or a custom path:

For Homebrew users:

$ phpbrew lookup-prefix homebrew

For Macports users:

$ phpbrew lookup-prefix macports

To list known versions:

$ phpbrew known
5.6:  5.6.1, 5.6.0 ...
5.5:  5.5.17, 5.5.16, 5.5.15, 5.5.14, 5.5.13, 5.5.12, 5.5.11, 5.5.10 ...
5.4:  5.4.33, 5.4.32, 5.4.31, 5.4.30, 5.4.29, 5.4.28, 5.4.27, 5.4.26 ...
5.3:  5.3.29, 5.3.28, 5.3.27, 5.3.26, 5.3.25, 5.3.24, 5.3.23, 5.3.22 ...

To list known older versions (less than 5.3):

$ phpbrew known --old

To update the release info:

$ phpbrew update

Build And Install

Simply build and install PHP with default variant:

$ phpbrew install 5.4.0 +default

Here we suggest default variant set, which includes most commonly used variants, if you need a minimum install, just remove the default variant set.

You can enable parallel compilation by passing -j or --jobs option and the following is an example:

$ phpbrew install -j $(nproc) 5.4.0 +default

With tests:

$ phpbrew install --test 5.4.0

With debug messages:

$ phpbrew -d install --test 5.4.0

To install older versions (less than 5.3):

$ phpbrew install --old 5.2.13

To install the next (unstable) version:

$ phpbrew install next as php-7.0.0

Clean up build

$ phpbrew clean

Variants

PHPBrew arranges configure options for you, you can simply specify variant name, and phpbrew will detect include paths and build options for configuring.

PHPBrew provides default variants and some virtual variants, to the default variants, which includes the most commonly used variants, to the virtual variants, which defines a variant set, you may use one virtual variant to enable multiple variants at one time.

To check out what is included in these variants, simply run variants subcommand to list these variants:

$ phpbrew variants
Variants:
  all, apxs2, bcmath, bz2, calendar, cgi, cli, ctype, dba, debug, dom, embed,
  exif, fileinfo, filter, fpm, ftp, gcov, gd, gettext, hash, iconv, icu,
  imap, intl, ipc, ipv6, json, kerberos, mbregex, mbstring, mcrypt, mhash,
  mysql, openssl, pcntl, pcre, pdo, pgsql, phar, posix, readline, session,
  soap, sockets, sqlite, tidy, tokenizer, xml_all, xmlrpc, zip, zlib, gmp


Virtual variants:
  dbs:      sqlite, mysql, pgsql, pdo
  mb:       mbstring, mbregex
  neutral:
  default:  filter, dom, bcmath, ctype, mhash, fileinfo, pdo, posix, ipc,
            pcntl, bz2, zip, cli, json, mbstring, mbregex, calendar, sockets, readline,
            xml_all

Using variants to build PHP:

  phpbrew install 5.3.10 +default
  phpbrew install 5.3.10 +mysql +pdo
  phpbrew install 5.3.10 +mysql +pdo +apxs2
  phpbrew install 5.3.10 +mysql +pdo +apxs2=/usr/bin/apxs2 

To enable one variant, simply add a prefix + before the variant name, eg

+mysql

To disable one variant, simply add a prefix - before the variant name.

-debug

For example, if we want to build PHP with the default options and database supports (mysql, sqlite, postgresql), you may simply run:

$ phpbrew install 5.4.5 +default+dbs

You may also build PHP with extra variants:

$ phpbrew install 5.3.10 +mysql+sqlite+cgi

$ phpbrew install 5.3.10 +mysql+debug+pgsql +apxs2

$ phpbrew install 5.3.10 +pdo +mysql +pgsql +apxs2=/usr/bin/apxs2

To build PHP with pgsql (Postgresql) extension:

$ phpbrew install 5.4.1 +pgsql+pdo

Or build pgsql extension with postgresql base dir on Mac OS X:

$ phpbrew install 5.4.1 +pdo+pgsql=/opt/local/lib/postgresql91/bin

The pgsql path is the location of pg_config, you could find pg_config in the /opt/local/lib/postgresql91/bin

To build PHP with neutral compile options, you can specify neutral virtual variant, which means that phpbrew doesn't add any additional compile options including --disable-all. But some options(for example --enable-libxml) are still automatically added to support pear installation. You can build PHP with neutral:

$ phpbrew install 5.4.1 +neutral

For more details, please check out PHPBrew Cookbook.

Extra Configure Options

To pass extra configure arguments, you can do this:

$ phpbrew install 5.3.10 +mysql +sqlite -- \
    --enable-ftp --apxs2=/opt/local/apache2/bin/apxs

Use And Switch

Use (switch version temporarily):

$ phpbrew use 5.4.22

Switch PHP version (switch default version)

$ phpbrew switch 5.4.18

Turn Off:

$ phpbrew off

If you enable apache PHP modules, remember to comment out or remove the settings.

$ sudo vim /etc/httpd/conf/httpd.conf
# LoadModule php5_module        /usr/lib/httpd/modules/libphp5.3.21.so
# LoadModule php5_module        /usr/lib/httpd/modules/libphp5.3.20.so

List installed PHP

$ phpbrew list

The Extension Installer

You can also install PHP extension with ease, either the extensions shipped with PHP source code or even from PECL.

If the extension directory is found in PHP source, PHPBrew automatically switch into the PHP source directory and install the extension.

If the extension directory is not found in PHP source, PHPBrew fetch the extension package from PECL http://pecl.php.net.

PHPBrew also creates extension config to enable the installed extension, so you don't need to write the config file to enable it by hands. The extension config directory is in:

~/.phpbrew/php/php-{version}/var/db

Installing Extension - The Most Simple Way

$ phpbrew ext install APC
$ phpbrew ext install memcache

Installing Extension With Version

To install extensions with stability tag:

$ phpbrew ext install xdebug stable
$ phpbrew ext install xdebug latest
$ phpbrew ext install xdebug beta

To install extensions with version name:

$ phpbrew ext install xdebug 2.0.1

To install extensions with customized options:

$ phpbrew ext install yaml -- --with-yaml=/opt/local

Enabling Extension

You can also install extension via PECL and enable it manually:

pecl install mongo
phpbrew ext enable mongo

The ext enable command allows you to create a config {current php base}/var/db/{extension name}.ini to enable the extension.

Configuring the php.ini for current php version

Simply run:

$ phpbrew config

You may specify the EDITOR environment variable to your favorite editor:

export EDITOR=vim
phpbrew config

Upgrade phpbrew

To upgrade phpbrew, you may simply run the self-update command, this command enables you to install the latest version of master branch from github:

$ phpbrew self-update

The Installed PHP(s)

The installed phps are located in ~/.phpbrew/php, for example, php 5.4.20 is located at:

~/.phpbrew/php/5.4.20/bin/php

And you should put your configuration file in:

~/.phpbrew/php/5.4.20/etc/php.ini

Extension configuration files should be put in:

~/.phpbrew/php/5.4.20/var/db
~/.phpbrew/php/5.4.20/var/db/xdebug.ini
~/.phpbrew/php/5.4.20/var/db/apc.ini
~/.phpbrew/php/5.4.20/var/db/memcache.ini
... etc

Quick commands to switch between directories

Switching to PHP build directory

$ phpbrew build-dir

Switching to PHP dist directory

$ phpbrew dist-dir

Switching to PHP etc directory

$ phpbrew etc-dir

Switching to PHP var directory

$ phpbrew var-dir

PHP FPM

phpbrew also provides useful fpm managing sub-commands. to use them, please remember to enable +fpm variant when building your own php.

To start php-fpm, simply type:

$ phpbrew fpm start

To stop php-fpm, type:

$ phpbrew fpm stop

To show php-fpm modules:

phpbrew fpm module

To test php-fpm config:

phpbrew fpm test

To edit php-fpm config:

phpbrew fpm config

The installed php-fpm is located in ~/.phpbrew/php/php-*/sbin.

The correspond php-fpm.conf is lcoated in ~/.phpbrew/php/php-*/etc/php-fpm.conf.default, you may copy the default config file to the desired location. e.g.,

cp -v ~/.phpbrew/php/php-*/etc/php-fpm.conf.default
    ~/.phpbrew/php/php-*/etc/php-fpm.conf

php-fpm --php-ini {php config file} --fpm-config {fpm config file}

Installing Extra Component

Installing composer

$ phpbrew install-composer

Installing phpunit

phpbrew install-phpunit

Enabling Version Info Prompt

To add PHP version info in your shell prompt, you can use "PHPBREW_SET_PROMPT=1" variable.

The default is "PHPBREW_SET_PROMPT=0" (disable). To enable it, you can add this line to your ~/.bashrc file and put this line before you source ~/.phpbrew/bashrc.

export PHPBREW_SET_PROMPT=1

To embed version info in your prompt, you can use phpbrew_current_php_version shell function, which is defined in .phpbrew/bashrc. and you can set the version info in your PS1 var. e.g.

PS1=" \$(phpbrew_current_php_version) \$ "

Known Issues

  • For PHP-5.3+ versions, "Building intl 64-bit fails on OS X" https://bugs.php.net/bug.php?id=48795

  • To build PHP with GD extension, you need to specify your libpng dir and libjpeg dir, for example,

    $ phpbrew install php-5.4.10 +default +mysql +intl +gettext +apxs2=/usr/bin/apxs2 \ -- --with-libdir=lib/x86_64-linux-gnu \ --with-gd=shared \ --enable-gd-natf \ --with-jpeg-dir=/usr \ --with-png-dir=/usr

Troubleshooting

Please see TroubleShooting

FAQ

Q: How do I have the same version with different compile option?

A: Currently, you can install php5.x.x and rename the /Users/phpbrew/.phpbrew/php/php-5.x.x folder to the new name, for example, php-5.x.x-super , and install another php-5.3.3

Contribution

Please see Contribution

Documentation

Please see Wiki

Author

  • Yo-An Lin (c9s)

License

See LICENSE file.

Something went wrong with that request. Please try again.