Skip to content

Enhance SSL certificate configuration documentation for port-agent #2878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 13, 2025
Merged

Enhance SSL certificate configuration documentation for port-agent #2878

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37896bf
Enhance SSL certificate configuration documentation for webhook port …
Amichai-Skaliter-Port Oct 12, 2025
778532d
Improved clarity by reorganizing sections on self-signed and multipl…
Amichai-Skaliter-Port Oct 12, 2025
4515206
Apply suggestion from @sivanel97
sivanel97 Oct 13, 2025
c156820
Merge branch 'main' into r_uoStC8xH6rKv0Y81-add-multi-cert-support-po…
sivanel97 Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions docs/actions-and-automations/setup-backend/webhook/port-execution-agent/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ For example:
```json showLineNumbers
{ "type": "WEBHOOK", "agent": true, "url": "URL_TO_API_INSIDE_YOUR_NETWORK" }
```

:::

Well Done! **Port Agent** is now running in your environment and will trigger any webhook that you've configured (for self-service actions, or changes in the software catalog).
Expand Down Expand Up @@ -56,7 +55,7 @@ env:
VAR_NAME: VAR_VALUE
```

### Proxy configuration
### Proxy configuration

#### `HTTP_PROXY`, `HTTPS_PROXY` & `ALL_PROXY`
`HTTP_PROXY`, `HTTPS_PROXY`, and `ALL_PROXY` are environment variables used to specify a proxy server for handling HTTP, HTTPS, or all types of requests, respectively. The values assigned to these settings should be the URL of the proxy server.
Expand All @@ -81,7 +80,13 @@ For more information take a look at the Requests [proxy configuration documentat

### SSL Environment Configuration

#### `REQUESTS_CA_BUNDLE`
### Certificate Configuration

#### Self-signed certificate

Use the following Helm values:
- Set `selfSignedCertificate.enabled` to `true`.
- Put your PEM-encoded CA content in `selfSignedCertificate.certificate`.

`REQUESTS_CA_BUNDLE` is an environment variable used to specify a custom Certificate Authority (CA) bundle for verifying SSL/TLS certificates in HTTPS requests.

Expand All @@ -94,6 +99,15 @@ REQUESTS_CA_BUNDLE=/path/to/cacert.pem

This configuration directs the `requests` library to use the specified CA bundle for SSL/TLS certificate verification, overriding default system settings. It's useful for trusting self-signed certificates or certificates from a private CA.

#### Multiple certificates

Use the following Helm values:
- Keep your certificate via `selfSignedCertificate` as above.
- Add other certificates by supplying files via `extraVolumes` and mounting them with `extraVolumeMounts` into the container.

:::info Certificate file requirement
Each certificate must be provided in a separate PEM file. Files containing multiple certificates are not supported.
:::

## Next Steps

Expand Down