nginx-config.md

KeeperFX Nginx Configuration

This is an example nginx config for the KeeperFX website application. Edit as needed. Be sure to point the root variable below to the /public directory.

All non static files should be routed trough index.php.

server {
	listen       127.0.0.1:80;
	server_name  keeperfx.local;
	
	root   /var/www/keeperfx-website/public;
	index  index.php;

	location / {
		try_files $uri /index.php$is_args$args;
	}
	
	location ~ \.php$ {
        
        # Linux
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;

        # Windows
		# fastcgi_pass   127.0.0.1:9000;
		# fastcgi_index  index.php;
		# fastcgi_param  SCRIPT_FILENAME  $document_root/$fastcgi_script_name;
		# include        fastcgi_params;
	}
}

Alpha build and prototype serving

If you use the env var APP_ALPHA_PATCH_STORAGE you can setup nginx to serve those files using any chosen directory.

location ~ ^/download/alpha/(.+)$ {
    alias /var/www/keeperfx-website/keeperfx-alpha-builds/$1;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}
location ~ ^/download/prototype/(.+)$ {
    alias /var/www/keeperfx-website/keeperfx-prototypes/$1;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

NOTE: When using alias be sure to add trailing directory slashes.

Symlinks can also be use but are not recommended.

Workshop images

location ~ ^/workshop/image/([0-9]+)/(.+)$ {
    access_log off;
    alias /var/www/keeperfx-website/workshop/$1/images/$2;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

User avatars

location ~ ^/avatar/(.+)$ {
    access_log off;
    alias /var/www/keeperfx-website/avatars/$1;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

News Images

location ~ ^/news/image/(.+)$ {
    access_log off;
    alias /var/www/keeperfx-website/news-image/$1;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

Crash Reports

location ~ ^/dev/crash-report/download/(.+)$ {
    alias /var/www/keeperfx-website/crash-report/savefiles/$1;
}

Assets

location ~ ^/(img|js|css)/ {
    access_log off;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

location ~ ^/screenshots/ {
    access_log off;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

location /favicon.ico {
    access_log off;
    expires 30d;
    add_header Cache-Control "public, max-age=2592000";
}

Uploads

location ~ ^/uploads/(.+)$ {
        access_log off;
        alias /var/www/keeperfx/storage/uploads/$1;
        expires 30d;
        add_header Cache-Control "public, max-age=2592000";
        add_header Content-disposition "attachment; filename=$1";
}