mirrors/sablier
1
0
Fork 0
mirror of https://github.com/sablierapp/sablier.git synced 2025-12-21 13:23:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add release please tags to update version

Browse Source
This commit is contained in:
Alexis Couvreur
2025-11-11 23:26:08 -05:00
parent 71a35ca8dd
commit 8bc21fbaa9
11 changed files with 32 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -48,8 +48,10 @@ You can install Sablier using one of the following methods:
### Use the Docker image
<!-- x-release-please-start-version -->
![Docker Pulls](https://img.shields.io/docker/pulls/sablierapp/sablier)
![Docker Image Size (tag)](https://img.shields.io/docker/image-size/sablierapp/sablier/1.10.1)
<!-- x-release-please-end -->
- **Docker Hub**: [sablierapp/sablier](https://hub.docker.com/r/sablierapp/sablier)
- **GitHub Container Registry**: [ghcr.io/sablierapp/sablier](https://github.com/sablierapp/sablier/pkgs/container/sablier)
@@ -58,9 +60,11 @@ Choose one of the Docker images and run it with a sample configuration file:
- [sablier.yaml](https://raw.githubusercontent.com/sablierapp/sablier/main/sablier.sample.yaml)
<!-- x-release-please-start-version -->
```bash
docker run -d -p 10000:10000 -v sablier.yaml:/etc/sablier/sablier.yaml sablierapp/sablier:1.10.1
```
<!-- x-release-please-end -->
### Use the binary distribution
@@ -186,14 +190,15 @@ STRATEGY_DYNAMIC_CUSTOM_THEMES_PATH=/my/path
To list all available arguments:
<!-- x-release-please-version-end -->
```bash
sablier --help
# or
docker run sablierapp/sablier[:version] --help
# e.g.: docker run sablierapp/sablier:1.10.1 --help
docker run sablierapp/sablier:1.10.1 --help
```
<!-- x-release-please-end -->
Command-line arguments follow the same structure as the configuration file. For example:

5
docs/configuration.md
View File

@@ -81,14 +81,15 @@ STRATEGY_DYNAMIC_CUSTOM_THEMES_PATH=/my/path
To get the list of all available arguments:
<!-- x-release-please-start-version -->
```bash
sablier --help
# or
docker run sablierapp/sablier[:version] --help
# ex: docker run sablierapp/sablier:1.10.1 --help
docker run sablierapp/sablier:1.10.1 --help
```
<!-- x-release-please-end -->
All arguments can be used in the form of the config file such as

6
docs/getting-started.md
View File

@@ -78,7 +78,7 @@ services:
image: acouvreur/whoami:v1.10.2
sablier:
image: sablierapp/sablier:1.10.1
image: sablierapp/sablier:1.10.1 # x-release-please-version
command:
- start
- --provider.name=docker
@@ -113,7 +113,7 @@ services:
image: acouvreur/whoami:v1.10.2
sablier:
image: sablierapp/sablier:1.10.1
image: sablierapp/sablier:1.10.1 # x-release-please-version
command:
- start
- --provider.name=docker
@@ -145,7 +145,7 @@ services:
- sablier.group=demo
sablier:
image: sablierapp/sablier:1.10.1
image: sablierapp/sablier:1.10.1 # x-release-please-version
volumes:
- '/var/run/docker.sock:/var/run/docker.sock'
```

4
docs/guides/code-server-traefik-kubernetes.md
View File

@@ -59,7 +59,7 @@
additionalArguments:
- "--experimental.plugins.sablier.moduleName=github.com/sablierapp/sablier"
- "--experimental.plugins.sablier.version=v1.10.1"
- "--experimental.plugins.sablier.version=v1.10.1" # x-release-please-version
providers:
kubernetesIngress:
@@ -142,7 +142,7 @@
serviceAccountName: sablier
containers:
- name: sablier
image: sablierapp/sablier:1.10.1
image: sablierapp/sablier:1.10.1 # x-release-please-version
args:
- "start"
- "--provider.name=kubernetes"

4
docs/health.md
View File

@@ -13,6 +13,7 @@ You can use the command `sablier health` to check for healthiness.
`sablier health` takes on argument `--url` which defaults to `http://localhost:10000/health`.
<!-- x-release-please-start-version -->
```yml
services:
sablier:
@@ -20,4 +21,5 @@ services:
healthcheck:
test: ["sablier", "health"]
interval: 1m30s
```
```
<!-- x-release-please-end -->

2
docs/installation.md
View File

@@ -15,10 +15,12 @@ Choose one of the Docker images and run it with one sample configuration file:
- [sablier.yaml](https://raw.githubusercontent.com/sablierapp/sablier/main/sablier.sample.yaml)
<!-- x-release-please-start-version -->
```bash
docker run -d -p 10000:10000 \
-v $PWD/sablier.yaml:/etc/sablier/sablier.yaml sablierapp/sablier:1.10.1
```
<!-- x-release-please-end -->
## Use the binary distribution

4
docs/plugins/traefik.md
View File

@@ -91,6 +91,7 @@ The blocking strategy is supported by issuing redirect which force client to ret
#### **File (YAML)**
<!-- x-release-please-start-version -->
```yaml
experimental:
plugins:
@@ -98,13 +99,16 @@ experimental:
moduleName: "github.com/sablierapp/sablier"
version: "v1.10.1"
```
<!-- x-release-please-end -->
#### **CLI**
<!-- x-release-please-start-version -->
```bash
--experimental.plugins.sablier.modulename=github.com/sablierapp/sablier
--experimental.plugins.sablier.version=v1.10.1
```
<!-- x-release-please-end -->
<!-- tabs:end -->

2
docs/providers/docker.md
View File

@@ -31,6 +31,7 @@ PROVIDER_NAME=docker
!> **Ensure that Sablier has access to the docker socket!**
<!-- x-release-please-start-version -->
```yaml
services:
sablier:
@@ -41,6 +42,7 @@ services:
volumes:
- '/var/run/docker.sock:/var/run/docker.sock'
```
<!-- x-release-please-end -->
## Register containers

2
docs/providers/docker_swarm.md
View File

@@ -32,6 +32,7 @@ PROVIDER_NAME=docker_swarm # or swarm
!> **Ensure that Sablier has access to the docker socket!**
<!-- x-release-please-start-version -->
```yaml
services:
sablier:
@@ -42,6 +43,7 @@ services:
volumes:
- '/var/run/docker.sock:/var/run/docker.sock'
```
<!-- x-release-please-end -->
## Register services

2
docs/providers/podman.md
View File

@@ -31,6 +31,7 @@ PROVIDER_NAME=podman
!> **Ensure that Sablier has access to the podman socket!**
<!-- x-release-please-start-version -->
```yaml
services:
sablier:
@@ -41,6 +42,7 @@ services:
volumes:
- '/run/podman/podman.sock:/run/podman/podman.sock'
```
<!-- x-release-please-end -->
## Register containers

2
docs/themes.md
View File

@@ -22,6 +22,7 @@ You can use the argument `--strategy.dynamic.custom-themes` to define the locati
By default, the docker image looks for themes located inside the `/etc/sablier/themes` folder.
<!-- x-release-please-start-version -->
```yaml
services:
sablier:
@@ -30,6 +31,7 @@ services:
- '/var/run/docker.sock:/var/run/docker.sock'
- '/path/to/my/themes:/etc/sablier/themes'
```
<!-- x-release-please-end -->
It will look recursively for themes with the `.html` extension.