[incubator-devlake-website] branch main updated: docs: webhook accessiblity

[yumeng]

This is an automated email from the ASF dual-hosted git repository.

yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git


The following commit(s) were added to refs/heads/main by this push:
     new c63429177 docs: webhook accessiblity
c63429177 is described below

commit c634291774ffcf087e446d0d04b88805185ad9e0
Author: Klesh Wong <zhenmian.hu...@merico.dev>
AuthorDate: Fri Oct 14 15:28:50 2022 +0800

    docs: webhook accessiblity
---
 docs/UserManuals/ConfigUI/webhook.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/docs/UserManuals/ConfigUI/webhook.md 
b/docs/UserManuals/ConfigUI/webhook.md
index b7fb984cc..d349d4d3a 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -4,7 +4,7 @@ sidebar_position: 7
 description: Config UI instruction for Webhook
 ---
 
-Visit config-ui: `http://localhost:4000` if you deployed via docker-compose.
+Visit config-ui via the Domain Name or IP Address and Port, 
 
 ### Add a new webhook
 
![image](https://user-images.githubusercontent.com/3294100/191309840-460fbc9c-15a1-4b12-a510-9ed5ccd8f2b0.png)
@@ -18,3 +18,13 @@ After clicking on "Generate POST URL", you will find four 
webhook URLs. Copy the
 
![image](https://user-images.githubusercontent.com/3294100/191400110-327c153f-b236-47e3-88cc-85bf8fcae310.png)
 
 For more usage: [plugins/webhook](/Plugins/webhook.md).
+
+
+### Webhook Accessibility
+
+In real-world scenarios, most likely, you would like to call the webhook API 
from another machine inside some CI/CD scripts. The CI/CD Machine may be 
located in the same Internal Network or provided by a Cloud Service. 
+
+In any case, the only rule is to make sure the CI/CD Machine could reach the 
config-ui instance.
+
+  - Access the config-ui via IP Address or Domain Name that is accessible from 
the CI/CD Machine, since the Webhook FQDN is generated based on the Browser 
URL. In other words, `localhost` and `127.0.0.1` might not work.
+  - If you set up Apache DevLake as [Internal 
Deployment](../Authentication#internal-deployment-recommended) and the CI/CD 
Machine belongs to a Cloud Service Provider, you may have to switch to 
`Internet Deployment` or employ reverse-proxy software like 
[fatedier/frp](https://github.com/fatedier/frp).