mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2025-12-24 14:31:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation clarity

Browse Source
This commit is contained in:
Alexis Couvreur
2025-11-12 00:38:24 -05:00
parent 33209acc6c
commit a6614de3ad
9 changed files with 90 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/plugins/overview.md
View File

@@ -1,12 +1,12 @@
# Reverse Proxy Plugins
## What is a Reverse Proxy Plugin ?
## What is a Reverse Proxy Plugin?
Reverse proxy plugins are the integration with a reverse proxy.
Reverse proxy plugins provide 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.
?> Because Sablier is designed as an API that can be used independently, reverse proxy integrations act as clients of that API.
It leverages the API calls to plugin integration to catch in-flight requests to Sablier.
They leverage API calls to intercept in-flight requests and communicate with Sablier.
![Reverse Proxy Integration](../assets/img/reverse-proxy-integration.png)
@@ -32,8 +32,8 @@ It leverages the API calls to plugin integration to catch in-flight requests to
*Your Reverse Proxy is not on the list? [Open an issue to request the missing reverse proxy integration here!](https://github.com/sablierapp/sablier/issues/new?assignees=&labels=enhancement%2C+reverse-proxy&projects=&template=reverse-proxy-integration-request.md&title=Add+%60%5BREVERSE+PROXY%5D%60+reverse+proxy+integration)*
## Runtime and Compiled plugins
## 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 reverse proxies can evaluate plugins at runtime (e.g., Traefik with Yaegi, NGINX with Lua and JavaScript plugins), which means the reverse proxy can consume the plugin directly without recompilation.
Some others enforce you to rebuild your reverse proxy (Caddy).
Others require you to rebuild your reverse proxy with the plugin included (e.g., Caddy).