{"id":19023878,"url":"https://github.com/keybase/search","last_synced_at":"2025-04-17T10:32:47.251Z","repository":{"id":56151913,"uuid":"63091492","full_name":"keybase/search","owner":"keybase","description":"Encrypted search of Keybase data (WIP)","archived":true,"fork":false,"pushed_at":"2017-08-10T18:41:57.000Z","size":5364,"stargazers_count":10,"open_issues_count":2,"forks_count":5,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-04-02T19:38:01.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keybase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-11T18:18:17.000Z","updated_at":"2025-01-22T21:39:07.000Z","dependencies_parsed_at":"2022-08-15T13:40:38.517Z","dependency_job_id":null,"html_url":"https://github.com/keybase/search","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keybase%2Fsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keybase%2Fsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keybase%2Fsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keybase%2Fsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keybase","download_url":"https://codeload.github.com/keybase/search/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249333597,"owners_count":21252846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T20:33:41.862Z","updated_at":"2025-04-17T10:32:45.255Z","avatar_url":"https://github.com/keybase.png","language":"Go","readme":"# Keybase Filesystem (KBFS) Keyword Search\n\nThis repository contains a preliminary implementation of the client-side code\nfor the Keybase Filesystem (KBFS) Keyword Search.  See the\n[wiki](https://github.com/keybase/search/wiki) for a brief\nintroduction and overview.\n\nAll code is written in the [Go Language](https://golang.org), and relies\non [KBFS](https://github.com/keybase/kbfs/tree/master/go).\n\n### Architecture\n\nThis client allows keyword searching for files stored in KBFS.  It relies on\nKBFS for syncing the master secrets and communicates remotely with the search\nserver to update the indexes stored on the server and perform keyword searches.\n\nThe code is organized as follows:\n\n* [client](client/): The client-side code for the search scheme.\n* [genprotocol](genprotocol/): Contains the AVDL files defining client-server RPC communication. If you need to make protocol changes, edit the files in this directory.\n* [libsearch](libsearch/): Our implementation of the [secure index](http://eprint.iacr.org/2003/216.pdf) and other helper functions.\n* [protocol](protocol/): Contains auto-generated code derived from the protocol definitions in `genprotocol/`.  Should not be edited by hand.\n* [prototype](prototype/): An early-stage prototype the implements the search scheme locally.\n* [vendor](vendor/): Vendored versions of the open-source libraries used by KBFS search.\n\n### Running the Client\nOnce 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):\n```\ncd client/client\ngo run main.go --client_dirs=KBFS_DIRECTORIES_TO_SEARCH --ip_addr=SERVER_ADDRESS --port=SERVER_PORT\n```\nUse `go run main.go --help` to see other configurable parameters.\n\n### Licensing\nMost 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](vendor/) are released under their own licenses.)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeybase%2Fsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeybase%2Fsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeybase%2Fsearch/lists"}