config-file.md

Configuring Glee

Glee comes with sensible defaults so you don't have to worry about configuration. However, sometimes you may want change the behavior or customize Glee in different ways. For that purpose, you can use the glee.config.js file.

The configuration file

Glee's config file is a JavaScript file that exports an async function. Something like this:

export default async function () {
  // More stuff here...
}

This function must return an object with the following shape:

export default async function () {
  return {
    websocket: {
      httpServer: customServer, // A custom HTTP server of your own.
      adapter: 'native', // Default. Can also be 'socket.io' or a reference to a custom adapter.
      port: process.env.PORT,
    },
    cluster: {
      adapter: 'redis',
      name: 'cluster', // Default. Name of your cluster.
      url: 'redis://localhost:6379', // Server URL used by adapter for clustering
    }
  }
}

Field	Description
websocket.adapter	The Glee adapter to use for the WebSocket server. Defaults to a "native" WebSocket implementation. Other allowed values are socket.io (to use the Socket.IO Glee adapter) or a reference to a custom adapter.
websocket.httpServer	A custom HTTP server of your own. E.g., an Express server or any object that implements the http.Server interface.
websocket.port	The port to use when binding the WebSocket server. This is useful when your server is behind a proxy and the port exposed for consumption is not the same as the port your application should be bound to. Defaults to the port specified in the selected AsyncAPI server.
cluster.adapter	The Glee cluster adapter to use for communication between instances. Defaults to Redis Pub/Sub ("redis"). Can be a reference to a custom adapter.
cluster.name	The name of the cluster. Defaults to "cluster".
cluster.url	The url of the server to be used by the adapter. In case of "redis" adapter, it's the url of the Redis server.