diff --git a/README.md b/README.md index 95a0b3b..c1a4e75 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,10 @@ You can install Sablier using one of the following methods: ### Use the Docker image + ![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) + - **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) + ```bash docker run -d -p 10000:10000 -v sablier.yaml:/etc/sablier/sablier.yaml sablierapp/sablier:1.10.1 ``` + ### Use the binary distribution @@ -186,14 +190,15 @@ STRATEGY_DYNAMIC_CUSTOM_THEMES_PATH=/my/path To list all available arguments: + ```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 ``` + Command-line arguments follow the same structure as the configuration file. For example: diff --git a/docs/configuration.md b/docs/configuration.md index 5c54b09..6663a66 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -81,14 +81,15 @@ STRATEGY_DYNAMIC_CUSTOM_THEMES_PATH=/my/path To get the list of all available arguments: + ```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 ``` + All arguments can be used in the form of the config file such as diff --git a/docs/getting-started.md b/docs/getting-started.md index 7a28325..d5e1bfb 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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' ``` diff --git a/docs/guides/code-server-traefik-kubernetes.md b/docs/guides/code-server-traefik-kubernetes.md index 9e9158e..c6025e2 100644 --- a/docs/guides/code-server-traefik-kubernetes.md +++ b/docs/guides/code-server-traefik-kubernetes.md @@ -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" diff --git a/docs/health.md b/docs/health.md index fece66a..5c89496 100644 --- a/docs/health.md +++ b/docs/health.md @@ -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`. + ```yml services: sablier: @@ -20,4 +21,5 @@ services: healthcheck: test: ["sablier", "health"] interval: 1m30s -``` \ No newline at end of file +``` + \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 8f85198..54203ef 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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) + ```bash docker run -d -p 10000:10000 \ -v $PWD/sablier.yaml:/etc/sablier/sablier.yaml sablierapp/sablier:1.10.1 ``` + ## Use the binary distribution diff --git a/docs/plugins/traefik.md b/docs/plugins/traefik.md index d5e22c5..4a30f07 100644 --- a/docs/plugins/traefik.md +++ b/docs/plugins/traefik.md @@ -91,6 +91,7 @@ The blocking strategy is supported by issuing redirect which force client to ret #### **File (YAML)** + ```yaml experimental: plugins: @@ -98,13 +99,16 @@ experimental: moduleName: "github.com/sablierapp/sablier" version: "v1.10.1" ``` + #### **CLI** + ```bash --experimental.plugins.sablier.modulename=github.com/sablierapp/sablier --experimental.plugins.sablier.version=v1.10.1 ``` + diff --git a/docs/providers/docker.md b/docs/providers/docker.md index e1b8604..2460380 100644 --- a/docs/providers/docker.md +++ b/docs/providers/docker.md @@ -31,6 +31,7 @@ PROVIDER_NAME=docker !> **Ensure that Sablier has access to the docker socket!** + ```yaml services: sablier: @@ -41,6 +42,7 @@ services: volumes: - '/var/run/docker.sock:/var/run/docker.sock' ``` + ## Register containers diff --git a/docs/providers/docker_swarm.md b/docs/providers/docker_swarm.md index 216d407..b2140bb 100644 --- a/docs/providers/docker_swarm.md +++ b/docs/providers/docker_swarm.md @@ -32,6 +32,7 @@ PROVIDER_NAME=docker_swarm # or swarm !> **Ensure that Sablier has access to the docker socket!** + ```yaml services: sablier: @@ -42,6 +43,7 @@ services: volumes: - '/var/run/docker.sock:/var/run/docker.sock' ``` + ## Register services diff --git a/docs/providers/podman.md b/docs/providers/podman.md index 72317a5..efb5534 100644 --- a/docs/providers/podman.md +++ b/docs/providers/podman.md @@ -31,6 +31,7 @@ PROVIDER_NAME=podman !> **Ensure that Sablier has access to the podman socket!** + ```yaml services: sablier: @@ -41,6 +42,7 @@ services: volumes: - '/run/podman/podman.sock:/run/podman/podman.sock' ``` + ## Register containers diff --git a/docs/themes.md b/docs/themes.md index 0753a71..556ea4b 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -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. + ```yaml services: sablier: @@ -30,6 +31,7 @@ services: - '/var/run/docker.sock:/var/run/docker.sock' - '/path/to/my/themes:/etc/sablier/themes' ``` + It will look recursively for themes with the `.html` extension.