Files
sablier/docs/plugins/overview.md
Alexis Couvreur 7ebfdd50ff docs: add multiversioned documentation (#344)
Documentation is now published on the `gh-pages` branch.

The branch will have a folder `docs` containing the following structure:
- `./docs` the copy from the `main` docs, but only used for the `index.html` page to do the multi-version routing.
- `./docs/main` the copy from the `main` branch docs folder
- `./docs/beta` the copy from the `beta` branch docs folder

Closes #332
2024-07-03 14:56:59 -04:00

2.3 KiB

Reverse Proxy Plugins

What is a Reverse Proxy Plugin ?

Reverse proxy plugins are the integration with a reverse proxy.

?> Because Sablier is designed as an API that can be used on its own, reverse proxy integrations acts as a client of that API.

It leverages the API calls to plugin integration to catch in-flight requests to Sablier.

Reverse Proxy Integration

Available Reverse Proxies

Reverse Proxy Docker Docker Swarm mode Kubernetes
Apache APISIX
Caddy
Envoy
Istio ⚠️
Nginx (NJS Module)
Nginx (WASM Module)
Traefik
ProxyWasm

Fully compatible

⚠️ Partially compatible

Should be compatible (but not tested)

Not compatible

Your Reverse Proxy is not on the list? Open an issue to request the missing reverse proxy integration here!

Runtime and Compiled plugins

Some reverse proxies have the capability to evaluate the plugins at runtime (Traefik with Yaegi, NGINX with Lua and JS plugins) which means the reverse proxy provides a way to consume the plugin directly.

Some others enforce you to rebuild your reverse proxy (Caddy).