Skip to main content
Version: Next

Configuration

Platformatic Vite 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 /$ID (where $ID is the application ID) id 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 using the Vite defaults. 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.

vite​

Configures Vite. Supported object properties:

  • configFile: The configuration file path or false to disable autodetection.
  • devServer.strict: Restrict serving files outside of workspace root. By default is false.
  • ssr: Configures the application as SSR. Supported object properties:
    • enabled: If the application is a SSR application.
    • entrypoint: The application entrypoint file. The default is server.js.
    • clientDirectory: The directory containing client files. The default is client.
    • serverDirectory: The directory containing server files. The default is server.

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 application 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.