diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 1330e5f..196acfc 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -1,7 +1,7 @@ # 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. +> this configuration will override the global configuration. 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: @@ -15,4 +15,4 @@ instagram: * `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. \ No newline at end of file +* `impersonate`: whether to impersonate chrome. this is useful for extractors that require specific browsers' fingerprints to work. \ No newline at end of file diff --git a/EDGEPROXY.md b/EDGEPROXY.md index 2bf1ea6..7514dd9 100644 --- a/EDGEPROXY.md +++ b/EDGEPROXY.md @@ -15,7 +15,7 @@ reddit: ``` ## response format -the edge proxy must respond with a JSON object in the following format (see [models.EdgeProxyResponse](models/edgeproxy.go)) +the edge proxy must respond with a JSON object in the following format (see [`models.EdgeProxyResponse`](models/edgeproxy.go)). ```json { @@ -36,6 +36,6 @@ the edge proxy must respond with a JSON object in the following format (see [mod the main difference between http proxy and edge proxy is that http proxy is a standard proxy that forwards requests and responses, while edge proxy is a custom proxy that can modify the requests and responses in any way you want. ## notes -* edge proxy is for advanced use ant not required for most users. +* edge proxy is for advanced use and not required for most users. * this feature is experimental and may change in the future. -* you can check full implementation of the edge proxy in the [edgeproxy](util/edgeproxy.go) package. \ No newline at end of file +* you can check full implementation of the edge proxy in the [`util/edgeproxy`](util/edgeproxy.go) package. \ No newline at end of file