Lando

special sponsors

become a sponsor

# nginx

nginx (opens new window) is a very common web server and reverse proxy.

You can easily add it to your Lando app by adding an entry to the services top-level config in your Landofile.

# Supported versions

# Legacy versions

You can still run these versions with Lando but for all intents and purposes they should be considered deprecated (e.g. YMMV and do not expect a ton of support if you have an issue).

# Patch versions

Not officially supported!

While we allow users to specify patch versions for this service, they are not officially supported, so if you use one, YMMV.

To use a patch version, you can do something as shown below:

services:
  myservice:
    type: nginx:1.16.1

But make sure you use one of the available patch tags (opens new window) for the underlying image we are using.

# Configuration

Here are the configuration options, set to the default values, for this service. If you are unsure about where this goes or what this means we highly recommend scanning the services documentation to get a good handle on how the magicks work.

Also note that options, in addition to the build steps and overrides that are available to every service, are shown below:

services:
  myservice:
    type: nginx:1.18
    webroot: .
    ssl: false
    config:
      server: SEE BELOW
      vhosts: SEE BELOW
      params: SEE BELOW

# Using custom nginx config files

You may need to override our default nginx config (opens new window) with your own custom server (opens new window), vhosts (opens new window) or fastcgi_params (opens new window) config.

If you do this, you must use files that exist inside your application and express them relative to your project root as shown below:

Note that the default files may change based on how you set ssl.

A hypothetical project

Note that you can put your configuration files anywhere inside your application directory. We use a config directory but you can call it whatever you want such as .lando in the example below:

./
|-- config
   |-- default.conf
   |-- nginx.conf
   |-- fastcgi_params
|-- index.html
|-- .lando.yml

Landofile using custom nginx config

services:
  myservice:
    type: nginx
    config:
      server: config/nginx.conf
      vhosts: config/default.conf
      param: config/fastcgi_params

← Node →