You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/10/14 07:29:32 UTC
[incubator-devlake-website] branch kw-3437-webhook-accessibility created (now af9e52055)
This is an automated email from the ASF dual-hosted git repository.
klesh pushed a change to branch kw-3437-webhook-accessibility
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
at af9e52055 docs: webhook accessiblity
This branch includes the following new commits:
new af9e52055 docs: webhook accessiblity
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[incubator-devlake-website] 01/01: docs: webhook accessiblity
Posted by kl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch kw-3437-webhook-accessibility
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit af9e52055f447118bd14b29065754d48cc95269c
Author: Klesh Wong <zh...@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
@@ -18,3 +18,13 @@ After clicking on "Generate POST URL", you will find four webhook URLs. Copy the
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).