README.md

express-gateway-plugin-compression

This plugin for Express Gateway makes it possible to compress responses from Service Endpoints, based on ExpressJS's Compression Middleware.

Installation

Simply type from your shell environment:

eg plugin install express-gateway-plugin-compression

Quick start

1. Make sure the plugin is listed in system.config.yml file. This is done automatically for you if you used the command above.

2. Add the configuration keys to gateway.config.yml file.

policies:
  - compression:
      - action:
          threshold: 1024
  - proxy:
      - action:
          serviceEndpoint: backend

Configuration Parameters

Details regarding action parameters may be found in the compression package's documentation.

Want to make your own plugin?

Just check out our plugin development guide. We can't wait to see your custom stuff in the Gateway!