Update "default" to "auto" for clarity, update docs

pull/222/head
erinhmclark 2025-03-28 13:16:16 +00:00
rodzic 1db7d6702d
commit 5e7c57650b
3 zmienionych plików z 8 dodań i 5 usunięć

Wyświetl plik

@ -164,8 +164,8 @@ See the [bgutil-ytdlp-pot-provider](https://github.com/Brainicism/bgutil-ytdlp-p
## Configurations Summary
| Option | Behavior | Docker Default? |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------------- |
| `default` | Docker: Automatically downloads and uses the token generation script. Local: Does nothing; assumes a separate server is running externally. | ✅ Yes |
|------------| ------------------------------------------------------------------------------------------------------------------------------------------ | --------------- |
| `auto` | Docker: Automatically downloads and uses the token generation script. Local: Does nothing; assumes a separate server is running externally. | ✅ Yes |
| `script` | Explicitly downloads and uses the token generation script, even locally. | ❌ No |
| `disabled` | Disables token generation completely. | ❌ No |
@ -176,6 +176,9 @@ Example configuration:
generic_extractor:
# ...
bguils_po_token_method: "script"
# For debugging add the verbose flag here:
ytdlp_args: "--no-abort-on-error --abort-on-error --verbose"
```
**Advanced Configuration:**

Wyświetl plik

@ -75,9 +75,9 @@ If you are having issues with the extractor, you can review the version of `yt-d
"help": "Use to limit the number of videos to download when a channel or long page is being extracted. 'inf' means no limit.",
},
"bguils_po_token_method": {
"default": "default",
"default": "auto",
"help": "Set up a Proof of origin token provider. This process has additional requirements. See [authentication](https://auto-archiver.readthedocs.io/en/latest/how_to/authentication_how_to.html) for more information.",
"choices": ["default", "script", "disabled"],
"choices": ["auto", "script", "disabled"],
},
"extractor_args": {
"default": {},

Wyświetl plik

@ -88,7 +88,7 @@ class GenericExtractor(Extractor):
logger.warning("Proof of Origin Token generation is disabled.")
return
if self.bguils_po_token_method == "default" and not in_docker:
if self.bguils_po_token_method == "auto" and not in_docker:
logger.info(
"Proof of Origin Token method not explicitly set. "
"If you're running an external HTTP server separately, you can safely ignore this message. "