Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.05 KB

navyfile-config.md

File metadata and controls

55 lines (39 loc) · 2.05 KB
Raw
title
Navyfile.js reference

Navyfile.js configuration reference

A Navyfile.js file can be provided alongside your Compose config to configure additional functionality in Navy.

Navyfile.js:

module.exports = {
  plugins: [
    'navy-plugin-nodejs'
  ],
  launchDefaults: [
    'myservice',
    'myotherservice'
  ],
  httpProxyAutoPorts: [
    4080,
  ],
  httpProxy: {
    myotherservice: { port: 8080 }
  },
  ignoreUnauthorizedRequestsForRegistries: [
    'localregistry.local:5000'
  ]
}

Reference

plugins: ?Array<string>

Specifies a list of plugins to load at runtime. This should be an array of strings of NPM packages. Packages specified in this array need to be installed via a package.json in the same directory as Navyfile.js.

launchDefaults: ?Array<string>

A list of service names in the compose configuration which should be selected by default when doing a navy launch with a Navy which hasn't been launched yet.

httpProxyAutoPorts: ?Array<Number | string>

If using the built in HTTP proxy, you can tell Navy to automatically register a service with the HTTP proxy, if it publishes any port in this list. This overrides port 80 for automatic registration.

httpProxy: ?{[key: string]: { port: Number, enableHttps: Boolean }}

If using the built in HTTP proxy, you can tell Navy what port a service listens for HTTP connections here. If a service publishes port 80, or alternatively a port specified in httpProxyAutoPorts, it will automatically be registered with the HTTP proxy, so configuration here is unnecessary.

enableHttps is an optional flag that configures the proxy to listen for HTTPS connections for a service.

ignoreUnauthorizedRequestsForRegistries: ?Array<string>

A list of URLs for registries which are considered insecure (have an invalid certificate, e.g self signed). Note that this does not tell Navy to communicate with a registry over HTTP, Navy can only communicate with Docker registries over HTTPS at the moment.