mirror of https://github.com/devine-dl/devine.git
Update CONFIG docs to use proxy_providers
Also removes an old unused `proxies` config option.
This commit is contained in:
parent
961747b74c
commit
b6d3c8368a
62
CONFIG.md
62
CONFIG.md
|
@ -211,31 +211,6 @@ together.
|
||||||
- `set_title`
|
- `set_title`
|
||||||
Set the container title to `Show SXXEXX Episode Name` or `Movie (Year)`. Default: `true`
|
Set the container title to `Show SXXEXX Episode Name` or `Movie (Year)`. Default: `true`
|
||||||
|
|
||||||
## nordvpn (dict)
|
|
||||||
|
|
||||||
Set your NordVPN Service credentials with `username` and `password` keys to automate the use of NordVPN as a Proxy
|
|
||||||
system where required.
|
|
||||||
|
|
||||||
You can also specify specific servers to use per-region with the `servers` key.
|
|
||||||
Sometimes a specific server works best for a service than others, so hard-coding one for a day or two helps.
|
|
||||||
|
|
||||||
For example,
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
username: zxqsR7C5CyGwmGb6KSvk8qsZ # example of the login format
|
|
||||||
password: wXVHmht22hhRKUEQ32PQVjCZ
|
|
||||||
servers:
|
|
||||||
- us: 12 # force US server #12 for US proxies
|
|
||||||
```
|
|
||||||
|
|
||||||
The username and password should NOT be your normal NordVPN Account Credentials.
|
|
||||||
They should be the `Service credentials` which can be found on your Nord Account Dashboard.
|
|
||||||
|
|
||||||
Once set, you can also specifically opt in to use a NordVPN proxy by specifying `--proxy=gb` or such.
|
|
||||||
You can even set a specific server number this way, e.g., `--proxy=gb2366`.
|
|
||||||
|
|
||||||
Note that `gb` is used instead of `uk` to be more consistent across regional systems.
|
|
||||||
|
|
||||||
## profiles (dict)
|
## profiles (dict)
|
||||||
|
|
||||||
Pre-define Profiles to use Per-Service.
|
Pre-define Profiles to use Per-Service.
|
||||||
|
@ -264,11 +239,15 @@ ALL4: false
|
||||||
CTV: false
|
CTV: false
|
||||||
```
|
```
|
||||||
|
|
||||||
## proxies (dict)
|
## proxy_providers (dict)
|
||||||
|
|
||||||
Define a list of proxies to use where required.
|
Enable external proxy provider services.
|
||||||
The keys are region Alpha 2 Country Codes. Alpha 2 Country Codes are `a-z{2}` codes, e.g., `us`, `gb`, and `jp`.
|
|
||||||
Don't get mixed up between language codes like `en` vs. `gb`, or `ja` vs. `jp`.
|
### basic (dict)
|
||||||
|
|
||||||
|
Define a mapping of country to proxy to use where required.
|
||||||
|
The keys are region Alpha 2 Country Codes. Alpha 2 Country Codes are `[a-z]{2}` codes, e.g., `us`, `gb`, and `jp`.
|
||||||
|
Don't get this mixed up with language codes like `en` vs. `gb`, or `ja` vs. `jp`.
|
||||||
|
|
||||||
For example,
|
For example,
|
||||||
|
|
||||||
|
@ -277,6 +256,31 @@ us: "http://john%40email.tld:password123@proxy-us.domain.tld:8080"
|
||||||
de: "http://127.0.0.1:8888"
|
de: "http://127.0.0.1:8888"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### nordvpn (dict)
|
||||||
|
|
||||||
|
Set your NordVPN Service credentials with `username` and `password` keys to automate the use of NordVPN as a Proxy
|
||||||
|
system where required.
|
||||||
|
|
||||||
|
You can also specify specific servers to use per-region with the `servers` key.
|
||||||
|
Sometimes a specific server works best for a service than others, so hard-coding one for a day or two helps.
|
||||||
|
|
||||||
|
For example,
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
username: zxqsR7C5CyGwmGb6KSvk8qsZ # example of the login format
|
||||||
|
password: wXVHmht22hhRKUEQ32PQVjCZ
|
||||||
|
servers:
|
||||||
|
- us: 12 # force US server #12 for US proxies
|
||||||
|
```
|
||||||
|
|
||||||
|
The username and password should NOT be your normal NordVPN Account Credentials.
|
||||||
|
They should be the `Service credentials` which can be found on your Nord Account Dashboard.
|
||||||
|
|
||||||
|
Once set, you can also specifically opt in to use a NordVPN proxy by specifying `--proxy=gb` or such.
|
||||||
|
You can even set a specific server number this way, e.g., `--proxy=gb2366`.
|
||||||
|
|
||||||
|
Note that `gb` is used instead of `uk` to be more consistent across regional systems.
|
||||||
|
|
||||||
## remote_cdm (list\[dict])
|
## remote_cdm (list\[dict])
|
||||||
|
|
||||||
Use [pywidevine] Serve-compliant Remote CDMs in devine as if it was a local widevine device file.
|
Use [pywidevine] Serve-compliant Remote CDMs in devine as if it was a local widevine device file.
|
||||||
|
|
|
@ -58,7 +58,6 @@ class Config:
|
||||||
self.muxing: dict = kwargs.get("muxing") or {}
|
self.muxing: dict = kwargs.get("muxing") or {}
|
||||||
self.nordvpn: dict = kwargs.get("nordvpn") or {}
|
self.nordvpn: dict = kwargs.get("nordvpn") or {}
|
||||||
self.profiles: dict = kwargs.get("profiles") or {}
|
self.profiles: dict = kwargs.get("profiles") or {}
|
||||||
self.proxies: dict = kwargs.get("proxies") or {}
|
|
||||||
self.proxy_providers: dict = kwargs.get("proxy_providers") or {}
|
self.proxy_providers: dict = kwargs.get("proxy_providers") or {}
|
||||||
self.serve: dict = kwargs.get("serve") or {}
|
self.serve: dict = kwargs.get("serve") or {}
|
||||||
self.services: dict = kwargs.get("services") or {}
|
self.services: dict = kwargs.get("services") or {}
|
||||||
|
|
Loading…
Reference in New Issue