docs: add Install Sablier documentation

This commit is contained in:
Alexis Couvreur
2022-11-11 18:49:41 +00:00
parent 24a30a1dc2
commit 6e2800a1f3

View File

@@ -16,6 +16,10 @@ Which allows you to start your containers on demand and shut them down automatic
- [Configuration File](#configuration-file) - [Configuration File](#configuration-file)
- [Environment Variables](#environment-variables) - [Environment Variables](#environment-variables)
- [Arguments](#arguments) - [Arguments](#arguments)
- [Install Sablier](#install-sablier)
- [Use the Docker image](#use-the-docker-image)
- [Use the binary distribution](#use-the-binary-distribution)
- [Compile your binary from the sources](#compile-your-binary-from-the-sources)
- [Loading with a waiting page](#loading-with-a-waiting-page) - [Loading with a waiting page](#loading-with-a-waiting-page)
- [Dynamic Strategy Configuration](#dynamic-strategy-configuration) - [Dynamic Strategy Configuration](#dynamic-strategy-configuration)
- [Creating your own loading theme](#creating-your-own-loading-theme) - [Creating your own loading theme](#creating-your-own-loading-theme)
@@ -173,6 +177,46 @@ Becomes
sablier start --strategy.dynamic.custom-themes-path /my/path sablier start --strategy.dynamic.custom-themes-path /my/path
``` ```
## Install Sablier
You can install Traefik with the following flavors:
- Use the Docker image
- Use the binary distribution
- Compile your binary from the sources
### Use the Docker image
- **Docker Hub**: [acouvreur/sablier](https://hub.docker.com/r/acouvreur/sablier)
- **Guthub Container Registry**: [ghcr.io/acouvreur/sablier](https://github.com/acouvreur/sablier/pkgs/container/sablier)
Choose one of the Docker images and run it with one sample configuration file:
```bash
docker run -d -p 10000:10000 \
-v $PWD/sablier.yml:/etc/sablier/sablier.yml acouvreur/sablier:1.1.0
```
### Use the binary distribution
Grab the latest binary from the [releases](https://github.com/acouvreur/sablier/releases) page.
And run it:
```bash
./sablier --help
```
### Compile your binary from the sources
```bash
git clone git@github.com:acouvreur/sablier.git
cd sablier
make
# Output will change depending on your distro
./sablier_draft_linux-amd64
```
## Loading with a waiting page ## Loading with a waiting page
**The Dynamic Strategy provides a waiting UI with multiple themes.** **The Dynamic Strategy provides a waiting UI with multiple themes.**