Skip to content

Commit 7df8518

Browse files
author
Karl Rankla
committed
docs(erp-toolkit): remove internal implementation references
- Replace admin script reference with contact-support guidance for secure proxy allowlist management - Replace AWS-specific terms (Lambda, NAT Gateway, S3) with customer-facing language (secure proxy, static IP, storage)
1 parent 320a4fc commit 7df8518

3 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/integrations/erp-toolkit/configuration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ curl -X POST 'https://erp-integration.sls.epilot.io/v1/integrations/{integration
124124
:::info
125125
- `file_proxy` — On-demand file serving from external document systems. See the [File Proxy guide](./file-proxy).
126126
- `managed_call` — Synchronous external API calls with JSONata mapping. See [Managed Call Use Cases](#managed-call-use-cases).
127-
- `secure_proxy` — Route requests through VPC Lambdas for static IP or VPN access. See [Secure Proxy Use Cases](#secure-proxy-use-cases).
127+
- `secure_proxy` — Route requests through epilot's secure proxy for static IP or VPN access. See [Secure Proxy Use Cases](#secure-proxy-use-cases).
128128
:::
129129

130130
### Enabling/Disabling a Use Case
@@ -326,7 +326,7 @@ Secrets must use `{{env.KEY}}` references to resolve values from the [Environmen
326326

327327
## Secure Proxy Use Cases
328328

329-
Secure proxy use cases route HTTP requests through VPC-deployed Lambda functions for static IP egress or VPN access to customer private networks.
329+
Secure proxy use cases route HTTP requests through epilot's dedicated proxy infrastructure, providing either a static IP for egress or VPN access to customer private networks.
330330

331331
### Creating a Secure Proxy Use Case
332332

@@ -349,9 +349,9 @@ curl -X POST 'https://erp-integration.sls.epilot.io/v1/integrations/{integration
349349

350350
| Field | Required | Mutable | Description |
351351
|-------|----------|---------|-------------|
352-
| `vpc_mode` | Yes | No (immutable) | `"static_ip"` (NAT Gateway for fixed outbound IP) or `"secure_link"` (VPN for private networks) |
353-
| `allowed_domains` | No | Admin only | Array of allowed domain patterns. Supports exact match and wildcard prefix (e.g., `*.example.com`). Managed via admin script only. |
354-
| `allowed_ips` | No | Admin only | Array of allowed IP ranges in CIDR notation (e.g., `10.0.1.0/24`). Required for `secure_link` mode. Managed via admin script only. |
352+
| `vpc_mode` | Yes | No (immutable) | `"static_ip"` (fixed outbound IP) or `"secure_link"` (VPN for private networks) |
353+
| `allowed_domains` | No | Read-only | Array of allowed domain patterns. Supports exact match and wildcard prefix (e.g., `*.example.com`). Managed by epilot support. |
354+
| `allowed_ips` | No | Read-only | Array of allowed IP ranges in CIDR notation (e.g., `10.0.1.0/24`). Required for `secure_link` mode. Managed by epilot support. |
355355

356356
### Sending a Proxy Request
357357

@@ -374,7 +374,7 @@ curl -X POST 'https://erp-integration.sls.epilot.io/v1/secure-proxy' \
374374

375375
- **Domain whitelist**: Controls which hostnames the proxy can reach. Wildcard patterns must have at least 2 suffix labels (e.g., `*.example.com` is valid, `*.com` is rejected).
376376
- **IP allowlist**: Controls which IP addresses are permitted in `secure_link` mode using CIDR notation. Validation is applied both at the URL level (direct IP targets) and DNS level (resolved IPs must match).
377-
- Both fields are read-only in the API and can only be managed via the admin script (`scripts/manage-secure-proxy-whitelist.ts`).
377+
- Both fields are read-only in the API. To add, remove, or change allowed domains or IP ranges, contact epilot support.
378378

379379
### Security
380380

@@ -384,7 +384,7 @@ curl -X POST 'https://erp-integration.sls.epilot.io/v1/secure-proxy' \
384384
| Domain whitelist | Optional | Required |
385385
| IP allowlist | N/A | Required |
386386
| Request size limit | 4 MB | 4 MB |
387-
| Timeout | 25s (VPC Lambda) / 30s (API Gateway) | 25s (VPC Lambda) / 30s (API Gateway) |
387+
| Timeout | 30s | 30s |
388388

389389
## Event Configuration
390390

docs/integrations/erp-toolkit/file-proxy.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ If a JSONata expression produces a string result (e.g., for `filename` or `conte
283283

284284
## VPC Routing
285285

286-
Some external systems require requests to come from known static IPs (IP allowlisting). Set `requires_vpc: true` to route all HTTP requests through a VPC-deployed proxy Lambda with static outbound IPs via NAT gateway.
286+
Some external systems require requests to come from known static IPs (IP allowlisting). Set `requires_vpc: true` to route all HTTP requests through epilot's secure proxy with a fixed, allowlistable outbound IP.
287287

288288
```json
289289
{
@@ -299,9 +299,9 @@ Some external systems require requests to come from known static IPs (IP allowli
299299
```
300300

301301
When VPC routing is enabled:
302-
- All step HTTP requests are forwarded to the VPC proxy Lambda
303-
- The VPC proxy makes the actual outbound call from a static IP
304-
- Large responses (>4.5 MB) are automatically transferred via S3
302+
- All step HTTP requests are forwarded through the secure proxy
303+
- The secure proxy makes the actual outbound call from a static IP
304+
- Large responses (>4.5 MB) are automatically transferred via a short-lived, presigned download URL
305305

306306
## Credentials and Secrets
307307

@@ -390,11 +390,11 @@ See the [Inbound Mapping Specification](./inbound/mapping#file-proxy-url-mapping
390390

391391
## Large File Handling
392392

393-
Files larger than 5 MB exceed the Lambda response payload limit. In these cases, the proxy automatically:
393+
Files larger than 5 MB exceed the inline response payload limit. In these cases, the proxy automatically:
394394

395-
1. Uploads the file to a temporary S3 bucket
396-
2. Returns a `302 Redirect` to a presigned S3 download URL (valid for 5 minutes)
397-
3. The browser follows the redirect and downloads the file directly from S3
395+
1. Uploads the file to temporary storage
396+
2. Returns a `302 Redirect` to a short-lived, presigned download URL (valid for 5 minutes)
397+
3. The browser follows the redirect and downloads the file directly from the storage location
398398

399399
This is transparent to the user and requires no configuration. Temporary files are automatically cleaned up after 24 hours.
400400

docs/integrations/erp-toolkit/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The ERP Toolkit is composed of the following components. Each plays a specific r
3434
| **[JSONata Mapping](#jsonata-mapping)** | Transformation language for inbound and outbound data | Stable |
3535
| **[File Proxy](./file-proxy)** | Serve files from external archives on demand without migrating them into epilot | Stable |
3636
| **[Managed Calls](#managed-calls)** | Synchronous external API calls with JSONata mapping via connector integrations | Stable |
37-
| **[Secure Proxy](#secure-proxy)** | Route HTTP requests through VPC Lambdas for static IP egress or VPN access | Stable |
37+
| **[Secure Proxy](#secure-proxy)** | Route HTTP requests through epilot's secure proxy for static IP egress or VPN access | Stable |
3838
| **[Monitoring and ACKs](#monitoring-and-acks)** | Central logging, error tracking, and event replay | In progress |
3939
| **[Blueprints](https://marketplace.epilot.cloud/en/blueprints)** | Packaged, installable integration setups | Stable |
4040
| **[Apps](https://marketplace.epilot.cloud/en/apps)** | Custom automation actions and portal extensions for ERP logic | In progress |
@@ -52,7 +52,7 @@ The `/v2/integrations` CRUD API centralizes all integration configuration in one
5252
- **Inbound use cases** with entity mappings
5353
- **Outbound use cases** with event mappings
5454
- **Managed call use cases** for synchronous external API calls (connector integrations)
55-
- **Secure proxy use cases** for VPC-routed HTTP requests
55+
- **Secure proxy use cases** for HTTP requests routed through a static IP or VPN
5656
- **Associated Apps and portal extensions**
5757

5858
Integrations support two types: `erp` (default, for standard ERP flows) and `connector` (for complex proxy integrations with external APIs).
@@ -93,16 +93,16 @@ Key capabilities:
9393
- **Authentication** — OAuth2 client credentials, API key, or bearer token with automatic token management
9494
- **JSONata mapping** — Transform request and response payloads using JSONata expressions
9595
- **Inbound routing** — Optionally queue the response to the inbound pipeline for async entity processing
96-
- **Secure proxy support** — Route calls through static IP or VPN VPCs when needed
96+
- **Secure proxy support** — Route calls through a static IP or VPN connection when needed
9797

9898
See the [Configuration Guide](./configuration#managed-call-use-cases) for setup details.
9999

100100
### Secure Proxy
101101

102-
The Secure Proxy routes HTTP requests through VPC-deployed Lambda functions, providing either **static IP egress** (for IP-allowlisted external APIs) or **VPN access** (for customer private networks). It acts as the single authenticated gateway between epilot and customer networks.
102+
The Secure Proxy routes HTTP requests through epilot's dedicated proxy infrastructure, providing either **static IP egress** (for IP-allowlisted external APIs) or **VPN access** (for customer private networks). It acts as the single authenticated gateway between epilot and customer networks.
103103

104-
- **Static IP mode** — Routes through a NAT Gateway for a fixed outbound IP address
105-
- **Secure Link mode** — Routes through a VPN-connected VPC for access to private networks
104+
- **Static IP mode** — Routes outbound requests from a fixed, allowlistable IP address
105+
- **Secure Link mode** — Routes through a VPN connection for access to private networks
106106
- Domain whitelisting and CIDR-based IP allowlisting enforce strict access control
107107

108108
See the [Configuration Guide](./configuration#secure-proxy-use-cases) for setup details.

0 commit comments

Comments
 (0)