You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2022/10/18 01:48:24 UTC
[incubator-devlake-website] 02/02: docs: move webhook accessibility section to webhook plugin doc
This is an automated email from the ASF dual-hosted git repository.
hez pushed a commit to branch put-webhook-on-internet
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit ba2a59e99ecabc888de13b5c08e70ac30b5d2209
Author: Hezheng Yin <he...@merico.dev>
AuthorDate: Mon Oct 17 18:47:54 2022 -0700
docs: move webhook accessibility section to webhook plugin doc
---
docs/Plugins/webhook.md | 10 ++++++++++
docs/UserManuals/ConfigUI/webhook.md | 10 ----------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/Plugins/webhook.md b/docs/Plugins/webhook.md
index d8370e439..509babef1 100644
--- a/docs/Plugins/webhook.md
+++ b/docs/Plugins/webhook.md
@@ -24,6 +24,16 @@ After clicking on the "Generate POST URL" button, you will find several webhook
+### Put webhook on the internet
+
+For the new webhook to work, it needs to be accessible from the DevOps tools from which you would like to push data to DevLake. If DevLake is deployed in your private network and your DevOps tool (e.g. CircleCI) is a cloud service that lives outside of your private network, then you need to make DevLake's webhook accessible to the outside cloud service.
+
+There're many tools for this:
+
+ - For testing and quick setup, [ngrok](https://ngrok.com/) is a useful utility that provides a publicly accessible web URL to any locally hosted application. You can put DevLake's webhook on the internet within 5 mins by following ngrok's [Getting Started](https://ngrok.com/docs/getting-started) guide. Note that, when posting to webhook, you may need to replace the `localhost` part in the webhook URL with the forwarding URL that ngrok provides.
+ - If you prefer DIY, please checkout open-source reverse proxies like [fatedier/frp](https://github.com/fatedier/frp) or go for the classic [nginx](https://www.nginx.com/).
+
+
## Register a deployment
You can copy the generated deployment curl commands to your CI/CD script to post deployments to Apache DevLake. Below is the detailed payload schema:
diff --git a/docs/UserManuals/ConfigUI/webhook.md b/docs/UserManuals/ConfigUI/webhook.md
index d349d4d3a..7b47e9013 100644
--- a/docs/UserManuals/ConfigUI/webhook.md
+++ b/docs/UserManuals/ConfigUI/webhook.md
@@ -18,13 +18,3 @@ 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).