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

Document expert env vars #4820

Open
3 tasks done
NRUB opened this issue Feb 7, 2025 · 1 comment
Open
3 tasks done

Document expert env vars #4820

NRUB opened this issue Feb 7, 2025 · 1 comment
Labels
documentation docu & docs good first issue Likely to be an easy fix

Comments

@NRUB
Copy link

NRUB commented Feb 7, 2025

Clear and concise description of the problem

In version 3.0.0 the WOODPECKER_WEBHOOK_HOST variable has been removed and WOODPECKER_EXPERT_WEBHOOK_HOST is to be used instead. However the WOODPECKER_EXPERT_x family of variables is completely undocumented, making them needlessly obscure. In setups where Woodpecker is not facing the internet, one would expect the webhook to use static IP address while having webportal accessible with a local domain using mDNS (as an example). This scenario requires webhook address and host to be defined separately. Since this is a completely valid setup, the environment variables it involves, shouldn't be hidden.

Suggested solution

Reintroduce WOODPECKER_WEBHOOK_HOST variable.

Alternative

Document (or at least compile a complete list of) the WOODPECKER_EXPERT_x family of variables.

Additional context

No response

Validations

  • Checked that the feature isn't part of the next version already [https://woodpecker-ci.org/versions]
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@NRUB NRUB added the feature add new functionality label Feb 7, 2025
@qwerty287
Copy link
Contributor

I'd keep it how it is, but documenting them with a disclaimer is a good idea.

@qwerty287 qwerty287 changed the title Bring back WOODPECKER_WEBHOOK_HOST env var Document expert env vars Feb 8, 2025
@qwerty287 qwerty287 added documentation docu & docs good first issue Likely to be an easy fix and removed feature add new functionality labels Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation docu & docs good first issue Likely to be an easy fix
Projects
None yet
Development

No branches or pull requests

2 participants