PHP/MySQL on OpenBSD's relayd-based httpd

Introduction

In OpenBSD 5.6, we were introduced to a new web server written specifically for OpenBSD, simply called httpd, which was based on relayd. We’re going to tackle setting up OpenBSD to serve “LAMP” web apps with its new httpd, MariaDB (a MySQL fork in OpenBSD Ports) and PHP-FPM.

As of
October 29, 2016, this guide has been updated for OpenBSD 6.0. It was tested on the amd64 and i386 architectures.

Preparation

First, install OpenBSD. Be sure to create a user-level account for yourself during the installation process, and I'd recommend disabling remote root logins while you're at it. This user account will be added to the wheel group. On BSD systems, wheel group is comparable to an administrator group, granting access to use the su command, etc. You can add other trusted users to this group later on.

OpenBSD no longer includes sudo in the base install as of 5.8 Release. It's still in ports if you must use it, but we'll be making use of the new doas(1) tool, which is similar to sudo in several ways. Create a file called /etc/doas.conf. The man pages for doas and doas.conf are quite helpful, but as a quick and dirty way to get up and running with doas, here's
a minimal doas.conf file. You can also add "nopass" after "permit" if you don't want to be prompted for a password. I don't recommend doing that to a production environment.

permit :wheel
If you have a hard time with typing "sudo" instead of "doas", you might want to add an alias to your shell profile.

Now, set up the package manager by adding an installpath line in /etc/pkg.conf. For best results, you should pick an OpenBSD mirror that is near you both physically and network-wise. Try pinging and tracerouting different mirrors in your country and seeing which ones have the best response times or the fewest hops. pkg.conf syntax has been simplified recently. You can simply include any http mirror that's accessible with "/pub/OpenBSD..." to the installpath variable. My pkg.conf looks like this:

installpath = mirrors.sonic.net

If you bought the OpenBSD media and have packages on CD you'd like to use, you can add them to the installpath instead of the FTP mirror, or in addition to it.
 

Install Packages

OpenBSD includes the Suhosin Hardened PHP patches in their default PHP package, which is nice. Httpd will require the use of PHP with FastCGI. We'll be using php-fpm for this, which was merged into the main PHP packages recently. Since OpenBSD's package manager automatically installs dependencies, you can get away with this command, which should install PHP, mariadb client tools, and everything else we need to get our PHP web application server up and running:


doas pkg_add php-mysqli mariadb-server

You will be prompted for which version of PHP you want to install. Unless you have a good reason not to, it’s best to go with the newest (highest version number) available. In Open
BSD 6.0, that’s PHP 5.6.23p0 however if you opt to install php-mysqli, you will also see an option to use php 7.0.8p0.

A few post-installation instructions will show up when you install the above packages. Some of those can be ignored (such as the php5 modules link which is only needed if you’re running Apache and mod_php), but you will want to set up the php-mysql link:


doas ln -sf /etc/php-5.6.sample/mysql.ini /etc/php-5.6/mysql.ini

Configure MariaDB, PHP-FPM and httpd

Setup and secure MariaDB with the below commands:  
doas /usr/local/bin/mysql_install_db
doas rcctl start mysqld

doas /usr/local/bin/mysql_secure_installation

Follow the prompts and choose a good password for the root user while you’re at it. 

In /etc/php-fpm.conf, I would suggest increasing the value of pm.max_children to something higher than the default of 5, as even in my testing environment, this was insufficient. I went with 25. It seems to be working well in my production web server environments.

Next, we need a very basic configuration for httpd. I was surprised at how little configuration was needed to get httpd working. This is just enough to get files ending in .php redirected to FPM, while serving up static content for everything else in /var/www/htdocs/. If you want something other than “index.php” to be your default index, you’ll have to change it. See the man page for httpd.conf for details. Put the below lines in /etc/httpd.conf (you’ll need to create it from scratch):

ext_if="egress"

types { include "/usr/share/misc/mime.types" }

server "default" {

  listen on $ext_if port 80

  directory {index "index.php" }

  location "/*.php*" {
      root { "/htdocs" }
      fastcgi socket "/run/php-fpm.sock"
  }
  location "/*" {
      root { "/htdocs" }
  }
}
 
That’s almost all there is to it. Just tell OpenBSD to start the httpd, php-fpm and mysqld services with rcctl enable:
doas rcctl enable httpd

doas rcctl enable php56_fpm
doas rcctl enable mysqld

You can manually start all these services (mysqld is already running because we started it earlier), or just reboot to make sure everything works.
doas rcctl start httpd

doas rcctl start php56_fpm

Set up LAMP style web-apps


Since the web environment is in a chroot restricted to /var/www and the MySQL socket is not inside /var/www, your best bet is to create your MySQL users for a host of “127.0.0.1” instead of localhost. This forces MySQL connections over TCP. There are some hacky ways of getting the socket into /var/www, such as forcing MySQL to write it inside /var/www or creating hard links to the socket. Those are beyond the scope of this article.

My first test was a simple PHPInfo file saved as index.php.



I've managed to install various pre-packaged content management systems and my own PHP web sites on OpenBSD's httpd without any problems. Some apps (like OwnCloud) seem to require some extra work.
I have managed to get WordPress working with pretty permalinks as well.

Virtual Hosts

Setting up virtual hosts is also pretty easy. As with other web servers, the first entry will be the default if the host header doesn't match any other entries (e.g. a visitor using the IP address only.

Just add as many Server clauses as you need, and set them up with web roots relative to the /var/www chroot. Here's an example for 3 virtual hosts with slightly different configurations:

server "things.h-i-r.net" {

listen on $ext_if port 80

directory {index "index.php" }

location "/.ht*"   { block }
location "/.git*"  { block }
location "/.svn*"  { block }
location "/*.php*" {
    root { "/sites/things.h-i-r.net" }
    fastcgi socket "/run/php-fpm.sock"
}
location "/*" {
    root { "/sites/things.h-i-r.net" }
}
}
server "stuff.h-i-r.net" {
listen on $ext_if port 80
directory {index "index.html" }
location "/*" {
    root { "/sites/stuff.h-i-r.net" }
}
}
server "h-i-r.net" {
listen on $ext_if port 80
directory {index "index.php" }
location "/*.php*" {
    root { "/sites/h-i-r.net" }
    fastcgi socket "/run/php-fpm.sock"
}
location "/*" {
    root { "/sites/h-i-r.net" }
}
}



blog comments powered by Disqus