Improve documentation about WOODPECKER_HOST wrt. port number

[svdHero]

Clear and concise description of the problem

In the setup documentation it reads:

Woodpecker needs to know its own address. You must therefore provide the public address of it in <scheme>://<hostname> format.
[...]
WOODPECKER_HOST=${WOODPECKER_HOST}

It is not clear if <scheme>://<hostname> must contain the http port, e.g., the default port 8000 from the compose file. The reference is not clear about this either.

Suggested solution

Improve the wording in order to clarify if the port number has to be part of the environment variable WOODPECKER_HOST.

Alternative

No response

Additional context

No response

Validations

• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[svdHero]

@6543 I am happy to work on this if you answer the question. I would assume that one has to add the port to the hostname. Could you confirm that?

[anbraten]

I has to contain the url the way you would enter it in the browser to access it. So in case of http you need to specifiy the port if its not 80 and in case of https if its not 443.

[svdHero]

Thanks. That's what I thought. I will add a sentence or two to the documentation and open a PR.

[smainz]

Keep in mind: WOODPECKER_HOST is used to create urls which refere to the Web-UI as you type it when you access it with your browser.

• You do not have to add the port number, if it is the standard port i.e. port 80 for http and 443 for https.
• If you are behind a reverse proxy, it is the <scheme>://<host>:<port>of the reverse proxy.

HTH

[svdHero]

Keep in mind: WOODPECKER_HOST is used to create urls which refere to the Web-UI as you type it when you access it with your browser.

That is exactly the sentence that I was looking for and that is missing in the documentation. I shall go and add it. 😄