Skip to main content
Version: Next

Configuration

Platformatic Node is configured with a configuration file. It supports the use of environment variables as setting values with configuration placeholders.

application​

Supported object properties:

  • basePath: Service proxy base path when exposing this application in a gateway when setting the proxy property. If not specified, the application will be exposed on the application or a value specified in the application code via platformatic.setBasePath().
  • outputDirectory: The subdirectory where production build is stored at when using wattpm build or plt build. The default is dist.
  • include: The paths to include when deploying the application. The default is ['dist'].
  • commands: An object specifying the commands to manage the application instead of directly executing the application entrypoint. Supported commands are:
    • install: The command to execute to install the application dependencies. The default is npm ci --omit-dev.
    • build: The command to execute to build the application.
    • development: The command to execute to start the application in development mode.
    • production: The command to execute to start the application in production mode.

node​

Configures Node. Supported object properties:

  • main: The entrypoint of the application. This is only needed if the main property is not set in the application package.json file.
  • absoluteUrl: If set to true, then the application will receive the full URL from a Platformatic Gateway. The default is false.
  • dispatchViaHttp: If set to true, then the application will serve requests coming from the mesh network via a TCP port.
  • disablePlatformaticInBuild: If set to true, then no Platformatic code will be started when running the build command.
  • hasServer: If set to false, then Platformatic Node will treat the application as a background application which doesn't expose any HTTP port.

logger​

Configures the logger, see the runtime documentation.

server​

Configures the HTTP server, see the runtime documentation.

watch​

Manages watching of the application, see the service documentation.

Issues

If you run into a bug or have a suggestion for improvement, please raise an issue on GitHub or join our Discord feedback channel.