kividbio/kividb

选用指南

AI 根据 README 整理 · 2026/10/20 19:46:34

使用方式

通过命令行启动服务，使用 Redis 客户端连接，默认端口 6380。

查看 README 依据

To build the Docker image yourself, `docker build -t kividb .` builds the default variant; `docker build --build-arg KIVIDB_FEATURES=lua,tls -t kividb:full .` builds another one. ## Running KiviDB ```bash ./target/release/kividb # listens on 0.0.0.0:6380 redis-cli -p 6380 PING ``` Any Redis client works; point it at port **6380**. ### Protected mode Protected mode is **on by default**, as in Redis. While it is on, **no bind address has been set** (`--bind` or `bind` in the config file) and the **`default` user has no password**, only

部署要求

从源码构建需要 Rust 1.89 或更高版本；也可使用 Docker 镜像或预编译二进制。

查看 README 依据

toolchain it is checked against is **Rust 1.89**, the version the [`Dockerfile`](Dockerfile) builds with. ```bash git clone https://github.com/kividbio/kividb.git cd kividb cargo build --release # default variant cargo build --release --features lua # with Lua scripting cargo build --release --features tls # with TLS cargo build --release --features lua,tls # full ./target/release/kividb ``` On Linux the server uses io_uring when the kernel allows it and falls back to Tokio otherwise (`--io-model auto`, the default).

the internet without a password. ### Docker Images are published to Docker Hub and the GitHub Container Registry, with the same tags in both: ```bash docker pull kividb/kividb:latest # or docker pull ghcr.io/kividbio/kividb:latest ``` `latest` and version tags such as `v1.1.0` are the default variant; `v1.1.0-lua`, `v1.1.0-tls` and `v1.1.0-full` are the others. Images are built for `amd64` and `arm64`. ```bash docker run -p 6380:6380 kividb/kividb ``` A container is reached through its network, never from loopback, so the image's default

**io_uring in containers:** Docker's default seccomp profile blocks io_uring on recent versions, and KiviDB then falls back to Tokio. To allow it on a Linux host, run with `--security-opt seccomp=unconfined` (understand what that permits before using it in production). ### Release binaries Release binaries for Linux (x86_64, aarch64) and macOS (Apple silicon, Intel) are published on [GitHub Releases](https://github.com/kividbio/kividb/releases). The `latest/download` links below always resolve to the newest release; replace `latest/download` with `download/v1.1.0` to pin a version. ```bash

已知限制

Lua 脚本和 TLS 为可选功能，需在构建时启用；默认启用保护模式，仅允许本机连接。

查看 README 依据

- **Lua scripting**: optional Cargo feature. `EVAL`, `SCRIPT`, `FUNCTION`, `FCALL` and related commands are available in builds with `--features lua` (see [Scripting commands (Lua)](COMMANDS.md#scripting-commands-lua)) - **TLS**: optional Cargo feature (`--features tls`) - **Default listen address**: `0.0.0.0:6380`, with [protected mode](#protected-mode) on - **License**: [GNU Affero General Public License v3](LICENSE) (AGPL-3.0-only), open source; using KiviDB does not put your application under the AGPL; see [License](#license)

| `lua` | `lua` | Lua scripting (`EVAL`, `EVALSHA`, `SCRIPT`, `FUNCTION`, `FCALL`, …) | | `tls` | `tls` | TLS listener, and TLS between cluster nodes and replicas | | `full` | `lua,tls` | both | In a build without Lua, the scripting commands return an error. A build without TLS refuses to start if `--tls-port` is given, rather than serving plaintext. ## Building from source Requires a **stable Rust** toolchain ([`rust-toolchain.toml`](rust-toolchain.toml) selects `stable` with `rustfmt` and `clippy`). The crate uses the **2024 edition**; the oldest

clients on the same machine (loopback) may connect. Any other client receives a `-DENIED` error that explains the options, and is disconnected. To accept clients from other machines, do one of these: - set a password: `--requirepass <password>`, or `ACL SETUSER default ><password>`; - set a bind address: `--bind <address>`; - turn protected mode off: `--protected-mode no`, `protected-mode no` in the config file, or `CONFIG SET protected-mode no` from a local client. If you turn it off or bind to a public address, make sure the server cannot be reached from