feat(docs): document additional config parameter

0xERR0R · Dec 13, 2024 · 2d004c3 · 2d004c3
1 parent 1d24c72
commit 2d004c3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/docs/config.yml b/docs/config.yml
@@ -120,6 +120,10 @@ blocking:
       # optional: timeout for list download (each url). Use large values for big lists or slow internet connections
       # default: 5s
       timeout: 60s
+      # optional: timeout for reading request headers for the download (each url). Use large values for slow internet connections
+      # to disable, set to -1.
+      # default: 20s
+      readHeaderTimeout: 60s
       # optional: Maximum download attempts
       # default: 3
       attempts: 5

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -884,11 +884,12 @@ A value of zero or less will disable this feature.
 
 Configures how HTTP(S) sources are downloaded:
 
-| Parameter | Type     | Mandatory | Default value | Description                                    |
-| --------- | -------- | --------- | ------------- | ---------------------------------------------- |
-| timeout   | duration | no        | 5s            | Download attempt timeout                       |
-| attempts  | int      | no        | 3             | How many download attempts should be performed |
-| cooldown  | duration | no        | 500ms         | Time between the download attempts             |
+| Parameter         | Type     | Mandatory | Default value | Description                                    |
+| ----------------- | -------- | --------- | ------------- | ---------------------------------------------- |
+| timeout           | duration | no        | 5s            | Download attempt timeout                       |
+| readHeaderTimeout | duration | no        | 20s           | Download request header read timeout           |
+| attempts          | int      | no        | 3             | How many download attempts should be performed |
+| cooldown          | duration | no        | 500ms         | Time between the download attempts             |
 
 !!! example