Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Commit

Permalink
Merge pull request #28 from Microsoft/update_documentation_for_1.4.0
Browse files Browse the repository at this point in the history
Update documentation for 1.4.0
  • Loading branch information
davidstaheli committed Jan 30, 2016
2 parents 50d08b7 + 5be32ef commit 1bf8b3b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
22 changes: 11 additions & 11 deletions Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Great care was taken to avoid using any features of Java that would impact compa
On Mac OS X, installing via Homebrew is highly recommended.
On Linux, it is recommended to use Linuxbrew or an RPM-based package manager if you can.

If you can't use any of the package managers, you can also download [git-credential-manager-1.3.0.jar](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.3.0/git-credential-manager-1.3.0.jar) somewhere safe and stable, such as `~/git-credential-manager/`, and then follow the instructions for automatic or manual configuration.
If you can't use any of the package managers, you can also download [git-credential-manager-1.4.0.jar](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.4.0/git-credential-manager-1.4.0.jar) somewhere safe and stable, such as `~/git-credential-manager/`, and then follow the instructions for automatic or manual configuration.


### Installing on Mac using Homebrew or on Linux using Linuxbrew (recommended)
Expand All @@ -39,7 +39,7 @@ If you can't use any of the package managers, you can also download [git-credent

### Installing on Linux using RPM (recommended)

1. Download [git-credential-manager-1.3.0-1.noarch.rpm](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.3.0/git-credential-manager-1.3.0-1.noarch.rpm) and copy the file somewhere locally.
1. Download [git-credential-manager-1.4.0-1.noarch.rpm](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.4.0/git-credential-manager-1.4.0-1.noarch.rpm) and copy the file somewhere locally.
2. Download the [PGP key used to sign the RPM](https://java.visualstudio.com/Content/RPM-GPG-KEY-olivida.txt).
3. Import the signing key into RPM's database:

Expand All @@ -49,7 +49,7 @@ If you can't use any of the package managers, you can also download [git-credent
4. Verify the GCM RPM:

```
rpm --checksig --verbose git-credential-manager-1.3.0-1.noarch.rpm
rpm --checksig --verbose git-credential-manager-1.4.0-1.noarch.rpm
```
...you should see a line (among those there) that is equal to the following:

Expand All @@ -59,7 +59,7 @@ If you can't use any of the package managers, you can also download [git-credent
5. Install the RPM:

```
sudo rpm --install git-credential-manager-1.3.0-1.noarch.rpm
sudo rpm --install git-credential-manager-1.4.0-1.noarch.rpm
```
6. Run the GCM in `install` mode, which will check its requirements and then update the "global" Git configuration file (the one in your home folder):

Expand All @@ -69,20 +69,20 @@ If you can't use any of the package managers, you can also download [git-credent


### Installing on Mac or Linux without a package manager
Download [git-credential-manager-1.3.0.jar](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.3.0/git-credential-manager-1.3.0.jar) somewhere safe and stable, such as `~/git-credential-manager/`
Download [git-credential-manager-1.4.0.jar](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux/releases/download/git-credential-manager-1.4.0/git-credential-manager-1.4.0.jar) somewhere safe and stable, such as `~/git-credential-manager/`

#### Automatic configuration (recommended)
1. Run the GCM in `install` mode, which will check its requirements and then update the "global" Git configuration file (the one in your home folder):

```
java -jar /home/example/git-credential-manager/git-credential-manager-1.3.0.jar install
java -jar /home/example/git-credential-manager/git-credential-manager-1.4.0.jar install
```

#### Manual configuration
1. Configure the `credential.helper` setting to launch Java with the absolute path to the JAR (make sure you surround the whole value with 'single quotes'):

```
git config --global credential.helper '!java -Ddebug=false -jar /home/example/git-credential-manager/git-credential-manager-1.3.0.jar'
git config --global credential.helper '!java -Ddebug=false -jar /home/example/git-credential-manager/git-credential-manager-1.4.0.jar'
```


Expand All @@ -95,7 +95,7 @@ Debug mode will turn on tracing and assertions, producing a lot of output to `st
1. Run the GCM in `install` mode with the `debug` property set to `true` (or `false` to disable):

```
java -Ddebug=true -jar /home/example/git-credential-manager/git-credential-manager-1.3.0.jar install
java -Ddebug=true -jar /home/example/git-credential-manager/git-credential-manager-1.4.0.jar install
```

### Manual configuration
Expand All @@ -107,7 +107,7 @@ Debug mode will turn on tracing and assertions, producing a lot of output to `st
...it should look like this:

```
!java -Ddebug=false -jar /home/example/git-credential-manager/git-credential-manager-1.3.0.jar
!java -Ddebug=false -jar /home/example/git-credential-manager/git-credential-manager-1.4.0.jar
```
2. Set a new value for the `credential.helper` configuration (essentially repeating the _manual configuration step_, being careful with quoting and spaces), changing the value of the `debug` property to `true` (or `false` to disable).

Expand Down Expand Up @@ -140,7 +140,7 @@ We are sad to see you go! Please give us some feedback on how we could do bette
2. Uninstall the git-credential-manager package with RPM:

```
sudo rpm --erase git-credential-manager-1.3.0-1.noarch
sudo rpm --erase git-credential-manager-1.4.0-1.noarch
```
3. Archive the `insecureStore.xml` file from the `git-credential-manager` sub-folder under your HOME folder.

Expand All @@ -154,7 +154,7 @@ We are sad to see you go! Please give us some feedback on how we could do bette
2. Run the GCM in `uninstall` mode, which will update the "global" Git configuration file (the one in your home folder):

```
java -jar /home/example/git-credential-manager/git-credential-manager-1.3.0.jar uninstall
java -jar /home/example/git-credential-manager/git-credential-manager-1.4.0.jar uninstall
```
3. The value retrieved in _step 1_ contained the path to the JAR. You can go delete that JAR.
4. Archive the `insecureStore.xml` file from the `git-credential-manager` sub-folder under your HOME folder.
Expand Down
2 changes: 1 addition & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Git Credential Manager for Mac and Linux
========================================
Stores credentials for Git version control securely.
Stores credentials for Git version control securely.
Provides secure logon for Visual Studio Team Services (visualstudio.com).


Expand Down
2 changes: 1 addition & 1 deletion templates/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This will download the dependencies, compile the code, run unit tests, and packa

How can I contribute?
---------------------
Please refer to [Contributing.md](Contibuting.md) or [Contributing.html](Contributing.html).
Please refer to [Contributing.md](Contributing.md) or [Contributing.html](Contributing.html).


How can I find out more?
Expand Down

0 comments on commit 1bf8b3b

Please sign in to comment.