PHP-FPM 8.1 on OpenBSD 7.3
Tags: php, phpfpm, openbsd, httpd
Published: 2023-05-07 06:22:30

## Summary

To my belief, [OpenBSD](https://www.openbsd.org/) 🐡 and their community support [PHP](https://www.php.net/) Web services well thankfully.

The core package is offered as pre-compiled binary through Ports packages system. In addition, important softwares such as [extensions](https://www.php.net/manual/extensions.php), [Composer](https://getcomposer.org/) and [PECL](https://pecl.php.net/) libraries are available. So are frameworks such as [NextCloud](https://nextcloud.com/) and [Zabbix](https://www.zabbix.com/).

Moreover, when it is integrated with OpenBSD [httpd](https://man.openbsd.org/httpd.8), its `chroot` helps to keep servers secure. Of course, it is also able to additionally integrate them with [relayd](https://man.openbsd.org/relayd.8).

Well, [PHP-FPM](https://php-fpm.org/), PHP FastCGI Process Manager, is a part of PHP package in OpenBSD packages.
Installing PHP (`php-?.?` due to the version), therefore, comes with `php??_fpm` automatically 🙌

This post shows how to install it and configure as a server.

### Environment

- OS: OpenBSD [7.3](https://www.openbsd.org/73.html)
- Web: OpenBSD httpd
  - Reference: [How to set it up](https://obsd.solutions/en/blog/2023/05/06/openbsd-httpd-73-web-server/index.html)
- PHP: [8.1](https://www.php.net/releases/8.1/) with PHP-FPM

<center>✿ ✿ ✿</center>

## Tutorial

### Install PHP

First, install the main package:

```console
$ doas pkg_add php
```

You will be asked:

```
quirks-6.121 signed on 2023-04-26T08:37:06Z
Ambiguous: choose package for php
a	0: <None>
	1: php-8.0.28p1
	2: php-8.1.18
	3: php-8.2.5
Your choice: 2
```

I chose PHP 8.1 this moment.
Besides, you can check the lifetime of each version [here](https://www.php.net/supported-versions.php).

The result was:

```console
php-8.1.18:argon2-20190702: ok
php-8.1.18:libsodium-1.0.18p1: ok
php-8.1.18:oniguruma-6.9.8: ok
php-8.1.18:femail-1.0p1: ok
php-8.1.18:femail-chroot-1.0p3: ok
php-8.1.18:capstone-4.0.2: ok
php-8.1.18: ok
The following new rcscripts were installed: /etc/rc.d/php81_fpm
See rcctl(8) for details.
New and changed readme(s):
	/usr/local/share/doc/pkg-readmes/femail-chroot
	/usr/local/share/doc/pkg-readmes/php-8.1
```

You should see `php81_fpm` come along with `php-8.1` !!

### Configure PHP

These directories/files are generated:

```console
$ ls /etc/php*
/etc/php-8.1.ini    /etc/php-fpm.conf

/etc/php-8.1:

/etc/php-8.1.sample:
opcache.ini

/etc/php-fpm.d:
```

Edit `.ini` or `.conf` file(s) as needed.

For examples, edit:

```console
$ doas nvim /etc/php-8.1.ini
```

like:

```diff
- post_max_size = 8M
+ post_max_size = 30M
  (...)
- upload_max_filesize = 2M
+ upload_max_filesize = 24M
  (...)
- allow_url_fopen = Off
+ ; for composer, disabled in php-fpm
+ allow_url_fopen = On
```

Also, edit:

```console
$ doas nvim /etc/php-fpm.conf
```

to append to the bottom:

```diff
+ ; set On in php.ini for composer, therefore:
+ php_admin_value[allow_url_fopen] = Off
```

### Activate extensions (Optional)

The file(s) in `php-8.1.sample` are PHP extensions.
According to your necessity, create symbolic link to each of them in `/etc/php-8.1/`, which will activate the extensions:

```console
$ doas ln -sf /etc/php-8.1.sample/${ini} /etc/php-8.1/
```

For small reference, with more files which have to be dealt with, you can use loop-processing with your shell 😉 For examples:

```console
$ # case ksh:
$ for x in $(ls /etc/php-8.1.sample/*); do doas ln -sf $x /etc/php-8.1/; done
$ # case fish:
$ for x in /etc/php-8.1.sample/*; doas ln -sf $x /etc/php-8.1/; end
```

### Configure PHP-FPM

OK. We're ready.

The pkg-readme of PHP 8.1 was obtanined in installation of PHP as `/usr/local/share/doc/pkg-readmes/php-8.1`, which says:

> The main OpenBSD php packages include php-fpm, FastCGI Process Manager.
> This manages pools of FastCGI processes: starts/restarts them and
> maintains a minimum and maximum number of spare processes as
> configured. You can use rcctl(8) to enable php-fpm at boot,
> and start it at runtime:
> 
>   `rcctl enable php81_fpm`
>   `rcctl start php81_fpm`

Let's activate the daemon:

```console
$ doas rcctl enable php81_fpm
```

For another small reference, it appends or modifies the line in `/etc/rc.conf.local`:

```diff
+ pkg_scripts=php81_fpm
```

Now it's time to start the daemon:

```console
$ doas rcctl start php81_fpm
```

```console
php81_fpm(ok)
```

OK 😄

### Usage

Next, we have to set up a web server for them.

*Only if* you haven't configured httpd, copy the `.conf` file from the examples OpenBSD offers as below:

```console
$ doas cp -p /etc/examples/httpd.conf /etc/
```

Well, edit [`/etc/httpd.conf`](https://man.openbsd.org/httpd.conf.5) to add **`fastcgi socket`** definitions in some [SERVERS](https://man.openbsd.org/httpd.conf.5#SERVERS) section like this:

```apache
server "default" {
    listen on * port 80
    #listen on * port 443

    root "/htdocs"
    directory index index.php

    location "/*.php" { 
        fastcgi socket "/run/php-fpm.sock"
    }
    location "/*.php[/?]*" { 
        fastcgi socket "/run/php-fpm.sock"
    } 
}
```

Note that [`chroot`](https://man.openbsd.org/httpd.conf.5#chroot) works in this context 💡    
Therefore, `fastcgi socket "/run/php-fpm.sock"` in `/etc/httpd.conf` actually means `fastcgi socket "/var/www/run/php-fpm.sock"`.
This is the same to that `root "/htdocs"` means `"/var/www/htdocs"`.

## Concolusion

Let's make `/var/www/htdocs/index.php` for testing:

```console
$ echo "<?php phpinfo(1); ?>" | \
      doas tee "/var/www/htdocs/index.php"
$ # delete it afterwards:
$ #doas rm /var/www/htdocs/index.php
```

Connecting to your host with browser will show the general information !!

![php-fpm-works](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/62w96joewm0awy7qkz5l.png)

PHP 8.1 on OpenBSD 7.3 🌻

<center>✿ ✿ ✿</center>

Happy serving ✨☕✨