Skip to content

Commit ce17522

Browse files
committed
Adding information about private repos to the README
1 parent 9eeed00 commit ce17522

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,16 @@ Currently Hound is only tested on MacOS and CentOS, but it should work on any *n
6666

6767
Right now Hound supports git and mercurial, and SVN support is being added.
6868

69+
## Private Repositories
70+
71+
There are a couple of ways to get Hound to index private repositories:
72+
73+
* Use the `file://` protocol. This allows you to index any local folder, so you can clone the repository locally
74+
and then reference the files directly. The downside here is that the polling to keep the repo up to date will
75+
not work.
76+
* Use SSH style URLs in the config: `"url" : "[email protected]:foo/bar.git"`. As long as you have your
77+
[SSH keys](https://help.github.com/articles/generating-ssh-keys/) set up on the box where Hound is running this will work. There is currently an [issue](https://github.com/etsy/Hound/issues/19) with URLs in this case that we hope to fix soon.
78+
6979
## Editor Integration
7080

7181
Currently the following editors have plugins that support Hound:

0 commit comments

Comments
 (0)