OpenTree user accounts and GitHub
Open Tree of Life uses GitHub for user authentication. This page explains how that works, and why we do user accounts this way.
- Creating a GitHub account
- Adding an email address to your GitHub profile
- Adding other profile information
- Authorizing OpenTree to access your GitHub account
- Why do we use GitHub accounts?
Create your account at the GitHub signup page. The free plan gives you everything you will need for interaction with OpenTree. Choose you username carefully - you can change it later, but not all account history and links will follow a new username.
In order to associate your OpenTree curation activity with your GitHub account and to activate your OpenTree profile page, you need to associate an email address with your account. On your profile page, click the Edit profile button near the top right of the page.
The sidebar on the edit page has several different options:
The two of interest here are Profile and Emails. Select Emails and add an email address for your account. Click the green Update profile button when you are done.
You can choose to make your email address public or private. To change whether your email address is visible on your GitHub and OpenTree pages, select the Profile option on the sidebar. To keep your email private, chooise 'Don't show my email address' on the Public email field:
If you don't add an email address to your account, you can still log in and curate studies. However, we will not create a user profile page for you, and your OpenTree curation activity will not be associated with your account. If you want more details about the requirement for an email address, you can see this GitHub help page.
Your OpenTree profile page can show your name, affiliation, website, and email address if you have these fields set on your GitHub profile. For example, compare kcranston's GitHub profile and her OpenTree profile page:
Her OpenTree profile lists her affiliation, name, and profile picture but does not show her email address, which is private.
To control what appears on your OpenTree profile page, edit your GitHub profile (there is an Edit button on your OpenTree profile page that will open your GitHub profile, as shown in the image above).
The first time you log in to OpenTree using your GitHub account, you will be asked to authorize OpenTree to use your GitHub account. OpenTree will only be able to see your public profile data, and will not see any private data or your password. If you want to revoke this access at a later date, you can do so using the Applications option on your GitHub profile.
Two main reasons. First, OpenTree stores our tree database under version control on GitHub (see this publication and this repository for more info). Associating our user accounts with GitHub means that we can easily capture the full history of edits to the database - who curated what trees, what changes they made, and when.
Second, creating and maintaining web site infrastructure, such as user registration, secure login, and profile management, is tricky and it's easy to get it wrong. By letting GitHub take care of chores for us, we are letting it do things that it can do better than we can, and we save precious time that can be spent instead on work that promotes the science.