Skip to content

docs: add network requirements #59

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
sayonfortify merged 1 commit into from
Jun 22, 2026
Merged

docs: add network requirements #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ import ocelle

The root `fortifyroot` package is reserved for internal namespaces such as vendored instrumentation. Public SDK code should use `fortifyroot.ocelle` or the `ocelle` convenience alias.

## Network Requirements

If your app runs in a private subnet, VPC, Kubernetes cluster, or locked-down CI/runtime, allow outbound HTTPS egress on TCP 443 to `api.fortifyroot.com`.

Ocelle exports telemetry over OTLP/HTTP to:

- `https://api.fortifyroot.com/v1/traces`
- `https://api.fortifyroot.com/v1/metrics`
- `https://api.fortifyroot.com/v1/logs`

If safety enforcement is enabled with `config_profile_id`, the SDK also polls:

- `https://api.fortifyroot.com/v1/sdk/config/{config_profile_id}`

No inbound firewall rule is required. Hosted FortifyRoot usage does not require opening OTLP ports `4317` or `4318`; those are local/internal listener ports. Your workload still needs separate egress to whichever LLM providers it calls.

## Auto-Instrumented LLM Libraries

The MVP SDK vendors and exposes the following supported instrumentation packages:
Expand Down
Loading