Skip to content

Commit 7a9689a

Browse files
authored
docs(chromium): ignoreResourceHttpStatusDomains option (#37)
1 parent 6ca76d8 commit 7a9689a

1 file changed

Lines changed: 35 additions & 4 deletions

File tree

docs/routes.mdx

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -822,13 +822,23 @@ Note that the *scope* token is only processed by Gotenberg and is never sent wit
822822

823823
Each route accepts the following form field:
824824

825-
| Key | Description | Default |
826-
|-------------------------------|--------------------------------------------------------------------------------------------------------|-------------|
827-
| failOnHttpStatusCodes | Return a *409 Conflict* response if the HTTP status code from the main page is not acceptable. | \[499,599\] |
828-
| failOnResourceHttpStatusCodes | Return a *409 Conflict* response if the HTTP status code from at least one resource is not acceptable. | None |
825+
| Key | Description | Default |
826+
|---------------------------------|--------------------------------------------------------------------------------------------------------|-------------|
827+
| failOnHttpStatusCodes | Return a *409 Conflict* response if the HTTP status code from the main page is not acceptable. | \[499,599\] |
828+
| failOnResourceHttpStatusCodes | Return a *409 Conflict* response if the HTTP status code from at least one resource is not acceptable. | None |
829+
| ignoreResourceHttpStatusDomains | Exclude resources from `failOnResourceHttpStatusCodes` checks based on their hostname. | None |
829830

830831
An *X99* entry means every HTTP status codes between *X00* and *X99* (e.g., 499 means every HTTP status codes between 400 and 499).
831832

833+
The `ignoreResourceHttpStatusDomains` option allows you to exclude specific domains from the resource HTTP status code checks.
834+
A match happens if the hostname equals the domain or is a subdomain of it (e.g., `browser.sentry-cdn.com` matches `sentry-cdn.com`).
835+
836+
Values are normalized (trimmed, lowercased) and may be provided as:
837+
* `example.com`
838+
* `*.example.com` or `.example.com`
839+
* `example.com:443` (port is ignored)
840+
* `https://example.com/path` (scheme/path are ignored)
841+
832842
<Tabs
833843
defaultValue="curl"
834844
values={[
@@ -866,6 +876,27 @@ Invalid HTTP status code from the main page: 400: Bad Request
866876
</TabItem>
867877
</Tabs>
868878

879+
To ignore certain domains when checking resource HTTP status codes:
880+
881+
<Tabs
882+
defaultValue="curl"
883+
values={[
884+
{ label: 'cURL', value: 'curl', },
885+
]
886+
}>
887+
<TabItem value="curl">
888+
889+
```bash {4-5}
890+
curl \
891+
--request POST http://localhost:3000/forms/chromium/convert/html \
892+
--form files=@/path/to/index.html \
893+
--form 'failOnResourceHttpStatusCodes=[499,599]' \
894+
--form 'ignoreResourceHttpStatusDomains=["sentry-cdn.com","analytics.example.com"]'
895+
```
896+
897+
</TabItem>
898+
</Tabs>
899+
869900
### Network Errors {#network-errors-chromium}
870901

871902
Gotenberg returns a *400 Bad Request* if it encounters any of the following network errors while attempting to load

0 commit comments

Comments
 (0)