Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new folder docs with config-options description on options. #370

Merged
merged 5 commits into from
Jan 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ go get github.com/hound-search/hound/cmds/...
2. Create a config.json file 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",
Expand All @@ -38,6 +39,8 @@ the config found in [default-config.json](default-config.json):
}
```


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
Expand Down
48 changes: 48 additions & 0 deletions docs/config-options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
- [ConfigOptions](#configoptions)
* [Git options](#git-options)
* [SVN options](#svn-options)
* [URL options](#url-options)



# Config Options
Most of Hound's behavior is defined by a single `config.json` configuration file. A list of its available options are provided below, along with their defaults.
keys used in the config json file are the options,description provides details about keys.Default values gives idea about value which can be used for the option.


ConfigOption | Description | Default Values
:------ | :----- | :-----
max-concurrent-indexers | defines the total number of indexers required to be used for indexing code | 2
health-check-uri | health check url for hound | `/healthz`
dbpath | absolute file path where the `config.json` file exists| `data`
title | Title used for the application | Hound
url-pattern | composed of base url and anchor values in form of key value pairs | n/a
vcs-config | holds the version control config, default VCS used in Hound is git.Other options for VCS are svn,mercurial,bitbucket,hg, etc.Refer to `config-example.json` to get the list of vcs and usage. Below tables provide detailed options list of each type of vcs | git
repos | holds the list of repos which are required to be indexed by Hound . Each Repo is added with reponame as a Json Key with options associated with repo as values similar to example provided in `config-example.json` | n/a

## Git Options
List of options associated with git vcs in repos

GitOptions | Description | Default Values
:------ | :----- | :-----
ms-between-polls | time interval to poll the repo url | 30s
detect-ref | used to determine branch | master branch
ref | used to provide reference for the branch for repo| n/a

## SVN Options

List of options available for SVN vcs in repos

SvnOptions | Descriptions| Default Values
:------ | :-----| :-----
username | user name for the svn repo | n/a
password | password to authenticate use for svn repo | n/a


## URL Options
Options for url used for repo link under repos

URLOptions | Description | Default Values
:------ | :--- | :-----
url-pattern | when provided used by Hound for config|`{url}/blob/{rev}/{path}{anchor}`
anchor | when provided used for vcs config| `#L{line}`