mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2025-12-30 17:47:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove emoji

Browse Source 
markdown links are broken
This commit is contained in:
Alexis Couvreur
2022-11-11 19:01:57 +00:00
parent 1ba758f67d
commit caab2d2cdb
2 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,4 +1,4 @@
# ⏳ Sablier
# Sablier
![Github Actions](https://img.shields.io/github/workflow/status/acouvreur/sablier/Build?style=flat-square) ![Go Report](https://goreportcard.com/badge/github.com/acouvreur/sablier?style=flat-square) ![Go Version](https://img.shields.io/github/go-mod/go-version/acouvreur/sablier?style=flat-square) ![Latest Release](https://img.shields.io/github/release/acouvreur/sablier/all.svg?style=flat-square)
@@ -10,9 +10,9 @@ Which allows you to start your containers on demand and shut them down automatic
![Hourglass](https://raw.githubusercontent.com/acouvreur/sablier/main/docs/img/hourglass.png)
- [⏳ Sablier](#-sablier)
- [⚡️ Quick start](#️-quick-start)
- [⚙️ Configuration](#️-configuration)
- [Sablier](#sablier)
- [Quick start](#quick-start)
- [Configuration](#configuration)
- [Configuration File](#configuration-file)
- [Environment Variables](#environment-variables)
- [Arguments](#arguments)
@@ -24,13 +24,13 @@ Which allows you to start your containers on demand and shut them down automatic
- [Dynamic Strategy Configuration](#dynamic-strategy-configuration)
- [Creating your own loading theme](#creating-your-own-loading-theme)
- [Blocking the loading until the session is ready](#blocking-the-loading-until-the-session-is-ready)
- [💾 Saving the state to a file](#-saving-the-state-to-a-file)
- [Saving the state to a file](#saving-the-state-to-a-file)
- [Reverse proxies integration plugins](#reverse-proxies-integration-plugins)
- [Traefik Middleware Plugin](#traefik-middleware-plugin)
- [Glossary](#glossary)
- [Credits](#credits)
## ⚡️ Quick start
## Quick start
```bash
# Create and stop nginx container
@@ -71,7 +71,7 @@ curl 'http://localhost:10000/api/strategies/blocking?names=nginx&names=whoami&se
}
```
## ⚙️ Configuration
## Configuration
There are three different ways to define configuration options in Sablier:
@@ -256,7 +256,7 @@ strategy:
default-timeout: 1m
```
## 💾 Saving the state to a file
## Saving the state to a file
You can save the state of the application in case of failure to resume your sessions.

12
plugins/traefik/README.md
View File

@@ -2,9 +2,9 @@
- [Traefik Sablier Plugin](#traefik-sablier-plugin)
- [Installation](#installation)
- [🐳 Traefik with Docker classic](#-traefik-with-docker-classic)
- [🐙 Traefik with Docker Swarm](#-traefik-with-docker-swarm)
- [☸️ Traefik with Kubernetes](#️-traefik-with-kubernetes)
- [Traefik with Docker classic](#traefik-with-docker-classic)
- [Traefik with Docker Swarm](#traefik-with-docker-swarm)
- [Traefik with Kubernetes](#traefik-with-kubernetes)
- [Plugin](#plugin)
- [Development](#development)
@@ -48,7 +48,7 @@ http:
You can also checkout the End to End tests here: [e2e](./e2e/).
## 🐳 Traefik with Docker classic
## Traefik with Docker classic
**Container labels cannot be used**
@@ -121,7 +121,7 @@ http:
service: "whoami"
```
## 🐙 Traefik with Docker Swarm
## Traefik with Docker Swarm
⚠️ Limitations
@@ -137,7 +137,7 @@ http:
```
- We cannot use [allowEmptyServices](https://doc.traefik.io/traefik/providers/docker/#allowemptyservices) because if you use the [blocking strategy](LINKHERE) you will receive a `503`.
## ☸️ Traefik with Kubernetes
## Traefik with Kubernetes
- The format of the `names` section is `<KIND>_<NAMESPACE>_<NAME>_<REPLICACOUNT>` where `_` is the delimiter.
- Thus no `_` are allowed in `<NAME>`