Skip to content

Commit

Permalink
Merge pull request #6410 from stsewd/update-docs-sharing
Browse files Browse the repository at this point in the history
Update docs on sharing
  • Loading branch information
stsewd committed Nov 27, 2019
2 parents 90596ab + 1ce9a9a commit 9dc5d54
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/commercial/sharing.rst
@@ -1,5 +1,5 @@
Sharing
-------
=======

.. note::

Expand All @@ -16,7 +16,7 @@ Additionally, you can use a HTTP Authorization Header.
This is useful to have access from a script.

Enabling
~~~~~~~~
--------

* Go into your *Project Admin* page and to the *Sharing* menu.
* Under the *Share with someone new* heading, select the way you prefer (secret link, password, or HTTP header token),
Expand All @@ -40,7 +40,7 @@ Enabling
If you want access to these features, email us to support@readthedocs.com.

Effects
~~~~~~~
-------

Secret Link
***********
Expand All @@ -59,10 +59,23 @@ view your project.
HTTP Authorization Header
*************************

Token Authorization
~~~~~~~~~~~~~~~~~~~

You need to send the ``Authorization`` header with the token on each HTTP request.
The header has the form ``Authorization: Token <ACCESS_TOKEN>``.
For example:

.. prompt:: bash $

curl -H "Authorization: Token 19okmz5k0i6yk17jp70jlnv91v" https://docs.example.com/en/latest/example.html

Basic Authorization
~~~~~~~~~~~~~~~~~~~

You can also use basic authorization, with the token as user and an empty password.
For example:

.. prompt:: bash $

curl --url https://docs.example.com/en/latest/example.html --user '19okmz5k0i6yk17jp70jlnv91v:'

0 comments on commit 9dc5d54

Please sign in to comment.