{"id":13411912,"url":"https://github.com/codenotary/immudb","last_synced_at":"2025-05-12T22:24:30.593Z","repository":{"id":37839731,"uuid":"220186120","full_name":"codenotary/immudb","owner":"codenotary","description":"immudb - immutable database based on zero trust, SQL/Key-Value/Document model, tamperproof, data change history","archived":false,"fork":false,"pushed_at":"2025-03-31T08:32:51.000Z","size":39438,"stargazers_count":8728,"open_issues_count":132,"forks_count":348,"subscribers_count":76,"default_branch":"master","last_synced_at":"2025-05-05T17:20:50.524Z","etag":null,"topics":["auditable","compliance","cryptographic","database","gdpr","go","immutable","immutable-database","key-value","merkle-tree","pci-dss","performance","sql","tamper-evident","tamperproof","timetravel","verification","verify","zero-trust"],"latest_commit_sha":null,"homepage":"https://immudb.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codenotary.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-07T08:22:16.000Z","updated_at":"2025-05-04T21:10:13.000Z","dependencies_parsed_at":"2023-10-23T06:30:56.604Z","dependency_job_id":"ec35d9d4-a254-4595-a725-20def46f7a8a","html_url":"https://github.com/codenotary/immudb","commit_stats":{"total_commits":4753,"total_committers":74,"mean_commits":64.22972972972973,"dds":0.5137807700399748,"last_synced_commit":"cdd00cbb9a09d1981bf0d1a54b42eb20f5d1f573"},"previous_names":["vchain-us/immu","codenotary/immustore"],"tags_count":53,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenotary%2Fimmudb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenotary%2Fimmudb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenotary%2Fimmudb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenotary%2Fimmudb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codenotary","download_url":"https://codeload.github.com/codenotary/immudb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253831910,"owners_count":21971181,"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":["auditable","compliance","cryptographic","database","gdpr","go","immutable","immutable-database","key-value","merkle-tree","pci-dss","performance","sql","tamper-evident","tamperproof","timetravel","verification","verify","zero-trust"],"created_at":"2024-07-30T20:01:18.369Z","updated_at":"2025-05-12T22:24:30.568Z","avatar_url":"https://github.com/codenotary.png","language":"Go","readme":"\u003c!--\n---\n\ntitle: \"immudb\"\n\ncustom_edit_url: https://github.com/codenotary/immudb/edit/master/README.md\n---\n\n--\u003e\n\n# immudb \u003cimg align=\"right\" src=\"img/Black%20logo%20-%20no%20background.png\" height=\"47px\" /\u003e\n\n\n[![Documentation](https://img.shields.io/website?label=Docs\u0026url=https%3A%2F%2Fdocs.immudb.io%2F)](https://docs.immudb.io/)\n[![Build Status](https://github.com/codenotary/immudb/actions/workflows/push.yml/badge.svg)](https://github.com/codenotary/immudb/actions/workflows/push.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/codenotary/immudb)](https://goreportcard.com/report/github.com/codenotary/immudb)\n[![View SBOM](https://img.shields.io/badge/sbom.sh-viewSBOM-blue?link=https%3A%2F%2Fsbom.sh%2F37cbffcf-1bd3-4daf-86b7-77deb71575b7)](https://sbom.sh/37cbffcf-1bd3-4daf-86b7-77deb71575b7)\n[![Homebrew](https://img.shields.io/homebrew/v/immudb)](https://formulae.brew.sh/formula/immudb)\n\n[![Discord](https://img.shields.io/discord/831257098368319569)](https://discord.gg/EWeCbkjZVu)\n[![Immudb Careers](https://img.shields.io/badge/careers-We%20are%20hiring!-blue?style=flat)](https://www.codenotary.com/job)\n[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/codenotary)](https://artifacthub.io/packages/search?repo=codenotary)\n\nDon't forget to ⭐ this repo if you like immudb!\n\n[:tada: 27M pulls from docker hub!](https://hub.docker.com/r/codenotary)\n\n---\n\nDetailed documentation can be found at https://docs.immudb.io/\n\n---\n\n\u003cimg align=\"right\" src=\"img/immudb-mascot-small.png\" width=\"256px\"/\u003e\n\nimmudb is a database with built-in cryptographic proof and verification. It tracks changes in sensitive data and the integrity of the history will be protected by the clients, without the need to trust the database. It can operate as a key-value store, as a document model database, and/or as relational database (SQL).\n\nTraditional database transactions and logs are mutable, and therefore there is no way to know for sure if your data has been compromised. immudb is immutable. You can add new versions of existing records, but never change or delete records. This lets you store critical data without fear of it being tampered.\n\nData stored in immudb is cryptographically coherent and verifiable. Unlike blockchains, immudb can handle millions of transactions per second, and can be used both as a lightweight service or embedded in your application as a library. immudb runs everywhere, on an IoT device, your notebook, a server, on-premise or in the cloud.\n\n\nWhen used as a relational data database, it supports both transactions and blobs, so there are no limits to the use cases. Developers and organizations use immudb to secure and tamper-evident log data, sensor data, sensitive data, transactions, software build recipes, rule-base data, artifacts and even video streams. [Examples of organizations using immudb today.](https://www.immudb.io)\n\n## Contents\n\n- [immudb](#immudb)\n  - [Contents](#contents)\n  - [Quickstart](#quickstart)\n    - [Getting immudb running: executable](#getting-immudb-running-executable)\n    - [Getting immudb running: docker](#getting-immudb-running-docker)\n    - [Getting immudb running: kubernetes](#getting-immudb-running-kubernetes)\n    - [Using subfolders](#using-subfolders)\n    - [Enabling Amazon S3 storage](#enabling-amazon-s3-storage)\n    - [Connecting with immuclient](#connecting-with-immuclient)\n    - [Using immudb](#using-immudb)\n      - [Real world examples](#real-world-examples)\n      - [How to integrate immudb in your application](#how-to-integrate-immudb-in-your-application)\n      - [Online demo environment](#online-demo-environment)\n  - [Tech specs](#tech-specs)\n  - [Performance figures](#performance-figures)\n  - [Roadmap](#roadmap)\n  - [Projects using immudb](#projects-using-immudb)\n  - [Contributing](#contributing)\n\n## Quickstart\n\n\n### Getting immudb running: executable\n\nYou may download the immudb binary from [the latest releases on Github](https://github.com/codenotary/immudb/releases/latest). Once you have downloaded immudb, rename it to `immudb`, make sure to mark it as executable, then run it. The following example shows how to obtain v1.9.5 for linux amd64:\n\n```bash\nwget https://github.com/codenotary/immudb/releases/download/v1.9.5/immudb-v1.9.5-linux-amd64\nmv immudb-v1.9.5-linux-amd64 immudb\nchmod +x immudb\n\n# run immudb in the foreground to see all output\n./immudb\n\n# or run immudb in the background\n./immudb -d\n```\n\n### Getting immudb running: Docker\n\nUse Docker to run immudb in a ready-to-use container:\n\n```bash\ndocker run -d --net host -it --rm --name immudb codenotary/immudb:latest\n```\n\nIf you are running the Docker image without host networking, make sure to expose ports 3322 and 9497.\n\n### Getting immudb running: Kubernetes\n\nIn kubernetes, use helm for an easy deployment: just add our repository and install immudb with these simple commands:\n\n```bash\nhelm repo add immudb https://packages.codenotary.org/helm\nhelm repo update\nhelm install immudb/immudb --generate-name\n```\n\n### Using subfolders\n\nImmudb helm chart creates a persistent volume for storing immudb database.\nThose database are now by default placed in a subdirectory.\n\nThat's for compatibility with ext4 volumes that have a `/lost+found` directory that can confuse immudb. Some volume providers,\nlike EBS or DigitalOcean, are using this kind of volumes. If we placed database directory on the root of the volume,\nthat `/lost+found` would be treated as a database. So we now create a subpath (usually `immudb`) subpath for storing that.\n\nThis is different from what we did on older (\u003c=1.3.1) helm charts, so if you have already some volumes with data you can set\nvalue volumeSubPath to false (i.e.: `--set volumeSubPath.enabled=false`) when upgrading so that the old way is used.\n\nYou can alternatively migrate the data in a `/immudb` directory. You can use this pod as a reference for the job:\n\n```yaml\napiVersion: v1\nkind: Pod\nmetadata:\n  name: migrator\nspec:\n  volumes:\n    - name: \"vol0\"\n      persistentVolumeClaim:\n        claimName: \u003cyour-claim-name-here\u003e\n  containers:\n    - name: migrator\n      image: busybox\n      volumeMounts:\n        - mountPath: \"/data\"\n          name: \"vol0\"\n      command:\n        - sh\n        - -c\n        - |\n          mkdir -p /data/immudb\n          ls /data | grep -v -E 'immudb|lost\\+found'|while read i; do mv /data/$i /data/immudb/$i; done\n```\n\nAs said before, you can totally disable the use of subPath by setting `volumeSubPath.enabled=false`.\nYou can also tune the subfolder path using `volumeSubPath.path` value, if you prefer your data on a\ndifferent directory than the default `immudb`.\n\n### Enabling Amazon S3 storage\n\nimmudb can store its data in the Amazon S3 service (or a compatible alternative).\nThe following example shows how to run immudb with the S3 storage enabled:\n\n```bash\nexport IMMUDB_S3_STORAGE=true\nexport IMMUDB_S3_ACCESS_KEY_ID=\u003cS3 ACCESS KEY ID\u003e\nexport IMMUDB_S3_SECRET_KEY=\u003cSECRET KEY\u003e\nexport IMMUDB_S3_BUCKET_NAME=\u003cBUCKET NAME\u003e\nexport IMMUDB_S3_LOCATION=\u003cAWS S3 REGION\u003e\nexport IMMUDB_S3_PATH_PREFIX=testing-001\nexport IMMUDB_S3_ENDPOINT=\"https://${IMMUDB_S3_BUCKET_NAME}.s3.${IMMUDB_S3_LOCATION}.amazonaws.com\"\n\n./immudb\n```\n\nWhen working with the external storage, you can enable the option for the remote storage\nto be the primary source of identifier. This way, if immudb is run using ephemeral disks,\nsuch as with AWS ECS Fargate, the identifier can be taken from S3. To enable that, use:\n\n```bash\nexport IMMUDB_S3_EXTERNAL_IDENTIFIER=true\n```\n\nYou can also use the role-based credentials for more flexible and secure configuration.\nThis allows the service to be used with instance role configuration without a user entity.\nThe following example shows how to run immudb with the S3 storage enabled using AWS Roles:\n\n```bash\nexport IMMUDB_S3_STORAGE=true\nexport IMMUDB_S3_ROLE_ENABLED=true\nexport IMMUDB_S3_BUCKET_NAME=\u003cBUCKET NAME\u003e\nexport IMMUDB_S3_LOCATION=\u003cAWS S3 REGION\u003e\nexport IMMUDB_S3_PATH_PREFIX=testing-001\nexport IMMUDB_S3_ENDPOINT=\"https://${IMMUDB_S3_BUCKET_NAME}.s3.${IMMUDB_S3_LOCATION}.amazonaws.com\"\n\n./immudb\n```\n\nOptionally, you can specify the exact role immudb should be using with:\n\n```bash\nexport IMMUDB_S3_ROLE=\u003cAWS S3 ACCESS ROLE NAME\u003e\n```\n\nRemember, the `IMMUDB_S3_ROLE_ENABLED` parameter still should be on.\n\nYou can also easily use immudb with compatible s3 alternatives\nsuch as the [minio](https://github.com/minio/minio) server:\n\n```bash\nexport IMMUDB_S3_ACCESS_KEY_ID=minioadmin\nexport IMMUDB_S3_SECRET_KEY=minioadmin\nexport IMMUDB_S3_STORAGE=true\nexport IMMUDB_S3_BUCKET_NAME=immudb-bucket\nexport IMMUDB_S3_PATH_PREFIX=testing-001\nexport IMMUDB_S3_ENDPOINT=\"http://localhost:9000\"\n\n# Note: This spawns a temporary minio server without data persistence\ndocker run -d -p 9000:9000 minio/minio server /data\n\n# Create the bucket - this can also be done through web console at http://localhost:9000\ndocker run --net=host -it --entrypoint /bin/sh minio/mc -c \"\n  mc alias set local http://localhost:9000 minioadmin minioadmin \u0026\u0026\n  mc mb local/${IMMUDB_S3_BUCKET_NAME}\n\"\n\n# Run immudb instance\n./immudb\n```\n\n### Connecting with immuclient\n\nYou may download the immuclient binary from [the latest releases on Github](https://github.com/codenotary/immudb/releases/latest). Once you have downloaded immuclient, rename it to `immuclient`, make sure to mark it as executable, then run it. The following example shows how to obtain v1.5.0 for linux amd64:\n\n```bash\nwget https://github.com/codenotary/immudb/releases/download/v1.5.0/immuclient-v1.5.0-linux-amd64\nmv immuclient-v1.5.0-linux-amd64 immuclient\nchmod +x immuclient\n\n# start the interactive shell\n./immuclient\n\n# or use commands directly\n./immuclient help\n```\n\nOr just use Docker to run immuclient in a ready-to-use container. Nice and simple.\n\n```bash\ndocker run -it --rm --net host --name immuclient codenotary/immuclient:latest\n```\n\n## Using immudb\n\nLot of useful documentation and step by step guides can be found at https://docs.immudb.io/\n\n### Real world examples\n\nWe already learned about the following use cases from users:\n\n- use immudb to immutably store every update to sensitive database fields (credit card or bank account data) of an existing application database\n- store CI/CD recipes in immudb to protect build and deployment pipelines\n- store public certificates in immudb\n- use immudb as an additional hash storage for digital objects checksums\n- store log streams (i. e. audit logs) tamperproof\n- store the last known positions of submarines\n- record the location where fish was found aboard fishing trawlers\n\n### How to integrate immudb in your application\n\nWe have SDKs available for the following programming languages:\n\n1. Java [immudb4j](https://github.com/codenotary/immudb4j)\n2. Golang ([golang sdk](https://pkg.go.dev/github.com/codenotary/immudb/pkg/client), [Gorm adapter](https://github.com/codenotary/immugorm))\n3. .net [immudb4net](https://github.com/codenotary/immudb4net)\n4. Python [immudb-py](https://github.com/codenotary/immudb-py)\n5. Node.js [immudb-node](https://github.com/codenotary/immudb-node)\n\nTo get started with development, there is a [quickstart in our documentation](https://docs.immudb.io/master/immudb.html): or pick a basic running sample from [immudb-client-examples](https://github.com/codenotary/immudb-client-examples).\n\nOur [immudb Playground](https://play.codenotary.com) provides a guided environment to learn the Python SDK.\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://play.codenotary.com\"\u003e\n    \u003cimg alt=\"immudb playground to start using immudb in an online demo environment\" src=\"img/playground2.png\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\nWe've developed a \"language-agnostic SDK\" which exposes a REST API for easy consumption by any application.\n[immugw](https://github.com/codenotary/immugw) may be a convenient tool when SDKs are not available for the\nprogramming language you're using, for experimentation, or just because you prefer your app only uses REST endpoints.\n\n### Online demo environment\n\nClick here to try out the immudb web console access in an [online demo environment](https://demo.immudb.io) (username: immudb; password: immudb)\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://demo.immudb.io\"\u003e\n    \u003cimg alt=\"Your own temporary immudb web console access to start using immudb in an online demo environment\" src=\"img/demoimmudb.png\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## Tech specs\n\n| Topic                   | Description                                         |\n| ----------------------- | --------------------------------------------------- |\n| DB Model                | Key-Value with 3D access, Document Model, SQL       |\n| Data scheme             | schema-free                                         |\n| Implementation design   | Cryptographic commit log with parallel Merkle Tree, |\n|                         | (sync/async) indexing with extended B-tree          |\n| Implementation language | Go                                                  |\n| Server OS(s)            | BSD, Linux, OS X, Solaris, Windows, IBM z/OS        |\n| Embeddable              | Yes, optionally                                     |\n| Server APIs             | gRPC                                                |\n| Partition methods       | Sharding                                            |\n| Consistency concepts    | Immediate Consistency                               |\n| Transaction concepts    | ACID with Snapshot Isolation (SSI)                  |\n| Durability              | Yes                                                 |\n| Snapshots               | Yes                                                 |\n| High Read throughput    | Yes                                                 |\n| High Write throughput   | Yes                                                 |\n| Optimized for SSD       | Yes                                                 |\n\n## Performance figures\n\nimmudb can handle millions of writes per second. The following table shows performance of the embedded store inserting 1M entries on a machine with 4-core E3-1275v6 CPU and SSD disk:\n\n| Entries | Workers | Batch | Batches | time (s) | Entries/s |\n| ------- | ------- | ----- | ------- | -------- | --------- |\n| 1M      | 20      | 1000  | 50      | 1.061    | 1.2M /s   |\n| 1M      | 50      | 1000  | 20      | 0.543    | 1.8M /s   |\n| 1M      | 100     | 1000  | 10      | 0.615    | 1.6M /s   |\n\nYou can generate your own benchmarks using the `stress_tool` under `embedded/tools`.\n\n## Roadmap\n\nThe following topics are important to us and are planned or already being worked on:\n\n* Data pruning\n* Compression\n* compatibility with other database storage files\n* Easier API for developers\n* API compatibility with other, well-known embedded databases\n\n## Projects using immudb\n\nBelow is a list of known projects that use immudb:\n\n- [alma-sbom](https://github.com/AlmaLinux/alma-sbom) - AlmaLinux OS SBOM data management utility.\n\n- [immudb-log-audit](https://github.com/codenotary/immudb-log-audit) - A service and cli tool to store json formatted log input\n  and audit it later in immudb Vault.\n\n- [immudb-operator](https://github.com/unagex/immudb-operator) - Unagex Kubernetes Operator for immudb.\n\n- [immufluent](https://github.com/codenotary/immufluent) - Send fluentbit collected logs to immudb.\n\n- [immuvoting](https://github.com/padurean/immuvoting) - Publicly cryptographically verifiable electronic voting system powered by immudb.\n\nAre you using immudb in your project? Open a pull request to add it to the list.\n\n## Contributing\n\nWe welcome [contributors](CONTRIBUTING.md). Feel free to join the team!\n\n\u003ca href=\"https://github.com/codenotary/immudb/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=codenotary/immudb\" /\u003e\n\u003c/a\u003e\n\nLearn how to [build](BUILD.md) immudb components in both binary and Docker image form.\n\nTo report bugs or get help, use [GitHub's issues](https://github.com/codenotary/immudb/issues).\n\nimmudb is licensed under the [Business Source License 1.1](LICENSE).\n\nimmudb re-distributes other open-source tools and libraries - [Acknowledgements](ACKNOWLEDGEMENTS.md).\n","funding_links":[],"categories":["Go","Database","Databases","By Industry","数据库","Uncategorized","语言资源库","其他__大数据","sql","go","By Language","隐私新技术","Repositories","Data Integration Frameworks","数据库  `go语言实现的数据库`","\u003ca name=\"Go\"\u003e\u003c/a\u003eGo","Generators"],"sub_categories":["Databases Implemented in Go","Advanced Console UIs","Other","Go中实现的数据库","Uncategorized","go","网络服务_其他","Go","隐私相关领域法规/条例","标准 CLI"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenotary%2Fimmudb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodenotary%2Fimmudb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenotary%2Fimmudb/lists"}