feat(nginx-fpm-proxy): add ansible role for nginx-based frontend proxy

README.md

@@ -15,6 +15,9 @@ and managing nextcloud installations
   server instance. Can install, remove, enable/disable and update apps.
 - [`roles/ldap-user-backend`](roles/ldap-user-backend/README.md):
   Manages LDAP authentication sources in installed nextcloud instances.
+- [`roles/nginx-fpm-proxy`](roles/nginx-fpm-proxy/README.me):
+  Reverse proxy role which connects to nextcloud using FPM
+  and serves static content.
 
 ## License
 

roles/nginx-fpm-proxy/README.md

@@ -0,0 +1,22 @@
+# `finallycoffee.nextcloud.nginx-fpm-proxy` ansible role
+
+Ansible role for serving nextcloud static content and connecting to dynamic content via PHP-FPM.
+
+## Prerequisites
+
+A running nextcloud instance with FPM available either via IP+port or a unix socket.
+
+## Configuration
+
+- Set `nextcloud_nginx_data_path` to the data directory of the nextcloud instance,
+  from where static content etc is served from.
+
+- `nextcloud_nginx_storage_path` needs to be set to the storage path of the nextcloud
+  instance, where user data is stored. Usually this is `{{ nextcloud_nginx_data_path }}/data`.
+
+- Set `nextcloud_nginx_fpm_socket_dir` to the directory containing the FPM socket,
+  called `nextcloud.sock` by default. This can be overridden in `nextcloud_nginx_fpm_socket_path`.
+
+- If FPM is not used via a unix socket, set `nextcloud_nginx_fpm_server_ip` and
+  `nextcloud_nginx_fpm_server_port` accordingly. Note that the IP must be reachable
+  from inside the nginx container.

roles/nginx-fpm-proxy/defaults/main.yml

@@ -0,0 +1,23 @@
+---
+
+nextcloud_nginx_version: "1.21.3"
+nextcloud_nginx_basepath: /opt/nextcloud-nginx
+nextcloud_nginx_config: "{{ nextcloud_nginx_basepath }}/nextcloud.conf"
+nextcloud_nginx_servernames: ~
+
+nextcloud_nginx_container_name: nextcloud_nginx
+nextcloud_nginx_container_image: "docker.io/library/nginx"
+nextcloud_nginx_container_image_flavor: "alpine"
+nextcloud_nginx_container_image_ref: "{{ nextcloud_nginx_container_image }}:{{ nextcloud_nginx_version }}{{ '-' + nextcloud_nginx_container_image_flavor if nextcloud_nginx_container_image_flavor else ''}}"
+nextcloud_nginx_container_image_force_pull: false
+nextcloud_nginx_container_extra_volumes: []
+nextcloud_nginx_container_extra_labels: {}
+nextcloud_nginx_container_extra_env: {}
+nextcloud_nginx_container_restart_policy: unless-stopped
+
+nextcloud_nginx_fpm_server_ip: ~
+nextcloud_nginx_fpm_server_port: 9000
+nextcloud_nginx_fpm_socket_dir: ~
+nextcloud_nginx_fpm_socket_path: "{{ nextcloud_nginx_fpm_socket_dir }}/nextcloud.sock"
+nextcloud_nginx_data_path: ~
+nextcloud_nginx_storage_path: ~

roles/nginx-fpm-proxy/handlers/main.yml

@@ -0,0 +1,8 @@
+---
+
+- name: Restart nextcloud nginx fpm proxy container
+  listen: restart-nextcloud-nginx
+  docker_container:
+    name: "{{ nextcloud_nginx_container_name }}"
+    state: started
+    restart: yes

roles/nginx-fpm-proxy/tasks/main.yml

@@ -0,0 +1,36 @@
+---
+
+- name: Create directory for nginx config
+  file:
+    path: "{{ nextcloud_nginx_basepath }}"
+    state: directory
+    mode: 0750
+
+- name: Template nginx reverse proxy config for nextcloud
+  template:
+    src: nextcloud-nginx.conf.j2
+    dest: "{{ nextcloud_nginx_config }}"
+  vars:
+    fpm_server: "{{ nextcloud_nginx_fpm_server_ip }}"
+    fpm_server_port: "{{ nextcloud_nginx_fpm_server_port }}"
+    fpm_socket: "{{ nextcloud_nginx_fpm_socket_path }}"
+    domain: "{{ nextcloud_nginx_servernames }}"
+  notify: restart-nextcloud-nginx
+
+- name: Ensure nginx docker image is pulled
+  docker_image:
+    name: "{{ nextcloud_nginx_container_image_ref }}"
+    state: present
+    source: pull
+    force_source: "{{ nextcloud_nginx_container_image_force_pull }}"
+
+- name: Ensure nginx is running for FPM and static file serving
+  docker_container:
+    name: "{{ nextcloud_nginx_container_name }}"
+    image: "{{ nextcloud_nginx_container_image_ref }}"
+    volumes: "{{ nextcloud_nginx_container_volumes }}"
+    labels: "{{ nextcloud_nginx_container_labels }}"
+    env: "{{ nextcloud_nginx_container_env }}"
+    networks: "{{ nextcloud_nginx_container_networks | default(omit) }}"
+    restart_policy: "{{ nextcloud_nginx_container_restart_policy }}"
+    state: started

roles/nginx-fpm-proxy/templates/nextcloud-nginx.conf.j2

@@ -0,0 +1,174 @@
+upstream php-handler {
+{% if fpm_socket %}
+    server unix:{{ fpm_socket }};
+{% else %}
+    server {{ fpm_server }}:{{ fpm_server_port }};
+{% endif %}
+}
+
+server {
+    listen 80;
+    listen [::]:80;
+    server_name {{ domain | join(' ') }};
+
+    # Add headers to serve security related headers
+    # Before enabling Strict-Transport-Security headers please read into this
+    # topic first.
+    add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload;" always;
+    #
+    # WARNING: Only add the preload option once you read about
+    # the consequences in https://hstspreload.org/. This option
+    # will add the domain to a hardcoded list that is shipped
+    # in all major browsers and getting removed from this list
+    # could take several months.
+    add_header Referrer-Policy "no-referrer" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header X-Download-Options "noopen" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+    add_header X-Permitted-Cross-Domain-Policies "none" always;
+    add_header X-Robots-Tag "none" always;
+    add_header X-XSS-Protection "1; mode=block" always;
+
+    # Remove X-Powered-By, which is an information leak
+    fastcgi_hide_header X-Powered-By;
+
+    # Path to the root of your installation
+    root /var/www/nextcloud;
+
+    location = /robots.txt {
+        allow all;
+        log_not_found off;
+        access_log off;
+    }
+
+    # Make a regex exception for `/.well-known` so that clients can still
+    # access it despite the existence of the regex rule
+    # `location ~ /(\.|autotest|...)` which would otherwise handle requests
+    # for `/.well-known`.
+    location ^~ /.well-known {
+        # The rules in this block are an adaptation of the rules
+        # in `.htaccess` that concern `/.well-known`.
+
+        location = /.well-known/carddav { return 301 https://$host/remote.php/dav/; }
+        location = /.well-known/caldav  { return 301 https://$host/remote.php/dav/; }
+
+        # The following rule is only needed for the Social app.
+        # Uncomment it if you're planning to use this app.
+        location = /.well-known/webfinger	{ return 301 https://$host/public.php?service=webfinger; }
+
+        # The following 2 rules are only needed for the user_webfinger app.
+        # Uncomment it if you're planning to use this app.
+        location = /.well-known/host-meta	{ return 301 https://$host/public.php?service=host-meta; }
+        location = /.well-known/host-meta.json	{ return 301 https://$host/public.php?service=host-meta-json; }
+
+        location /.well-known/acme-challenge    { try_files $uri $uri/ =404; }
+        location /.well-known/pki-validation    { try_files $uri $uri/ =404; }
+
+        # Let Nextcloud's API for `/.well-known` URIs handle all other
+        # requests by passing them to the front-end controller.
+        return 301 https://$host/index.php$request_uri;
+    }
+
+    # set max upload size
+    client_max_body_size {{ nextcloud_php_upload_limit }};
+    fastcgi_buffers 128 4K;
+
+    # Enable gzip but do not remove ETag headers
+    gzip on;
+    gzip_vary on;
+    gzip_comp_level 4;
+    gzip_min_length 256;
+    gzip_proxied expired no-cache no-store private no_last_modified no_etag auth;
+    gzip_types application/atom+xml application/javascript application/json application/ld+json application/manifest+json application/rss+xml application/vnd.geo+json application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/bmp image/svg+xml image/x-icon text/cache-manifest text/css text/plain text/vcard text/vnd.rim.location.xloc text/vtt text/x-component text/x-cross-domain-policy;
+
+    # Uncomment if your server is build with the ngx_pagespeed module
+    # This module is currently not supported.
+    #pagespeed off;
+
+    location / {
+        rewrite ^ /index.php;
+    }
+
+    location ~ ^\/(?:build|tests|config|lib|3rdparty|templates|data)\/ {
+        deny all;
+    }
+    location ~ ^\/(?:\.|autotest|occ|issue|indie|db_|console) {
+        deny all;
+    }
+
+    location ~ ^\/(?:index|remote|public|cron|core\/ajax\/update|status|ocs\/v[12]|updater\/.+|oc[ms]-provider\/.+|.+\/richdocumentscode\/proxy)\.php(?:$|\/) {
+        fastcgi_split_path_info ^(.+?\.php)(\/.*|)$;
+        set $path_info $fastcgi_path_info;
+        try_files $fastcgi_script_name =404;
+        fastcgi_param SCRIPT_FILENAME /var/www/html$fastcgi_script_name;
+        fastcgi_param SCRIPT_NAME $fastcgi_script_name;
+        fastcgi_param PATH_INFO $path_info;
+        fastcgi_param HTTPS $https;
+        fastcgi_param HTTP_PROXY "";
+        fastcgi_param REMOTE_ADDR $remote_addr;
+        # Avoid sending the security headers twice
+        fastcgi_param modHeadersAvailable true;
+        # Enable pretty urls
+        fastcgi_param front_controller_active true;
+        fastcgi_pass php-handler;
+        include fastcgi_params;
+        fastcgi_intercept_errors on;
+        fastcgi_request_buffering off;
+    }
+
+    location ~ ^\/(?:updater|oc[ms]-provider)(?:$|\/) {
+        try_files $uri/ =404;
+        index index.php;
+    }
+
+    # Adding the cache control header for js, css and map files
+    # Make sure it is BELOW the PHP block
+    location ~ \.(?:css|js|woff2?|svg|gif|map)$ {
+        expires 1d;
+        # How `sendfile`, `tcp_nopush` and `tcp_nodelay` interact
+        # https://thoughts.t37.net/nginx-optimization-understanding-sendfile-tcp-nodelay-and-tcp-nopush-c55cdd276765?gi=f11af534b564
+        sendfile on; # use `sendfile` syscall, which is a DMA (zero-copy) call
+        tcp_nopush on; # wait until the file is fully "read"
+        tcp_nodelay on; # always immediately flush, never wait for a full packet worth of data (default wait interval = 200ms)
+        aio on; #async IO for files
+        open_file_cache max=10000; # cache metadata for up to 10000 files
+        open_file_cache_valid 3600s; # previous cache is valid for 1h
+        open_file_cache_errors off; # except if there was an error, that is not cached
+        try_files $uri /index.php$request_uri;
+        add_header Cache-Control "public, max-age=15778463";
+        # Add headers to serve security related headers (It is intended to
+        # have those duplicated to the ones above)
+        # Before enabling Strict-Transport-Security headers please read into
+        # this topic first.
+        #add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload;" always;
+        #
+        # WARNING: Only add the preload option once you read about
+        # the consequences in https://hstspreload.org/. This option
+        # will add the domain to a hardcoded list that is shipped
+        # in all major browsers and getting removed from this list
+        # could take several months.
+        add_header Referrer-Policy "no-referrer" always;
+        add_header X-Content-Type-Options "nosniff" always;
+        add_header X-Download-Options "noopen" always;
+        add_header X-Frame-Options "SAMEORIGIN" always;
+        add_header X-Permitted-Cross-Domain-Policies "none" always;
+        add_header X-Robots-Tag "none" always;
+        add_header X-XSS-Protection "1; mode=block" always;
+
+        # Optional: Don't log access to assets
+        access_log off;
+    }
+
+    location ~ \.(?:png|html|ttf|ico|jpg|jpeg|bcmap|mp4|webm)$ {
+        expires 1d;
+        sendfile on;
+        tcp_nopush on;
+        tcp_nodelay on;
+        open_file_cache max=10000;
+        open_file_cache_valid 3600s;
+        open_file_cache_errors off;
+        try_files $uri /index.php$request_uri;
+        # Optional: Don't log access to other assets
+        access_log off;
+    }
+}

roles/nginx-fpm-proxy/vars/main.yml

@@ -0,0 +1,18 @@
+---
+
+nextcloud_nginx_container_volumes_base: >-2
+  {{
+    [
+      nextcloud_nginx_config + ':/etc/nginx/conf.d/nextcloud.conf:ro',
+      nextcloud_nginx_data_path + ':/var/www/nextcloud:ro',
+      nextcloud_nginx_storage_path + ':/var/www/nextcloud/data:rw'
+    ]
+    + ([nextcloud_nginx_fpm_socket_dir + ':' + nextcloud_nginx_fpm_socket_dir + ':rw'] if nextcloud_nginx_fpm_socket_dir else [])
+  }}
+nextcloud_nginx_container_labels_base:
+  version: "{{ nextcloud_nginx_version }}"
+nextcloud_nginx_container_env_base: {}
+
+nextcloud_nginx_container_volumes: "{{ nextcloud_nginx_container_volumes_base + nextcloud_nginx_container_extra_volumes }}"
+nextcloud_nginx_container_labels: "{{ nextcloud_nginx_container_labels_base | combine(nextcloud_nginx_container_extra_labels) }}"
+nextcloud_nginx_container_env: "{{ nextcloud_nginx_container_env_base | combine(nextcloud_nginx_container_extra_env) }}"