# lua-resty-etcd

**Repository Path**: iresty/lua-resty-etcd

## Basic Information

- **Project Name**: lua-resty-etcd
- **Description**: resty-etcd 是一个 OpenResty 非堵塞的 etcd 驱动，支持 etcd API v2.
- **Primary Language**: Lua
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 33
- **Forks**: 3
- **Created**: 2019-06-06
- **Last Updated**: 2025-06-20

## Categories & Tags

**Categories**: openresty-extensions

**Tags**: None

## README

Name
====

[lua-resty-etcd](https://github.com/iresty/lua-resty-etcd) Nonblocking Lua etcd driver library for OpenResty, this module supports etcd API v3.

[![Build Status](https://github.com/api7/lua-resty-etcd/actions/workflows/ci.yml/badge.svg)](https://github.com/api7/lua-resty-etcd/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/iresty/lua-resty-etcd/blob/master/LICENSE)

Table of Contents
=================
* [Install](#install)
* [API v3](api_v3.md)
  * **NOTE**: Requires ETCD version >= v3.4.0

## Install

> Dependencies

- api7-lua-resty-http: https://github.com/api7/lua-resty-http
- lua-typeof: https://github.com/iresty/lua-typeof

> install by luarocks

```shell
luarocks install lua-resty-etcd
```

> install by source

```shell
$ git clone https://github.com/iresty/lua-resty-etcd.git
$ cd lua-resty-etcd
$ make dev
$ sudo make install
```