https://github.com/easysoft/phpmicro
micro sfx SAPI for php
https://github.com/easysoft/phpmicro
Last synced: about 1 year ago
JSON representation
micro sfx SAPI for php
- Host: GitHub
- URL: https://github.com/easysoft/phpmicro
- Owner: easysoft
- License: apache-2.0
- Created: 2020-12-03T08:43:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T02:34:41.000Z (over 1 year ago)
- Last Synced: 2025-03-30T03:05:45.159Z (about 1 year ago)
- Language: C
- Size: 255 KB
- Stars: 282
- Watchers: 10
- Forks: 32
- Open Issues: 7
-
Metadata Files:
- Readme: Readme.EN.md
- License: LICENSE
Awesome Lists containing this project
README
# micro self-executable SAPI for PHP
[](Readme.md)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/dixyes/phpmicro/actions/workflows/tests.yml)
micro self-executable SAPI makes PHP self-executable.
Just concatenate micro.sfx and a random PHP source file or PHAR into a single file to use it.
## Compatibility
Currently, it only supports PHP8+ on Windows, Linux, and macOS (and maybe some BSDs).
## Fetch and Usage
A micro `micro.sfx` binary containing the minimal extensions set is built automatically in [Github Actions](actions). If you need more extensions, build your own micro or use [crazywhalecc/static-php-cli](https://github.com/crazywhalecc/static-php-cli) (swoole/swow/libevent) or grab one in [lwmbs actions](https://github.com/dixyes/lwmbs/actions)(swow)
To use it, simply concatenate the `micro.sfx` file and any PHP source.
For example: if the content of myawesomeapp.php is
```php
myawesomeapp
chmod 0755 ./myawesomeapp
./myawesomeapp
# shows "hello, this is my awesome app."
```
or Windows:
```batch
COPY /b \path\to\micro.sfx + myawesomeapp.php myawesomeapp.exe
myawesomeapp.exe
REM shows "hello, this is my awesome app."
```
## Build micro.sfx
### Preparation
1.Clone this repository into `sapi/micro` under the PHP source directory
```bash
# prepare PHP source
git clone --branch 'PHP-choose-a-release' https://github.com/php/php-src/ php-src
cd php-src
# at PHP source dir
git clone sapi/micro
```
2.Apply patches
Patches are placed in the "patches" directory. Choose patch(es) as you like, see [Readme.md](patches/Readme.md) in the patches dir for detail
Apply a patch:
```bash
# at PHP source dir
patch -p1 < sapi/micro/patches/
```
### UNIX-like Build
0.Prepare the build environment according to [the official PHP documents](https://www.php.net/manual/en/install.unix.php).
1.buildconf
```bash
# at PHP source dir
./buildconf --force
```
2.configure
```bash
# at PHP source dir
./configure
```
Options for reference:
`--disable-phpdbg --disable-cgi --disable-cli --disable-all --enable-micro --enable-phar --with-ffi --enable-zlib`
On Linux, libc compatibility can be a problem. To address this, micro provides two kinds of `configure` arguments:
- `--enable-micro=yes`or`--enable-micro`: this will make PIE shared ELF micro sfx, this kind of binary cannot be invoked cross libc (i.e. you cannot run such a binary which was built on alpine with musl on any glibc-based CentOS), but the binary can do ffi and PHP `dl()` function.
- `--enable-micro=all-static`: this will make full static ELF micro sfx, this kind of binary can even run barely on top of any linux kernel, but ffi/`dl()` is not supported.
3.make
```bash
# at PHP source dir
make micro
```
(`make all`(aka. `make`) may work also, but it is recommended to only build the micro SAPI.)
The built file will be located at sapi/micro/micro.sfx.
### Windows Build
0.Prepare the build environment according to [the official PHP documents](https://wiki.php.net/internals/windows/stepbystepbuild_sdk_2), you may also try [my scripts](https://github.com/dixyes/php-dev-windows-tool)
1.buildconf
```batch
# at PHP source dir
buildconf
```
2.configure
```batch
# at PHP source dir
configure
```
Options for reference:
`--disable-all --disable-zts --enable-micro --enable-phar --with-ffi --enable-zlib`
3.make
Due to the PHP build system's inability to statically build PHP binaries on Windows, you cannot build micro with `nmake` command.
```batch
# at PHP source dir
nmake micro
```
That built file is at `\\\\micro.sfx`.
## Optimizations
The Hugepages optimization for Linux in the PHP build system results in a large sfx size. If you do not take advantage of Hugepages, use `disable_huge_page.patch` to reduce the sfx size.
A static build under Linux requires libc. The most common libc, glibc, may be large, so musl is recommended instead. Manually installed musl or some distros provided musl will provide `musl-gcc` or `musl-clang` wrapper, use one of them before configure by specify CC/CXX environs, for example
```bash
# ./buildconf things...
export CC=musl-gcc
export CXX=musl-gcc
# ./configure things
# make things
```
We aim to have all dependencies statically linked into sfx. However, some distro does not provide static versions of them. We may manually build them.
libffi for example (note that the ffi extension is not supported in `all-static` builds):
```bash
# fetch sources througe git
git clone https://github.com/libffi/libffi
cd libffi
git checkout
autoreconf -i
# or download tarball
wget
tar xf
cd
# if we use musl
export CC=musl-gcc
export CXX=musl-gcc
# build, install it
./configure --prefix=/my/prefered/path &&
make -j`nproc` &&
make install
```
then build micro as
```bash
# ./buildconf things...
# export CC=musl-xxx things...
export PKG_CONFIG_PATH=/my/prefered/path/lib/pkgconfig
# ./configure things
# make things
```
## Some details
### INI settings
See wiki：[INI-settings](https://github.com/easysoft/phpmicro/wiki/INI-settings)(TODO: en version)
### PHP_BINARY constant
In micro, the `PHP_BINARY` constant is an empty string. You can modify it using an ini setting: `micro.php_binary=somestring`
## OSS License
```plain
Copyright 2020 Longyan
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
## remind me to update the English readme and fix typos and strange or offensive expressions