-
Notifications
You must be signed in to change notification settings - Fork 84
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
Populate with earthaccess.login
guide in User Guide Authentications docs
#862
base: main
Are you sure you want to change the base?
Conversation
…ccess into update-authentications-docs
👈 Launch a binder notebook on this branch for commit 4fb4e78 I will automatically update this comment whenever this PR is modified 👈 Launch a binder notebook on this branch for commit 137c45c 👈 Launch a binder notebook on this branch for commit 078b375 👈 Launch a binder notebook on this branch for commit bb44a8e 👈 Launch a binder notebook on this branch for commit e76af26 👈 Launch a binder notebook on this branch for commit 743836d 👈 Launch a binder notebook on this branch for commit ef64b1e 👈 Launch a binder notebook on this branch for commit afe49f9 👈 Launch a binder notebook on this branch for commit ff4c717 |
|
||
Setting `strategy=interactive` will force a manual login. | ||
|
||
## Login using a `.netrc` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a note here might be really useful -- we don't (yet) support encrypted netrc files, and this strategy of writing credentials in plain text to disk should not be used on untrusted machines or shared user accounts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good suggestion. I will add an admonition
export EARTHDATA_USERNAME="username" | ||
export EARTHDATA_PASSWORD="password" | ||
``` | ||
If you want to set these environmental variables permanently, add these two lines to your `.bashrc` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.bashrc
for Linux and .profile
for Mac won't always be correct. I'm not very familiar with zsh yet, but I believe it uses a .zprofile
file? Bash users can permanently set envvars in .profile
as well, but that will only work for "login" shells. There isn't really a one-size-fits-all answer here, it depends on the shell.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So should we just say "add [these] to the appropriate configuration files for your operating system."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that makes sense as a fallback instruction; e.g.:
If you use
bash
and would like to set these environment variables permanently, add these two lines to your~/.profile
file: ... code ... . Otherwise, use the recommended method to persistently set environment variables for whichever shell you use.
Something like that?
fix typo - extra "a" Co-authored-by: Matt Fisher <[email protected]>
Fix typo - "login" to "log in" Co-authored-by: Matt Fisher <[email protected]>
Co-authored-by: Matt Fisher <[email protected]>
make method summary a bulleted list with links Co-authored-by: Matt Fisher <[email protected]>
add explanatory text Co-authored-by: Matt Fisher <[email protected]>
Change to fixed-width Co-authored-by: Matt Fisher <[email protected]>
Make terminology consistent Co-authored-by: Matt Fisher <[email protected]>
Fix typo Co-authored-by: Matt Fisher <[email protected]>
Populated authentication page in User Guide
title such as "Add testing details to the contributor section of the README".
Example PRs: #763
This resolves #853 add (hopefully) a complete guide to using
earthaccess.login
and auth methods.The following are included in the page:
earthaccess.login
to manually login, and use netrc and environment variables.Much of this information comes from the "How do I" section. I suggest that we remove content from that section and use the "How do I..." to provide specific links to the User Guide Authentication.
📚 Documentation preview 📚: https://earthaccess--862.org.readthedocs.build/en/862/