github/gallery-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add example to 'cookies' docs

Browse Source
This commit is contained in:
Mike Fährmann
2020-02-13 23:44:02 +01:00
parent c7cf9dd111
commit ab13f81fd7
1 changed files with 17 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/configuration.rst
View File

@@ -225,12 +225,21 @@ extractor.*.cookies
=========== =====
Type |Path|_ or ``object``
Default ``null``
Description Source to read additional cookies from.
Description Source to read additional cookies from. Either as
* the |Path|_ to a Mozilla/Netscape format cookies.txt file or
* a JSON ``object`` specifying cookies as a name-to-value mapping
Example:
.. code::
{
"cookie-name": "cookie-value",
"sessionid" : "14313336321%3AsabDFvuASDnlpb%3A31",
"isAdult" : "1"
}
* If this is a |Path|_, it specifies a
Mozilla/Netscape format cookies.txt file.
* If this is an ``object``, its key-value pairs, which should both
be ``strings``, will be used as cookie-names and -values.
=========== =====
@@ -239,8 +248,9 @@ extractor.*.cookies-update
=========== =====
Type ``bool``
Default ``true``
Description If `extractor.*.cookies`_ specifies a cookies.txt file, update its
contents with cookies received during data extraction.
Description If `extractor.*.cookies`_ specifies the |Path|_ to a cookies.txt
file and it can be opened and parsed without errors,
update its contents with cookies received during data extraction.
=========== =====