svelte-adapter-nginx v1.0.3

svelte-adapter-nginx

Adapter for SvelteKit apps that generates a standalone Node server with static files handled by nginx.

Usage

Install with npm i -D svelte-adapter-nginx, then add the adapter to your svelte.config.js:

// svelte.config.js
import adapter from 'svelte-adapter-nginx';

export default {
	kit: {
		adapter: adapter({
			// default options are shown
			out: 'build',
			env: {
				host: 'HOST',
				port: 'PORT'
			}
		})
	}
};

Options

out

The directory to build the server to. It defaults to build — i.e. node build would start the server locally after it has been created.

env

By default, the server will accept connections on 0.0.0.0 using port 3000. These can be customised with the PORT and HOST environment variables:

HOST=127.0.0.1 PORT=4000 node build

You can specify different environment variables if necessary using the env option:

env: {
	host: 'MY_HOST_VARIABLE',
	port: 'MY_PORT_VARIABLE'
}

MY_HOST_VARIABLE=127.0.0.1 MY_PORT_VARIABLE=4000 node build

Custom server

The adapter creates two files in your build directory — index.js and handler.js. Running index.js — e.g. node build, if you use the default build directory — will start a server on the configured port.

Alternatively, you can import the handler.js file, which exports a handler suitable for use with Express, Connect or Polka (or even just the built-in http.createServer) and set up your own server:

// my-server.js
import { handler } from './build/handler.js';
import express from 'express';

const app = express();

// add a route that lives separately from the SvelteKit app
app.get('/healthcheck', (req, res) => {
	res.end('ok');
});

// let SvelteKit handle everything else, including serving prerendered pages and static assets
app.use(handler);

app.listen(3000, () => {
	console.log('listening on port 3000');
});

Deploying

You will need the output directory (build by default), the project's package.json, and the production dependencies in node_modules to run the application. Production dependencies can be generated with npm ci --prod, you can also skip this step if your app doesn't have any dependencies. You can then start your app with

This adapter does not handle static files via nodejs, instead you could use and modify the following nginx site config to your needs. It handles static assets via nginx and proxies all other requests to localhost:3000

TODO: This should also handle prerendering, if anyone knows how to accomplish that let me now.

upstream app {
    server localhost:3000;
}

server {

    # SSL configuration

    listen 443 ssl http2 default_server;
    listen [::]:443 ssl http2 default_server;

    server_name domain.com www.domain.com;

    root /home/www/domain.com/build/static;

    location / {
        try_files $uri @app;
    }

    location @app {
        proxy_pass http://app;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    location ~* \.(jpg|jpeg|png|gif|ico|svg|css|js)$ {
       expires 30d;
    }
}

node build
# or use pm2

License

MIT