Skip to content
This repository has been archived by the owner on May 26, 2021. It is now read-only.

Commit

Permalink
Merge pull request #19 from andyg5000/master
Browse files Browse the repository at this point in the history
Issue #18 add documentation for using ssh key authentication
  • Loading branch information
chasingmaxwell authored Sep 2, 2016
2 parents d7c624a + a7425dd commit e5eeaa3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ There are a few flags and configuration options which allow you to specify the r

All of these options can be set within `aquifer.json` so you do not have to specify the flags/values every time you would like to run `deploy-git`. To learn more about setting these options, read the [Configuration](#configuration) section of this document.

#### SSH Key Authentication

If your git repository is using SSH keys for authentication, make sure that your ssh key has been added to the ssh-agent. [See github's documentation for more information](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#adding-your-ssh-key-to-the-ssh-agent).

### Example useage
```bash
aquifer deploy-git -r "[email protected]:repositoryname.git" -b "master" -m "Version 2.0" -f "docroot"
Expand Down

0 comments on commit e5eeaa3

Please sign in to comment.