-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Update docs for sharing #6164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update docs for sharing #6164
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,30 +2,42 @@ Sharing | |
------- | ||
|
||
.. note:: | ||
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`_. | ||
|
||
You can share your project with users outside of your company. | ||
There are two ways to do this: | ||
This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__. | ||
|
||
You can share your project with users outside of your company: | ||
|
||
* by sending them a *secret link*, | ||
* by giving them a *password*. | ||
|
||
These methods will allow them to view a specific project inside your company. | ||
|
||
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 or password), add an expiration date and a *Description* so you remember who you're sharing it with. | ||
* Under the *Share with someone new* heading, select the way you prefer (secret link, password, or HTTP header token), | ||
add an expiration date and a *Description* so you remember who you're sharing it with. | ||
* Click *Share!* to create. | ||
* Get the info needed to share your documentation with other users: | ||
|
||
* If you have selected secret link, copy the link that is generated | ||
* In case of password, copy the link and password | ||
* For HTTP header token, you need to pass the ``Authorization`` header in your HTTP request. | ||
|
||
* Give that information to the person who you want to give access. | ||
|
||
.. note:: You can always revoke access in the same panel. | ||
.. note:: | ||
|
||
You can always revoke access in the same panel. | ||
|
||
.. note:: | ||
|
||
Sharing using a password and a HTTP header token are currently in beta. | ||
If you want access to these features, email us to [email protected]. | ||
|
||
Effects | ||
~~~~~~~ | ||
|
@@ -40,6 +52,17 @@ Password | |
******** | ||
|
||
Once the person you send the link to clicks on the link, they will see | ||
a *Authorization required* page asking them for the password you | ||
an *Authorization required* page asking them for the password you | ||
generated. When the user enters the password, they will have access to | ||
view your project. | ||
|
||
HTTP Authorization Header | ||
************************* | ||
|
||
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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.