Skip to content
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

Add documentation for using API Token #19

Closed
krake-r opened this issue Nov 12, 2018 · 2 comments
Closed

Add documentation for using API Token #19

krake-r opened this issue Nov 12, 2018 · 2 comments

Comments

@krake-r
Copy link

krake-r commented Nov 12, 2018

It is also possible to sign in with an Atlassian API Token for those scenarios where your organisation has employed multi-factor authentication as per: Use an API token

Sign into with your account. Under Security go to API Tokens then Create API Token. Give the token a meaningful label so that access can be revoked later. The token will be copied to the clipboard. Using Jupyter file editor create the token in the Jupyter environment and name the file confluence.token.

The api key can be used by setting the environment variables:

CONFLUENCE_PASSWORD=$(cat confluence.token)
CONFLUENCE_USERNAME=<me>
CONFLUENCE_URL=$(cat confluence.url)

Then calling nbconflux <notebook>.ipynb $CONFLUENCE_URL.

Using `CONFLUENCE_URL' was only to get around the paste to jupyter issue.

@ericdill
Copy link
Contributor

Thanks Rick.

@parente any thoughts on where to put this in the docs?

@parente
Copy link
Contributor

parente commented Nov 12, 2018

It could go in the FAQ under "What if my organization has Two-Factor Auth configured?" Or it can get mixed into the Usage section if it's clear when you need a token vs can just use your password.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants