Skip to content

Commit 1b664ce

Browse files
docs: updated readme with WEBHOOK_BASE_URL variable
* Update `ENGINE_IMAGE` to version 3.2.26 and revise security annotation * Document `WEBHOOK_BASE_URL` usage and update `TEMPLATE_ENGINE` image to version 0.15.7 * Update security annotation and bump `engine` to 3.2.26, `pikolo` to 0.15.7 * Fix broken dependency in `kube-integration` and update `engine` to version 3.2.26 * Fix broken dependency in `kube-integration` and update `engine` to version 3.2.26 * Fix broken dependency in `kube-integration` and update `engine` to version 3.2.26 * Revise bug fix annotation for "pipeline runtime" in Helm chart metadata * Update engine to 3.3.0. ECR integration with Service Account uses the region of integration * helm-docs * Document `WEBHOOK_BASE_URL` configuration for externally-reachable Git providers * Refine `WEBHOOK_BASE_URL` documentation and update chart metadata with engine version 3.3.0 changes * Update README: improve webhook configuration note formatting * Add "Configure platform URL for Git webhooks" section to README --------- Co-authored-by: andrii-codefresh <andrii@codefresh.io> Co-authored-by: Zhenya Tikhonov <zhenya.tikhonov@octopus.com> (cherry picked from commit aeb0720)
1 parent 01d61c7 commit 1b664ce

3 files changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
3737
- [Projects pipelines limit](#projects-pipelines-limit)
3838
- [Enable session cookie](#enable-session-cookie)
3939
- [X-Frame-Options response header](#x-frame-options-response-header)
40+
- [Configure platform URL for Git webhooks](#configure-platform-url-for-git-webhooks)
4041
- [Image digests in containers](#image-digests-in-containers)
4142
- [Hermes configuration](#hermes-configuration)
4243
- [Configuring OIDC Provider](#configuring-oidc-provider)
@@ -1447,6 +1448,20 @@ cfapi:
14471448
USE_SHA256_GITHUB_SIGNATURE: "true"
14481449
```
14491450
1451+
### Configure platform URL for Git webhooks
1452+
1453+
By default Codefresh registers webhooks using CF_HOST_NAME/EXTERNAL_URL (the same hostname used for the UI/API).
1454+
If that hostname is internal-only and unreachable by the Git provider, set WEBHOOK_BASE_URL
1455+
to an externally-reachable hostname; it is used only for webhook registration, everything else keeps using CF_HOST_NAME/EXTERNAL_URL.
1456+
> [!IMPORTANT]
1457+
> This only affects webhooks registered after the change - existing triggers must be deleted and recreated.
1458+
1459+
```yaml
1460+
cfapi:
1461+
env:
1462+
WEBHOOK_BASE_URL: "https://external.mydomain.com"
1463+
```
1464+
14501465
### Image digests in containers
14511466

14521467
In Codefresh On-Prem 2.6.x all Codefresh owner microservices include image digests in the default subchart values.

README.md.gotmpl

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
3737
- [Projects pipelines limit](#projects-pipelines-limit)
3838
- [Enable session cookie](#enable-session-cookie)
3939
- [X-Frame-Options response header](#x-frame-options-response-header)
40+
- [Configure platform URL for Git webhooks](#configure-platform-url-for-git-webhooks)
4041
- [Image digests in containers](#image-digests-in-containers)
4142
- [Hermes configuration](#hermes-configuration)
4243
- [Configuring OIDC Provider](#configuring-oidc-provider)
@@ -1456,6 +1457,20 @@ cfapi:
14561457
USE_SHA256_GITHUB_SIGNATURE: "true"
14571458
```
14581459

1460+
### Configure platform URL for Git webhooks
1461+
1462+
By default Codefresh registers webhooks using CF_HOST_NAME/EXTERNAL_URL (the same hostname used for the UI/API).
1463+
If that hostname is internal-only and unreachable by the Git provider, set WEBHOOK_BASE_URL
1464+
to an externally-reachable hostname; it is used only for webhook registration, everything else keeps using CF_HOST_NAME/EXTERNAL_URL.
1465+
> [!IMPORTANT]
1466+
> This only affects webhooks registered after the change - existing triggers must be deleted and recreated.
1467+
1468+
```yaml
1469+
cfapi:
1470+
env:
1471+
WEBHOOK_BASE_URL: "https://external.mydomain.com"
1472+
```
1473+
14591474
### Image digests in containers
14601475

14611476
In Codefresh On-Prem 2.6.x all Codefresh owner microservices include image digests in the default subchart values.

charts/codefresh/values.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ runtimeImages:
546546
KUBE_DEPLOY: quay.io/codefresh/cf-deploy-kubernetes:18.0.2@sha256:a9642f66c7696367b43f2931bab6f647f9f91262e194609e64a19ea362a7c873
547547
PIPELINE_DEBUGGER_IMAGE: quay.io/codefresh/cf-debugger:1.3.14@sha256:7a5890afcfdad4a9aa4eec1a218cb468d52855540c847b3809085415751bbaa7
548548
TEMPLATE_ENGINE: quay.io/codefresh/pikolo:0.15.7@sha256:1c1ff75feceb8d4e6ffa09b933605d0a1476bf64890f247be186da3200a9d004
549-
CR_6177_FIXER: docker.io/library/alpine:latest
549+
CR_6177_FIXER: docker.io/library/alpine:3.24
550550
GC_BUILDER_IMAGE: docker.io/library/alpine:3.24
551551

552552
#--------------------
@@ -585,6 +585,8 @@ cfapi: &cf-api
585585
OIDC_PROVIDER_PROTOCOL: '{{ .Values.global.oidcProviderProtocol }}'
586586
OIDC_PROVIDER_TOKEN_ENDPOINT: '{{ .Values.global.oidcProviderTokenEndpoint }}'
587587
DEFAULT_SYSTEM_TYPE: PROJECT_ONE
588+
# Configure platform URL for Git webhooks
589+
WEBHOOK_BASE_URL: ""
588590
# -- Secrets configuration
589591
secrets:
590592
secret:

0 commit comments

Comments
 (0)