search

vericast / nbconflux

nbconflux converts Jupyter Notebooks to Atlassian Confluence pages
BSD 3-Clause "New" or "Revised" License
119 stars 33 forks source link

Add documentation for using API Token #19

Closed krake-r closed 5 years ago

krake-r commented 5 years ago

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 commented 5 years ago

Thanks Rick.

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

parente commented 5 years ago

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.