Skip to content
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.

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

[Question] config.yml documentation? #152

Closed
t3hmrman opened this Issue Mar 6, 2019 · 9 comments

Comments

Projects
None yet
3 participants
@t3hmrman
Copy link

t3hmrman commented Mar 6, 2019

What would you like on Statping?
I'd love some documentation on the config.yml file that configures statping. I don't know how I'm missing it, but I've looked through the wiki and the README and can't seem to find a page detailing what config.yml should look like. I've found the .env overriding mechanism, but that's not quite what I'm looking for.

Maybe I'm just going about using statping wrong? is the config.yml written and managed solely by the app?

Apologies ahead of time if this is just like... one page or one link I skipped over -- but I see config.yml mentioned but no actual documentation on it.

Describe the solution you'd like
More explicit documentation around how config.yml can be written.

Describe alternatives you've considered
I considered the .env file override but that's not quite what I'm looking for -- I have control over the filesystem statping is getting deployed on, configuring statping directly seems like the better solution.

Is your feature request related to a problem? Please describe.
I'm always frustrated when I can't find out how to configure statping despite it's excellent documentation on everything else deployment related.

Additional context
No other context

@sebw

This comment has been minimized.

Copy link

sebw commented Mar 10, 2019

+1

@hunterlong

This comment has been minimized.

Copy link
Owner

hunterlong commented Mar 10, 2019

I will be creating a wiki for the statping config.yml file. I’ll comment back here once complete.

@sebw

This comment has been minimized.

Copy link

sebw commented Mar 11, 2019

I actually installed statping on docker behind traefik. The container wouldn't start properly as long as I didn't hit the setup. So traefik doesn't configure the resource. As a workaround, I had to expose statping to the internet, set it up, then only after I could move it behind traefik and secure it with let's encrypt.

@t3hmrman

This comment has been minimized.

Copy link
Author

t3hmrman commented Mar 13, 2019

For reference I was setting up Statping on a small kubernetes cluster (also using Traefik for ingress).

I realized pretty quick that I needed to run through the configuration/setup at the beginning, so I did that first then made it available to the outside world. I wrote about it as well.

Thanks for making statping, it's been super useful so far, and was relatively easy to set up, even if it wasn't possible to set everything up beforehand.

@hunterlong

This comment has been minimized.

Copy link
Owner

hunterlong commented Mar 13, 2019

@sebw interesting find. I’m not sure why the setup process would require internet unless your connecting to a remote database. Odd. All assets are pre-compiled.

@t3hmrman glad you got it setup. You could technically preconfigure the config.yml file or use ENV vars to Bypass the setup process.

Yes, I do promise to create the config.yml wiki. :)

@t3hmrman

This comment has been minimized.

Copy link
Author

t3hmrman commented Mar 13, 2019

@hunterlong maybe I could get the ball rolling with a PR? I'm sure you've got other more important stuff on your plate so I can look at the generated config.yml I have (from my running instance) and add some inline comments (I find that the most effective documentation)

@sebw

This comment has been minimized.

Copy link

sebw commented Mar 15, 2019

@hunterlong as long as I don't do the setup, the container is never in "healthy" state (starting, then unhealthy because the HEALTHCHECK fails).

Traefik will only act on containers being healthy.

This explains why I had to expose Statping directly to the internet first (not behind Traefik) for the setup. It would be convenient if I could run the setup behind Traefik :-) Or how about passing environment variables for the initial setup to kick in?

Didn't find any option to force Traefik to act on a non healthy container though.

Keep up the great job, love the Android app too :)

@hunterlong

This comment has been minimized.

Copy link
Owner

hunterlong commented Mar 16, 2019

Ok, config.yml Wiki Page is setup. I'll be adding more content when something new pops up.

@t3hmrman, awesome article! I'll have to add a How To guide for Kubernetes to the Wiki.

@sebw, the Healthcheck in the Dockerfile will attempt to hit the /health URL. If Statping isn't setup, this will return online: false. I'll be changing this to say true if Statping hasn't been setup yet. I'm sure some people have been having issues with their load balancers since healthcheck is saying it's offline even though it's online, just not setup.

@t3hmrman

This comment has been minimized.

Copy link
Author

t3hmrman commented Mar 17, 2019

@hunterlong hunterlong closed this Mar 17, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.