title: "Deployment"

showtoc: true

Deploying a Vendure Application

A Vendure application is essentially a Node.js application, and can be deployed to any environment that supports Node.js.

The bare minimum requirements are:

A server with Node.js installed
A database server (if using MySQL/Postgres)

A typical pattern is to run the Vendure app on the server, e.g. at http://localhost:3000 an then use nginx as a reverse proxy to direct requests from the Internet to the Vendure application.

Here is a good guide to setting up a production-ready server for an app such as Vendure: https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-18-04

Security Considerations

For a production Vendure server, there are a few security-related points to consider when deploying:

Set the Superadmin credentials to something other than the default.
Consider taking steps to harden your GraphQL APIs against DOS attacks. Use the ApiOptions to set up appropriate Express middleware for things like request timeouts and rate limits. A tool such as graphql-query-complexity can be used to mitigate resource-intensive GraphQL queries.
You may wish to restrict the Admin API to only be accessed from trusted IPs. This could be achieved for instance by configuring an nginx reverse proxy that sits in front of the Vendure server.
By default, Vendure uses auto-increment integer IDs as entity primary keys. While easier to work with in development, sequential primary keys can leak information such as the number of orders or customers in the system. For this reason you should consider using the UuidIdStrategy for production.
```
import { UuidIdStrategy, VendureConfig } from '@vendure/core';
  
export const config: VendureConfig = {
entityIdStrategy: new UuidIdStrategy(),
// ...
}
```

Health/Readiness Checks

If you wish to deploy with Kubernetes or some similar system, you can make use of the health check endpoint. This is a regular REST route (note: not GraphQL), available at /health.

REQUEST: GET http://localhost:3000/health

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    },
    "worker": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    },
    "worker": {
      "status": "up"
    }
  }
}

Health checks are built on the Nestjs Terminus module. You can also add your own health checks by creating plugins that make use of the HealthCheckRegistryService.

Deploying the worker

By default the worker and server communicate over TCP (other protocols can be used - see the Nestjs microservices docs). In production, you may wish to run the worker in a separate container or machine than the Vendure server. In this case, the VendureConfig.workerOptions that get passed to bootstrap() and bootstrapWorker() will need to be different:

Example Scenario

The Vendure server and worker will run on separate web servers (or in separate containers)
These servers are behind a reverse proxy, e.g. nginx

Only the Vendure server machine should be accessible from the internet - nginx is configured to forward requests to port 443 (https traffic) to the Vendure server which is listening on port 3000.

// vendure-config.ts

export const config: VendureConfig = {
apiOptions: {
  hostname: 'localhost',
  port: 3000,
},
workerOptions: {
options: {
  host: '<IP address of the worker server>',
  port: 3020,
},
},
// ...
}

// index.ts

bootstrap(config);

// index-worker.ts

const workerConfig = {
...config,
workerOptions: {
options: {
  host: 'localhost',
  port: 3020,
},
},
};
bootstrapWorker(workerConfig);

Admin UI

If you have customized the Admin UI with extensions, it can make sense to compile your extensions ahead-of-time as part of the deployment process.

deployment.md 4.5 KB History Raw