From 8bda6fdd53b3cc7470fac67228a88e0d165134dd Mon Sep 17 00:00:00 2001 From: Julien Lepiller Date: Mon, 26 Sep 2016 23:55:58 +0200 Subject: [PATCH] services: improve nginx-service configuration * gnu/services/web.scm (): New record type. (config-domain-strings): New procedure. (config-index-strings): New procedure. (default-nginx-vhost-config): New procedure. (default-nginx-config): Add vhost support and temporary directories (nginx-activation): Create temporary directories (nginx-service): Add vhost-list key. * doc/guix.texi (Web Services): Document 'nginx-vhost-configuration'. --- doc/guix.texi | 46 ++++++++++++++++++++++++++ gnu/services/web.scm | 92 +++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 134 insertions(+), 4 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 0c5d641..c36a29c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -10394,6 +10394,7 @@ The @code{(gnu services web)} module provides the following service: @deffn {Scheme Procedure} nginx-service [#:nginx nginx] @ [#:log-directory ``/var/log/nginx''] @ [#:run-directory ``/var/run/nginx''] @ + [#:vhost-list (list (nginx-vhost-configuration))] @ [#:config-file] Return a service that runs @var{nginx}, the nginx web server. @@ -10404,8 +10405,53 @@ files are written to @var{run-directory}. For proper operation, these arguments should match what is in @var{config-file} to ensure that the directories are created when the service is activated. +As an alternative to using a @var{config-file}, @var{vhost-list} can be +used to specify the list of @dfn{virtual hosts} required on the host. For +this to work, use the default value for @var{config-file}. + @end deffn address@hidden {Data Type} nginx-vhost-configuration +Data type representing the configuration of an nginx virtual host. +This type has the following parameters: address@hidden @asis address@hidden @code{http-port} (default: @code{80}) +Nginx will listen for HTTP connection on this port. Set it at @code{#f} if +nginx should not listen for HTTP (non secure) connection for this address@hidden host}. + address@hidden @code{https-port} (default: @code{443}) +Nginx will listen for HTTPS connection on this port. Set it at @code{#f} if +nginx should not listen for HTTPS (secure) connection for this @dfn{virtual host}. + +Note that nginx can listen for HTTP and HTTPS connections in the same address@hidden host}. + address@hidden @code{server-name} (default: @code{(list 'default)}) +A list of server names this vhost represents. @code{'default} represents the +default vhost for connections matching no other vhost. + address@hidden @code{root} (default: @code{``/srv/http''}) +Root of the website nginx will serve. + address@hidden @code{index} (default: @code{(list ``index.html'')}) +Index files to look for when clients ask for a directory. If it cannot be found, +Nginx will send the list of files in the directory. + address@hidden @code{ssl-certificate} (default: @code{``/etc/nginx/cert.pem''}) +Where to find the certificate for secure connections. Set it to @code{#f} if +you don't have a certificate or you don't want to use HTTPS. + address@hidden @code{ssl-certificate-key} (default: @code{``/etc/nginx/key.pem''}) +Where to find the private key for secure connections. Set it to @code{#f} if +you don't have a key or you don't want to use HTTPS. + address@hidden @code{server-tokens?} (default: @code{#f}) +Whether the server should add its configuration to response. + address@hidden table address@hidden deftp + @node Network File System @subsubsection Network File System @cindex NFS diff --git a/gnu/services/web.scm b/gnu/services/web.scm index 0a2a09b..49a2962 100644 --- a/gnu/services/web.scm +++ b/gnu/services/web.scm @@ -2,6 +2,7 @@ ;;; Copyright © 2015 David Thompson ;;; Copyright © 2015, 2016 Ludovic Courtès ;;; Copyright © 2016 ng0 +;;; Copyright © 2016 Julien Lepiller ;;; ;;; This file is part of GNU Guix. ;;; @@ -29,6 +30,8 @@ #:use-module (ice-9 match) #:export (nginx-configuration nginx-configuration? + nginx-vhost-configuration + nginx-vhost-configuration? nginx-service nginx-service-type)) @@ -38,6 +41,26 @@ ;;; ;;; Code: +(define-record-type* + nginx-vhost-configuration make-nginx-vhost-configuration + nginx-vhost-configuration? + (http-port nginx-vhost-configuration-http-port + (default 80)) + (https-port nginx-vhost-configuration-https-port + (default 443)) + (server-name nginx-vhost-configuration-server-name + (default (list 'default))) + (root nginx-vhost-configuration-root + (default "/srv/http")) + (index nginx-vhost-configuration-index + (default (list "index.html"))) + (ssl-certificate nginx-vhost-configuration-ssl-certificate + (default "/etc/nginx/cert.pem")) + (ssl-certificate-key nginx-vhost-configuration-ssl-certificate-key + (default "/etc/nginx/key.pem")) + (server-tokens? nginx-vhost-configuration-server-tokens? + (default #f))) + (define-record-type* nginx-configuration make-nginx-configuration nginx-configuration? @@ -46,16 +69,70 @@ (run-directory nginx-configuration-run-directory) ;string (file nginx-configuration-file)) ;string | file-like -(define (default-nginx-config log-directory run-directory) +(define (config-domain-strings names) + "Return a string denoting the nginx config representation of NAMES, a list +of domain names." + (string-concatenate + (map (match-lambda + ('default "_") + ((? string? str) str)) + names))) + +(define (config-index-strings names) + "Return a string denoting the nginx config representation of NAMES, a list +of index files." + (string-concatenate + (map (match-lambda + ((? string? str) str)) + names))) + +(define (default-nginx-vhost-config vhost) + (string-append + " server {\n" + (if (nginx-vhost-configuration-http-port vhost) + (string-append " listen " + (number->string (nginx-vhost-configuration-http-port vhost)) + ";\n") + "") + (if (nginx-vhost-configuration-https-port vhost) + (string-append " listen " + (number->string (nginx-vhost-configuration-https-port vhost)) + " ssl;\n") + "") + " server_name " (config-domain-strings + (nginx-vhost-configuration-server-name vhost)) + ";\n" + (if (nginx-vhost-configuration-ssl-certificate vhost) + (string-append " ssl_certificate " + (nginx-vhost-configuration-ssl-certificate vhost) ";\n") + "") + (if (nginx-vhost-configuration-ssl-certificate-key vhost) + (string-append " ssl_certificate_key " + (nginx-vhost-configuration-ssl-certificate-key vhost) ";\n") + "") + " root " (nginx-vhost-configuration-root vhost) ";\n" + " index " (config-index-strings (nginx-vhost-configuration-index vhost)) ";\n" + " server_tokens " (if (nginx-vhost-configuration-server-tokens? vhost) + "on" "off") ";\n" + " }\n")) + +(define (default-nginx-config log-directory run-directory vhost-list) (plain-file "nginx.conf" (string-append "user nginx nginx;\n" "pid " run-directory "/pid;\n" "error_log " log-directory "/error.log info;\n" "http {\n" + " client_body_temp_path " run-directory "/client_body_temp;\n" + " proxy_temp_path " run-directory "/proxy_temp;\n" + " fastcgi_temp_path " run-directory "/fastcgi_temp;\n" + " uwsgi_temp_path " run-directory "/uwsgi_temp;\n" + " scgi_temp_path " run-directory "/scgi_temp;\n" " access_log " log-directory "/access.log;\n" - " root /var/www;\n" - " server {}\n" + (let ((http (map default-nginx-vhost-config vhost-list))) + (do ((http http (cdr http)) + (block "" (string-append (car http) "\n" block ))) + ((null? http) block))) "}\n" "events {}\n"))) @@ -79,6 +156,12 @@ (mkdir-p #$log-directory) (format #t "creating nginx run directory '~a'~%" #$run-directory) (mkdir-p #$run-directory) + (format #t "creating nginx temp directories '~a/{client_body,proxy,fastcgi,uwsgi,scgi}_temp'~%" #$run-directory) + (mkdir-p (string-append #$run-directory "/client_body_temp")) + (mkdir-p (string-append #$run-directory "/proxy_temp")) + (mkdir-p (string-append #$run-directory "/fastcgi_temp")) + (mkdir-p (string-append #$run-directory "/uwsgi_temp")) + (mkdir-p (string-append #$run-directory "/scgi_temp")) ;; Check configuration file syntax. (system* (string-append #$nginx "/sbin/nginx") "-c" #$config-file "-t"))))) @@ -114,8 +197,9 @@ (define* (nginx-service #:key (nginx nginx) (log-directory "/var/log/nginx") (run-directory "/var/run/nginx") + (vhost-list (list (nginx-vhost-configuration))) (config-file - (default-nginx-config log-directory run-directory))) + (default-nginx-config log-directory run-directory vhost-list))) "Return a service that runs NGINX, the nginx web server. The nginx daemon loads its runtime configuration from CONFIG-FILE, stores log -- 2.10.1