8000 [Documentation] Inconsistencies between config options · Issue #507 · sablierapp/sablier · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

[Documentation] Inconsistencies between config options #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
seupedro opened this issue Feb 8, 2025 · 1 comment
Open

[Documentation] Inconsistencies between config options #507

seupedro opened this issue Feb 8, 2025 · 1 comment

Comments

@seupedro
Copy link
seupedro commented Feb 8, 2025

Hi! First of all, thank you for this awesome project! I'm using and loving it! (:

I was reading the documentation and I got confused. Why the config names varies from the config sablier.yaml file?

. . . 
sessions:
  default-duration: 5m <-- is different
  expiration-interval: 20s

strategy:
  dynamic:
    custom-themes-path: <-- is different
    show-details-by-default: false <-- is different
    default-theme: hacker-terminal <-- is different
    default-refresh-frequency: 5s <-- is different

  blocking:
    # Default timeout used for blocking strategy (default 1m)
    default-timeout: 1m <-- is different
Image Image Image

Shouldn't it be consistent across the all files?
@acouvreur
Copy link
Member

Hello @seupedro, thanks for opening that issue.

First thing to understand is that there are 2 types of configuration:

  1. The Sablier configuration (CLI args, sablier.yml file)
  2. The plugin configurations (bound the reverse-proxy route and underlying containers)

The Sablier configuration, from CLI to Yaml file looks consistent to me, so I don't think we need to change anything on that.

Now for the plugin configuration, it is bound to how the reverse proxy itself allows you to configure the plugin.
For Traefik we implemented it the way Traefik usually does it, and for Caddy we implemented it the way other Caddy plugins implement it.

I am open to suggestion, so if you have any, please do 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@acouvreur @seupedro
0