Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orion/Documentation/User Guide/Reference/Git Credentials Storage"

(New page: == Git Credentials Storage == '''Git Credentials Storage''' is a new Orion feature. It aims to facilitate working with remote git repositories by providing git credentials for the user w...)
 
m
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Git Credentials Storage ==
+
== Git credentials storage ==
  
'''Git Credentials Storage''' is a new Orion feature. It aims to facilitate working with remote git repositories by providing git credentials for the user whenever required. The workflow is very simple: Go to Settings->User Profile and enable the Git Credentials Storage. Now, when you use one of '''fetch''', '''pull''', '''push all''' or '''force push all''' commands, provide your private key and/or passphrase and make sure you check the ''"Don't prompt me again"'' option. From now on, you are not required to provide any git credentials for that particular repository again - Git Credentials Storage will handle them for you. See the detailed description of the workflow below.  
+
'''Git Credentials Storage''' is used to store credentials for remote git repositories so that they needn't be entered each time a remote operation is performed.  Storage must be enabled by going to the Settings->Git Settings page and checking the Git Credentials Storage checkbox. After storage is enabled, when you are prompted for credentials while performing a remote operation such as '''fetch''', '''pull''', or '''push all,''' you provide your private key and (and optional passphrase) and check the ''"Don't prompt me again"'' checkbox. At this point, Git Credentials Storage will provide credentials for subsequent operations on that remote.
  
== Enable Storage ==
+
== Enable storage ==
  
Go to ''Settings->User Profile'' and check the ''Enable Storage'' checkbox. Click on the ''Update'' command in order to enable the storage mechanism.
+
Go to '''Settings''' page and click on the '''User Profile''' settings category.  Check the '''Enable Storage''' checkbox. Click on the '''Update''' command in order to enable the storage mechanism.
  
'''Note''' that the Storage is disabled by default.  
+
( Note that the Storage is disabled by default.)
  
[[Image:Git-credentials-storage-1.png|800x200px]]
+
[[Image:Git-credentials-storage-1.png|1000x200px]]
  
 
== Provide private key and/or passphrase ==
 
== Provide private key and/or passphrase ==
  
Use one of '''fetch''', '''pull''', '''push all''' or '''force push all''' commands. When you notice the slideout click ''More'':
+
When performing an operation on the remote, you will be prompted for credentials.  Click the '''More''' button in the prompt.
  
[[Image:Git-credentials-storage-2.png|750x500px]]
+
[[Image:Git-credentials-storage-2.png]]
  
Now you will see the git credentials dialog with an additional ''Dont't prompt me again'' checkbox. Provide your private key either by copying it in the ''Private key'' textarea, or by uploading it from a file. Provide your passphrase. Be sure to choose the ''Don't prompt me again'' option and click ''Ok''.
+
Now you will see the git credentials dialog with an additional ''Don't prompt me again'' checkbox. Provide your private key either by copying it into the '''Private key''' text area, or by uploading it from a file. Provide your passphrase if you have one. Be sure to choose the ''Don't prompt me again'' option and click '''Ok'''.
  
 
[[Image:Git-credentials-storage-3.png]]
 
[[Image:Git-credentials-storage-3.png]]
  
 
From now on, your private key and passphrase are stored in the Git Credential Storage and automatically provided whenever required.
 
From now on, your private key and passphrase are stored in the Git Credential Storage and automatically provided whenever required.
 +
 +
== Delete credentials ==
 +
 +
In order to delete all git credentials for a particular repository go to '''User Profile''' category on the '''Settings''' page and find the repository in the storage list.  Click on the corresponding '''Delete''' button for the repository.
 +
 +
[[Image:Git-credentials-storage-4.png]]
 +
 +
== Technical details ==
 +
 +
'''Git Credentials Storage''' is based on the persistent local storage available in modern browsers. Please be aware, that all git credentials are stored in a plain form in your local browser. Clearing your local storage will erase all stored credentials.
 +
 +
[[Category:Orion]]

Latest revision as of 11:47, 5 July 2017

Git credentials storage

Git Credentials Storage is used to store credentials for remote git repositories so that they needn't be entered each time a remote operation is performed. Storage must be enabled by going to the Settings->Git Settings page and checking the Git Credentials Storage checkbox. After storage is enabled, when you are prompted for credentials while performing a remote operation such as fetch, pull, or push all, you provide your private key and (and optional passphrase) and check the "Don't prompt me again" checkbox. At this point, Git Credentials Storage will provide credentials for subsequent operations on that remote.

Enable storage

Go to Settings page and click on the User Profile settings category. Check the Enable Storage checkbox. Click on the Update command in order to enable the storage mechanism.

( Note that the Storage is disabled by default.)

Git-credentials-storage-1.png

Provide private key and/or passphrase

When performing an operation on the remote, you will be prompted for credentials. Click the More button in the prompt.

Git-credentials-storage-2.png

Now you will see the git credentials dialog with an additional Don't prompt me again checkbox. Provide your private key either by copying it into the Private key text area, or by uploading it from a file. Provide your passphrase if you have one. Be sure to choose the Don't prompt me again option and click Ok.

Git-credentials-storage-3.png

From now on, your private key and passphrase are stored in the Git Credential Storage and automatically provided whenever required.

Delete credentials

In order to delete all git credentials for a particular repository go to User Profile category on the Settings page and find the repository in the storage list. Click on the corresponding Delete button for the repository.

Git-credentials-storage-4.png

Technical details

Git Credentials Storage is based on the persistent local storage available in modern browsers. Please be aware, that all git credentials are stored in a plain form in your local browser. Clearing your local storage will erase all stored credentials.

Back to the top