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

merge #3496: [docs] update OAuth guide in README.rst

Browse Source
This commit is contained in:
Mike Fährmann
2023-01-06 13:36:23 +01:00
parent 2f31d21509 c94692f39b
commit ac78712618
2 changed files with 31 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@@ -328,7 +328,10 @@ For example:
OAuth
-----
*gallery-dl* supports user authentication via OAuth_ for
*gallery-dl* supports user authentication via OAuth_ for some extractors.
This is necessary for
``pixiv``
and optional for
``deviantart``,
``flickr``,
``reddit``,
@@ -336,12 +339,12 @@ OAuth
``tumblr``,
and ``mastodon`` instances.
This is mostly optional, but grants *gallery-dl* the ability
to issue requests on your account's behalf and enables it to access resources
which would otherwise be unavailable to a public user.
Linking your account to *gallery-dl* grants it the ability to issue requests
on your account's behalf and enables it to access resources which would
otherwise be unavailable to a public user.
To link your account to *gallery-dl*, start by invoking it with
``oauth:<sitename>`` as an argument. For example:
To do so, start by invoking it with ``oauth:<sitename>`` as an argument.
For example:
.. code:: bash

28
docs/configuration.rst
View File

@@ -1845,8 +1845,24 @@ Description
List of acceptable content ratings for returned chapters.
extractor.mastodon.reblogs
--------------------------
extractor.[mastodon].access-token
---------------------------------
Type
``string``
Default
``null``
Description
The ``access-token`` value you get from `linking your account to
gallery-dl <OAuth_>`__.
Note: gallery-dl comes with built-in tokens for ``mastodon.social``,
``pawoo`` and ``baraag``. For other instances, you need to obtain an
``access-token`` in order to use usernames in place of numerical
user IDs.
extractor.[mastodon].reblogs
----------------------------
Type
``bool``
Default
@@ -1855,8 +1871,8 @@ Description
Fetch media from reblogged posts.
extractor.mastodon.replies
--------------------------
extractor.[mastodon].replies
----------------------------
Type
``bool``
Default
@@ -1865,8 +1881,8 @@ Description
Fetch media from replies to other posts.
extractor.mastodon.text-posts
-----------------------------
extractor.[mastodon].text-posts
-------------------------------
Type
``bool``
Default