Skip to content

Commit

Permalink
chore: add manual install option (#446)
Browse files Browse the repository at this point in the history
* chore: add another option to install hound

* chore: format

* chore: add $GOPATH/bin in installation

* fix indentation for bulleted list

---------

Co-authored-by: dschott <dschott@etsy.com>
  • Loading branch information
appletreeisyellow and dschott authored Feb 10, 2023
1 parent ed9b1f1 commit 86e1f79
Showing 1 changed file with 30 additions and 19 deletions.
49 changes: 30 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,44 @@ print out the installed version of go.

1. Use the Go tools to install Hound. The binaries `houndd` (server) and `hound` (cli) will be installed in your $GOPATH/bin directory. Your $GOPATH should be in your $PATH (`echo $PATH` to check).

```
go get github.com/hound-search/hound/cmds/...
```

```
go get github.com/hound-search/hound/cmds/...
```
If the above doesn't work for you, try to install hound manually with the following:

```
git clone https://github.com/hound-search/hound.git
cd hound
go build ./cmds/hound
go build ./cmds/houndd
sudo mv hound houndd ~/go/bin/
```

You might have to change the path of the last command if you installed Go somewhere else on your system.

2. Create a config.json file and use it to list your repositories. Check out our [example-config.json](config-example.json)
2. Create a config.json file in your `$GOPATH/bin` and use it to list your repositories. Check out our [example-config.json](config-example.json)
to see how to set up various types of repositories. For example, we can configure Hound to search its own source code using
the config found in [default-config.json](default-config.json):

```json
{
"dbpath" : "db",
"repos" : {
"Hound" : { "url" : "https://github.com/etsy/hound.git" }
```json
{
"dbpath" : "db",
"repos" : {
"Hound" : { "url" : "https://github.com/etsy/hound.git" }
}
}
}
```
```

A complete list of available config options can be found [here](docs/config-options.md).

A complete list of available config options can be found [here](docs/config-options.md).
3. Run the Hound server with `houndd` in the same directory as your `config.json`. You should see output similar to:
```
2015/03/13 09:07:42 Searcher started for statsd
2015/03/13 09:07:42 Searcher started for Hound
2015/03/13 09:07:42 All indexes built!
2015/03/13 09:07:42 running server at http://localhost:6080
```
3. Run the Hound server with `houndd` in the same directory as your `config.json`, which is most likely your `$GOPATH/bin` directory. You should see output similar to:
```
2015/03/13 09:07:42 Searcher started for statsd
2015/03/13 09:07:42 Searcher started for Hound
2015/03/13 09:07:42 All indexes built!
2015/03/13 09:07:42 running server at http://localhost:6080
```

4. By default, hound hosts a web ui at http://localhost:6080 . Open it in your browser, and start searching.

Expand Down

0 comments on commit 86e1f79

Please sign in to comment.