Skip to content

Commit 18fd1d2

Browse files
committed
update docs
1 parent 724c0b1 commit 18fd1d2

2 files changed

Lines changed: 35 additions & 2 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ FrankenPHP can also be used as a standalone Go library to embed PHP in any app u
2020

2121
We provide static FrankenPHP binaries for Linux and macOS
2222
containing [PHP 8.4](https://www.php.net/releases/8.4/en.php) and most popular PHP extensions.
23+
Only use this option for development as FrankenPHP is compiled for maximum compatibility, rather than performance.
2324

2425
On Windows, use [WSL](https://learn.microsoft.com/windows/wsl/) to run FrankenPHP.
2526

@@ -43,6 +44,38 @@ You can also run command-line scripts with:
4344
frankenphp php-cli /path/to/your/script.php
4445
```
4546

47+
### RPM Packages
48+
49+
We offer RPM packages for all systems using `dnf`. To install, run:
50+
51+
```console
52+
sudo dnf install https://rpm.henderkes.com/static-php-1-0.noarch.rpm
53+
sudo dnf module enable php-zts:static-8.4 # 8.2-8.5 available
54+
sudo dnf install frankenphp
55+
# to install extensions:
56+
sudo dnf install php-zts-xdebug
57+
# if an extension is not available by default, install it with pie
58+
sudo dnf install php-zts-devel
59+
sudo pie install asgrim/example-pie-extension --with-php-config=php-config-zts
60+
```
61+
62+
### DEB Packages
63+
64+
We offer DEB packages for all Debian-based systems. To install, run:
65+
66+
```console
67+
. /etc/os-release && \
68+
sudo curl -fsSL https://key.henderkes.com/static-php.gpg -o /usr/share/keyrings/static-php.gpg && \
69+
echo "deb [signed-by=/usr/share/keyrings/static-php.gpg] https://deb.henderkes.com/ $VERSION_CODENAME main" | sudo tee /etc/apt/sources.list.d/static-php.list && \
70+
sudo apt update
71+
sudo apt install frankenphp
72+
# to install extensions:
73+
sudo apt install php-zts-xdebug
74+
# if an extension is not available by default, install it with pie
75+
sudo apt install php-zts-devel
76+
sudo pie install asgrim/example-pie-extension --with-php-config=php-config-zts
77+
```
78+
4679
### Docker
4780

4881
Alternatively, [Docker images](https://frankenphp.dev/docs/docker/) are available:

docs/performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ especially when compiled in ZTS mode (thread-safe), which is required for Franke
4141

4242
Also, [some bugs only happen when using musl](https://github.com/php/php-src/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3ABug+musl).
4343

44-
In production environments, we recommend using FrankenPHP linked against glibc.
44+
In production environments, we recommend using FrankenPHP linked against glibc, compiled with an appropriate optimization level.
4545

46-
This can be achieved by using the Debian Docker images (the default), downloading the -gnu suffix binary from our [Releases](https://github.com/php/frankenphp/releases), or by [compiling FrankenPHP from sources](compile.md).
46+
This can be achieved by using the Debian Docker images (the default), using our [.deb](https://debs.henderkes.com) or [.rpm](https://rpms.henderkes.com) packages, or by [compiling FrankenPHP from sources](compile.md).
4747

4848
Alternatively, we provide static musl binaries compiled with [the mimalloc allocator](https://github.com/microsoft/mimalloc), which alleviates the problems in threaded scenarios.
4949

0 commit comments

Comments
 (0)