improved docs
This commit is contained in:
parent
a24d9348bf
commit
491867d7e4
8 changed files with 232 additions and 145 deletions
18
CONFIGURATION.md
Normal file
18
CONFIGURATION.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
# configuration
|
||||
the `ext-cfg.yaml` file allows you to set custom options for each extractor. this is useful for advanced configuration of the bot, mostly related to network settings.
|
||||
> [!NOTE]
|
||||
> this configuration will override the global configuration in the `.env` file. this is useful in case you want to set a global proxy in the `.env` file and then override it for specific extractors in the `ext-cfg.yaml` file.
|
||||
|
||||
## structure
|
||||
the file uses yaml format. each top-level key is the name of an extractor. under each extractor, you can define options supported by that extractor, for example:
|
||||
```yaml
|
||||
instagram:
|
||||
edge_proxy_url: https://example.com
|
||||
impersonate: true
|
||||
```
|
||||
|
||||
## available options
|
||||
* `http_proxy` | `https_proxy`: the http(s) proxy to use for this extractor. see [proxying](README.md#proxying) for more information.
|
||||
* `no_proxy`: the domains that should not be proxied for this extractor.
|
||||
* `edge_proxy_url`: the url of the edge proxy to use for this extractor. see [edge proxy](EDGEPROXY.md) for more information.
|
||||
* `impersonate`: whether to impersonate a browser for this extractor. this is useful for extractors that require specific browsers' fingerprints to work.
|
Loading…
Add table
Add a link
Reference in a new issue