This repository contains a preliminary implementation of the client-side code for the Keybase Filesystem (KBFS) Keyword Search. See the wiki for a brief introduction and overview.
All code is written in the Go Language, and relies on KBFS.
This client allows keyword searching for files stored in KBFS. It relies on KBFS for syncing the master secrets and communicates remotely with the search server to update the indexes stored on the server and perform keyword searches.
The code is organized as follows:
genprotocol/
. Should not be edited by hand.Once the search server is up and running at SERVER_ADDRESS:SERVER_PORT
, to start the client and enable searches in specific KBFS_DIRECTORIES_TO_SEARCH
(separated by semicolons):
cd client/client
go run main.go --client_dirs=KBFS_DIRECTORIES_TO_SEARCH --ip_addr=SERVER_ADDRESS --port=SERVER_PORT
Use go run main.go --help
to see other configurable parameters.
Most code is released under the New BSD (3 Clause) License. If subdirectories include a different license, that license applies instead. (Specifically, most subdirectories in vendor are released under their own licenses.)