From c5ac3578822089db228c82f8c0a282202476b7cf Mon Sep 17 00:00:00 2001 From: Alexis Couvreur Date: Sun, 9 Nov 2025 11:53:02 -0500 Subject: [PATCH] docs: add discord server and link pugin repositories --- README.md | 23 +++++++++++++++-------- SUPPORT.md | 26 ++++++++++++++++++++++++++ plugins/caddy/README.md | 17 +++++++++++------ plugins/proxywasm/README.md | 5 +++++ plugins/traefik/README.md | 6 ++++++ 5 files changed, 63 insertions(+), 14 deletions(-) create mode 100644 SUPPORT.md diff --git a/README.md b/README.md index 064e5a2..1430bad 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# - ![Sablier Banner](https://raw.githubusercontent.com/sablierapp/artwork/refs/heads/main/horizontal/sablier-horizontal-color.png) +[![Go Report Card](https://goreportcard.com/badge/github.com/sablierapp/sablier)](https://goreportcard.com/report/github.com/sablierapp/sablier) +[![Discord](https://img.shields.io/discord/1298488955947454464?logo=discord&logoColor=5865F2&cacheSeconds=1&link=http%3A%2F%2F)](https://discord.gg/WXYp59KeK9) + A free and open-source software to start workloads on demand and stop them after a period of inactivity. Think of it a bit like a serverless platform, but for your own servers. @@ -17,13 +18,13 @@ Either because you don't want to overload your raspberry pi or because your QA e - Docker Swarm - Kubernetes - [Supports multiple reverse proxies](https://sablierapp.dev/#/plugins/overview) - - Apache APISIX - - Caddy - - Envoy - - Istio + - [Apache APISIX](https://github.com/sablierapp/sablier-proxywasm-plugin) + - [Caddy](https://github.com/sablierapp/sablier-caddy-plugin) + - [Envoy](https://github.com/sablierapp/sablier-proxywasm-plugin) + - [Istio](https://github.com/sablierapp/sablier-proxywasm-plugin) - Nginx (NJS Module) - - Nginx (WASM Module) - - Traefik + - [Nginx (WASM Module)](https://github.com/sablierapp/sablier-proxywasm-plugin) + - [Traefik](https://github.com/sablierapp/sablier-proxywasm-plugin) - Scale up your workload automatically upon the first request - [with a themable waiting page](https://sablierapp.dev/#/themes) - [with a hanging request (hang until service is up)](https://sablierapp.dev/#/strategies?id=blocking-strategy) @@ -32,3 +33,9 @@ Either because you don't want to overload your raspberry pi or because your QA e ## 📝 Documentation [See the documentation here](https://sablierapp.dev) + +## Community + +Join our Discord server to discuss and get support! + +[![Discord](https://img.shields.io/discord/1298488955947454464?logo=discord&logoColor=5865F2&cacheSeconds=1&link=http%3A%2F%2F)](https://discord.gg/WXYp59KeK9) \ No newline at end of file diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..a67574a --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,26 @@ +# Support + +Thank you for using this project! If you need help or want to report an issue, here’s how you can get support: + +## Submitting Issues + +If you encounter a bug or have a feature request, please submit an issue on GitHub: + +1. Go to the [GitHub Issues page](https://github.com/sablierapp/sablier/issues). +2. Click on "New Issue." +3. Provide a clear and detailed description of the problem or request. +4. Include any relevant information, such as steps to reproduce, screenshots, or logs. + +We’ll review your issue as soon as possible! + +## Discussions + +For general questions, ideas, or feedback, join the conversation in our [GitHub Discussions](https://github.com/sablierapp/discussions). + +## Join Our Discord + +For real-time support and community interaction, join our Discord server: + +[![Discord](https://img.shields.io/discord/1298488955947454464?logo=discord&logoColor=5865F2&cacheSeconds=1&link=http%3A%2F%2F)](https://discord.gg/WXYp59KeK9) + +We’re here to help and look forward to hearing from you! \ No newline at end of file diff --git a/plugins/caddy/README.md b/plugins/caddy/README.md index ba7a740..04bb8b7 100644 --- a/plugins/caddy/README.md +++ b/plugins/caddy/README.md @@ -1,12 +1,17 @@ +> [!IMPORTANT] +> This plugin now has its own reepository: https://github.com/sablierapp/sablier-caddy-plugin +> +> This plugin will no longer receive updates. + # Caddy Sablier Plugin - [Caddy Sablier Plugin](#caddy-sablier-plugin) - - [Build the custom Caddy image with Sablier middleware in it](#build-the-custom-caddy-image-with-sablier-middleware-in-it) - - [By using the provided Dockerfile](#by-using-the-provided-dockerfile) - - [By updating your Caddy Dockerfile](#by-updating-your-caddy-dockerfile) - - [Configuration](#configuration) - - [Exemple with a minimal configuration](#exemple-with-a-minimal-configuration) - - [Running end to end tests](#running-end-to-end-tests) + - [Build the custom Caddy image with Sablier middleware in it](#build-the-custom-caddy-image-with-sablier-middleware-in-it) + - [By using the provided Dockerfile](#by-using-the-provided-dockerfile) + - [By updating your Caddy Dockerfile](#by-updating-your-caddy-dockerfile) + - [Configuration](#configuration) + - [Exemple with a minimal configuration](#exemple-with-a-minimal-configuration) + - [Running end-to-end tests](#running-end-to-end-tests) ## Build the custom Caddy image with Sablier middleware in it diff --git a/plugins/proxywasm/README.md b/plugins/proxywasm/README.md index 02ae67a..d05f916 100644 --- a/plugins/proxywasm/README.md +++ b/plugins/proxywasm/README.md @@ -1,3 +1,8 @@ +> [!IMPORTANT] +> This plugin now has its own reepository: https://github.com/sablierapp/sablier-proxywasm-plugin +> +> This plugin will no longer receive updates. + # Proxy Wasm Sablier Plugin See more at diff --git a/plugins/traefik/README.md b/plugins/traefik/README.md index b98ea93..9a73c70 100644 --- a/plugins/traefik/README.md +++ b/plugins/traefik/README.md @@ -1,3 +1,9 @@ +> [!IMPORTANT] +> This plugin now has its own reepository: https://github.com/sablierapp/sablier-traefik-plugin +> +> This plugin will no longer receive updates. + + # Traefik Sablier Plugin - [Traefik Sablier Plugin](#traefik-sablier-plugin)