sablierapp / sablier

Start your containers on demand, shut them down automatically when there's no activity. Docker, Docker Swarm Mode and Kubernetes compatible.
https://sablierapp.dev/
GNU Affero General Public License v3.0
1.46k stars 48 forks source link

Documentation is very confusing !! #447

Open slimjet4u opened 1 week ago

slimjet4u commented 1 week ago

The documentation is very confusing, a video guide will be very useful. Showing how to setup sablier with caddy and some other service would help a lot.

Currently the docs is outdated and incomplete and difficult to get started with.

Very little explanation on how to make the configurations work with sablier.

I tried everything but couldnt' get it to start I get the following error msg when trying to visit a service that want managed

Get "http://sablier:10000/api/strategies/dynamic?group=mygroup": dial tcp: lookup sablier on 127.0.0.11:53: no such host
acouvreur commented 1 week ago

Hello @slimjet4u

You are right about the outdated documentaiton, I'm upgrading all the versions.

The Getting Started should cover everything for caddy + docker.

Could you please detail the whole setup ?

How have you configured Caddy ?

Have you created a sablier container ?

image

acouvreur commented 1 week ago

The documentation is very confusing, a video guide will be very useful. Showing how to setup sablier with caddy and some other service would help a lot.

you are right about a getting started tutorial, I might try to make one

slimjet4u commented 1 week ago

I got it to start but the containers won't stop, they just run forever, how do I make it stop for lets say 1hours after inactivity. I also set themes but they don't work

where are these configurations stored ??

I use this caddyfile but the themes don't show up during loading, its just a white screen.

home1234.com {
    sablier http://192.168.1.10:8123 {
        group home
        dynamic {
            display_name This is my display name
            show_details yes  # Use "yes", "true", or "on" without vertical bars
            theme hacker-terminal
            refresh_frequency 2s
        }
    }
    reverse_proxy http://192.168.1.10:8123
}
sftim commented 6 days ago

I guess, this being open source, that help with docs is welcome. It usually is!

acouvreur commented 5 days ago

I got it to start but the containers won't stop, they just run forever, how do I make it stop for lets say 1hours after inactivity. I also set themes but they don't work

where are these configurations stored ??

I use this caddyfile but the themes don't show up during loading, its just a white screen.

home1234.com {
    sablier http://192.168.1.10:8123 {
        group home
        dynamic {
            display_name This is my display name
            show_details yes  # Use "yes", "true", or "on" without vertical bars
            theme hacker-terminal
            refresh_frequency 2s
        }
    }
    reverse_proxy http://192.168.1.10:8123
}

Hey @sftim

  1. Make sure that you have a container with the label sablier.enable=true AND sablier.group=home
  2. To setup the session duration you can either have a default configured on the Sablier container, or on a plugin basis. See here for Caddy: https://github.com/sablierapp/sablier/tree/main/plugins/caddy#configuration
home1234.com {
    sablier http://192.168.1.10:8123 {
        group home
+       session_duration 1h
        dynamic {
            display_name This is my display name
            show_details yes  # Use "yes", "true", or "on" without vertical bars
            theme hacker-terminal
            refresh_frequency 2s
        }
    }
    reverse_proxy http://192.168.1.10:8123
}
slimjet4u commented 4 days ago

@acouvreur

  1. No it doesn't work, when I use session_duration 5m it doesn't stop in 5minutes

  2. When I reboot the server, and when I try to access the url then it won't start the container. BUt when I manually start the container then stop it and then again visit the URL then it starts the container.

  3. Can you also tell what restart: _______ needs to have in the docker-compose.yml file ?? there is no docs on that.

  4. The themes don't work either. Its just a blank white screen