summaryrefslogtreecommitdiff
path: root/docs/configuration/domain-filter.md
diff options
context:
space:
mode:
authorPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-19 17:54:18 +0200
committerPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-19 18:21:58 +0200
commit0daefa86b400efe08245f4f2a386f7341b76b24e (patch)
tree60d743bb9734a9d7f46701a5ac9026650a330d49 /docs/configuration/domain-filter.md
parent03b3be0c3bbc70584e8988e1810dc28eacf4521f (diff)
docs: Add documentationv0.3.0
Diffstat (limited to 'docs/configuration/domain-filter.md')
-rw-r--r--docs/configuration/domain-filter.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/configuration/domain-filter.md b/docs/configuration/domain-filter.md
new file mode 100644
index 0000000..e8adc30
--- /dev/null
+++ b/docs/configuration/domain-filter.md
@@ -0,0 +1,44 @@
+# Domain Filter
+
+The `allowedDomains` and `blockedDomains` config options allow you to specify a list of domains which are accessible or blocked during scraping.
+
+```javascript
+export const options = {
+ url: "http://example.com/",
+ allowedDomains: ["subdomain.example.com"],
+ // ...
+};
+```
+
+### `allowedDomains`
+
+This config option controls which additional domains are allowed to be visted during scraping. The domain of the initial URL is always allowed.
+
+You can also allow all domains to be accessible by setting `allowedDomains` to `["*"]`. To then further restrict access, you can specify `blockedDomains`.
+
+Example:
+
+```javascript
+export const options = {
+ url: "http://example.com/",
+ allowedDomains: ["*"],
+ // ...
+};
+```
+
+### `blockedDomains`
+
+This config option controls which additional domains are blocked from being accessed. By default all domains other than the domain of the initial URL or those specified in `allowedDomains` are blocked.
+
+You can best use `blockedDomains` in conjunction with `allowedDomains: ["*"]`, allowing the scraping process to access all domains except what's specified in `blockedDomains`.
+
+Example:
+
+```javascript
+export const options = {
+ url: "http://example.com/",
+ allowedDomains: ["*"],
+ blockedDomains: ["google.com", "bing.com"],
+ // ...
+};
+```