fork of https://github.com/sourcegraph/zoekt
1
2# Configuration parameters
3
4Parameters are in the `zoekt` section of the git-config.
5
6* `name`: name of the repository, typically HOST/PATH, eg. `github.com/hanwen/usb`.
7
8* `web-url`: base URL for linking to files, commits, and the repository, eg.
9`https://github.com/hanwen/usb`
10
11* `web-url-type`: type of URL, eg. github. Supported are cgit,
12 gitiles, gitweb, cgit and gitea.
13
14* `github-stars`, `github-forks`, `github-watchers`,
15 `github-subscribers`: counters for github interactions
16
17## Examples
18
19### gitea
20
21Clone a remote repository and add the indexer configuration.
22
23```sh
24git clone --bare https://codeberg.org/Codeberg/gitea
25cd gitea.git
26git config zoekt.web-url-type gitea
27git config zoekt.web-url https://codeberg.org/Codeberg/gitea
28git config zoekt.name codeberg.org/Codeberg/gitea
29```
30
31The tail of the git *config* should then contain:
32
33```ini
34[zoekt]
35 web-url-type = gitea
36 web-url = https://codeberg.org/Codeberg/gitea
37 name = codeberg.org/Codeberg/gitea
38```
39
40The *gitea.git* repository can then be indexed with `zoekt-git-index`
41
42```sh
43zoekt-git-index --branches main -index /data/index -repo_cache /data/repos gitea.git
44```