{"id":20038519,"url":"https://github.com/yahoo/bftkv","last_synced_at":"2025-05-05T06:32:16.824Z","repository":{"id":57507236,"uuid":"100419671","full_name":"yahoo/bftkv","owner":"yahoo","description":"A distributed key-value storage that's tolerant to Byzantine fault.","archived":false,"fork":false,"pushed_at":"2019-12-27T22:02:40.000Z","size":5948,"stargazers_count":30,"open_issues_count":0,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-08T18:51:31.330Z","etag":null,"topics":["big-data","javascript","key-value","research","visualization"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yahoo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-15T21:10:05.000Z","updated_at":"2023-11-23T03:52:41.000Z","dependencies_parsed_at":"2022-09-19T05:22:00.450Z","dependency_job_id":null,"html_url":"https://github.com/yahoo/bftkv","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/yahoo%2Fbftkv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fbftkv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fbftkv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fbftkv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yahoo","download_url":"https://codeload.github.com/yahoo/bftkv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252451791,"owners_count":21749985,"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":["big-data","javascript","key-value","research","visualization"],"created_at":"2024-11-13T10:29:46.356Z","updated_at":"2025-05-05T06:32:15.979Z","avatar_url":"https://github.com/yahoo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bftkv\n\nBFTKV is a distributed key-value storage which is tolerant to Byzantine fault. See [Abstract](docs/design.md) for details.\n\n[![GoDoc](https://godoc.org/github.com/yahoo/bftkv?status.svg)](https://godoc.org/github.com/yahoo/bftkv)\n\n### Additional documents:\n[Design Document (restricted)](https://docs.google.com/document/d/14xYeGR291UKba1pimO9DnFNvfZ3ceTYsfbWZbgpWkTQ/edit?usp=sharing)\n\n[Paper (draft)](docs/bftkv.pdf)\n\n[HTTP-API](docs/http_api.md)\n\n[Implementation Notes](docs/notes.md)\n\n[Test Notes](docs/tests.md)\n\n## Setup\n1. Install [Go 1.13](https://golang.org/doc/install).\n2. `go get -u github.com/yahoo/bftkv`\n3. Install [GnuPG 2.x](https://www.gnupg.org/download/index.en.html)\n4. Install [Docker](https://www.docker.com) (if you want to run BFTKV in a Docker container)\n5. Run `setup.sh` in scripts (`setup.sh -host bftkv` for Docker)\n6. If bftkv runs with KeyTransparency, run `$GOPATH/src/github.com/google/keytranspreancy/scripts/gen_bftkv_keys.sh`\n\n## Build\n```\n# change to the directory where the source code is checked out\ncd bftkv\ngo install -v github.com/yahoo/bftkv/cmd/bftkv\n```\n\n## Parameters\nA list of parameters that can be supplied to bftkv is given below:\n\n\u003cpre\u003e\n\u003cb\u003eFlag\u003c/b\u003e     \u003cb\u003ePurpose \u003c/b\u003e                              \u003cb\u003eDefault\u003c/b\u003e\n-home    Path to PGP home directory,           ~/.gnupg\n-sec     Secret key ring path,                 $home/secring.gpg\n-pub     Public key ring path,                 $home/pubring.gpg\n-rev     Revocation list path,                 $home/revocation.gpg\n-db      Database path,                        db\n-api     Http api address,                     localhost:5792\n-ws      Web socket port,                      5001\n\u003c/pre\u003e\n\n## Run Options\n1. Run a node `bftkv -home gnupg.key`\n\n2. Run a BFTKV cluster `cd scripts/run; ../run.sh`\n\n3. Run a BFTKV cluster in Docker\n\n```\ndocker build -t bftkv .\ndocker run -d bftkv\n```\n\n## Visualization\nBFTKV includes a visualization tool (located in `visual/`) for observing the current system state. The tool can display\n\n* Trust graphs for the servers\n* Read, write and sign requests sent to the servers\n* Revoked and inaccessible servers\n\nTo show the graph, run `run.sh` and `open visual/index.html`.\n\n### Write in Action\n\u003cimg src=\"docs/images/write.gif\" alt=\"Write\"/\u003e\n\n### Revoke on Read in Action\n\u003cimg src=\"docs/images/revokeOnRead.gif\" alt=\"Revoke on Read\"/\u003e\n\n## License\nCopyright 2017, Yahoo Holdings Inc.\n\nLicensed under the terms of the Apache license. See LICENSE file in project root for terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoo%2Fbftkv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyahoo%2Fbftkv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoo%2Fbftkv/lists"}