Google Git
Sign in
gerrit / zoekt / ebb246887d7c0f9c9088440a1762f0337cde1484
commitebb246887d7c0f9c9088440a1762f0337cde1484[log] [tgz]
authorKeegan Carruthers-Smith <keegan.csmith@gmail.com>Fri Mar 20 17:15:03 2020 +0200
committerKeegan Carruthers-Smith <keegan.csmith@gmail.com>Fri Mar 20 17:17:51 2020 +0200
tree09b2b9b90b692f84b455bc3a612fd0ee502350a7
parente55b1e7b0d97fce3066a9d553e5a3b8567f47770 [diff]
gitindex: set git username and email in tests

If running in a clean environment (eg CI), the git may not have been configured
with a username or email yet. This leads to commits failing. We can set the
username and email just for the repository we want to commit in.

Change-Id: Id85fb9799bc99231779eb0622aecdb4dab58b8c6
1 file changed
tree: 09b2b9b90b692f84b455bc3a612fd0ee502350a7
  1. build/
  2. cmd/
  3. ctags/
  4. doc/
  5. gitindex/
  6. query/
  7. shards/
  8. web/
  9. .gitignore
  10. all.bash
  11. api.go
  12. bits.go
  13. bits_test.go
  14. build-deploy.sh
  15. contentprovider.go
  16. CONTRIBUTING
  17. eval.go
  18. go.mod
  19. go.sum
  20. hititer.go
  21. hititer_test.go
  22. index_test.go
  23. indexbuilder.go
  24. indexdata.go
  25. indexfile_other.go
  26. indexfile_unix.go
  27. LICENSE
  28. matchiter.go
  29. matchtree.go
  30. matchtree_test.go
  31. read.go
  32. read_test.go
  33. README.md
  34. section.go
  35. section_test.go
  36. toc.go
  37. write.go
README.md
"Zoekt, en gij zult spinazie eten" - Jan Eertink

("seek, and ye shall eat spinach" - My primary school teacher)

This is a fast text search engine, intended for use with source code. (Pronunciation: roughly as you would pronounce “zooked” in English)

INSTRUCTIONS

Downloading:

go get github.com/google/zoekt/

Indexing:

go install github.com/google/zoekt/cmd/zoekt-index
$GOPATH/bin/zoekt-index .

Searching

go install github.com/google/zoekt/cmd/zoekt
$GOPATH/bin/zoekt 'ngram f:READ'

Indexing git repositories:

go install github.com/google/zoekt/cmd/zoekt-git-index
$GOPATH/bin/zoekt-git-index -branches master,stable-1.4 -prefix origin/ .

Indexing repo repositories:

go install github.com/google/zoekt/cmd/zoekt-{repo-index,mirror-gitiles}
zoekt-mirror-gitiles -dest ~/repos/ https://gfiber.googlesource.com
zoekt-repo-index \
   -name gfiber \
   -base_url https://gfiber.googlesource.com/ \
   -manifest_repo ~/repos/gfiber.googlesource.com/manifests.git \
   -repo_cache ~/repos \
   -manifest_rev_prefix=refs/heads/ --rev_prefix= \
   master:default_unrestricted.xml

Starting the web interface

go install github.com/google/zoekt/cmd/zoekt-webserver
$GOPATH/bin/zoekt-webserver -listen :6070

A more organized installation on a Linux server should use a systemd unit file, eg.

[Unit]
Description=zoekt webserver

[Service]
ExecStart=/zoekt/bin/zoekt-webserver -index /zoekt/index -listen :443  --ssl_cert /zoekt/etc/cert.pem   --ssl_key /zoekt/etc/key.pem
Restart=always

[Install]
WantedBy=default.target

SEARCH SERVICE

Zoekt comes with a small service management program:

go install github.com/google/zoekt/cmd/zoekt-indexserver

cat << EOF > config.json
[{"GithubUser": "username"},
 {"GithubOrg": "org"},
 {"GitilesURL": "https://gerrit.googlesource.com", "Name": "zoekt" }
]
EOF

$GOPATH/bin/zoekt-server -mirror_config config.json

This will mirror all repos under ‘github.com/username’, ‘github.com/org’, as well as the ‘zoekt’ repository. It will index the repositories.

It takes care of fetching and indexing new data and cleaning up logfiles.

The webserver can be started from a standard service management framework, such as systemd.

SYMBOL SEARCH

It is recommended to install Universal ctags to improve ranking. See here for more information.

ACKNOWLEDGEMENTS

Thanks to Alexander Neubeck for coming up with this idea, and helping me flesh it out.

DISCLAIMER

This is not an official Google product