Skip to content

Commit

Permalink
[docs] update OAuth guide in README.rst
Browse files Browse the repository at this point in the history
The Pixiv extractor requires a 'refresh-token' since 8974f03 (mikf#1304).
  • Loading branch information
ClosedPort22 committed Jan 5, 2023
1 parent f29ba08 commit 0e8657e
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -328,20 +328,23 @@ 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``,
``smugmug``,
``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
Expand Down

0 comments on commit 0e8657e

Please sign in to comment.