Caddy Caddyfile deployment example

[WebFreak001]

Nominatim with Caddy

Installing the required packages

You need to install a PHP FastCGI server such as php-fpm to use with caddy.

Follow caddy installation instructions: https://caddyserver.com/docs/install

On Ubuntu/Debian install php-fpm with:

sudo apt install php-fpm

Configure php-fpm with Caddy

By default php-fpm listens on a network socket. If you want it to listen to a
Unix socket instead, change the pool configuration
(/etc/php/<php version>/fpm/pool.d/www.conf) as follows:

; Replace the tcp listener and add the unix socket
listen = /var/run/php-fpm.sock
; Ensure that the daemon runs as the correct user
listen.owner = caddy
listen.group = caddy
listen.mode = 0666

Since caddy by default runs as user caddy and not as www-root this needs
to be adjusted in the config as above accordingly.

Caddyfile

Example Caddyfile:

nominatim.example.org {
    # assuming /srv/nominatim/nominatim-planet is $PROJECT_DIR
    root * /srv/nominatim/nominatim-planet/website
    php_fastcgi unix//var/run/php-fpm.sock {
        # make /search and /status run /search.php and /status.php respectively
        try_files {path} {path}/index.php {path}.php index.php
    }
}

Extra config example if you want to add a custom homepage (index.html) in a different folder or to enable logging:

# inside server block
handle / {
    # custom homepage (static html page)
    root * /srv/http/org.webfreak.nominatim/public
    file_server
}

log {
    output file /data/logs/http/org.webfreak.nominatim.log {
        roll_size 50MiB
    }
    format console
}

I've got this running on https://nominatim.webfreak.org (feel free to use my instance for non-commercial stuff, though I'm currently fighting with the update procedure and the data is thus a little outdated)