docs: add README.md

This commit is contained in:
Liam Chan 2024-09-04 10:05:07 +08:00
parent 8871ebeb41
commit 6539495e4d

View File

@ -1,15 +1,18 @@
# ONVIF Agent: Simplified Management of ONVIF IP Devices
# Zabbix Agent 2 Plugin Template
ONVIF agent is a robust implementation of the ONVIF protocol designed for the efficient management of ONVIF-compliant IP devices, including cameras. This project aims to provide a user-friendly and streamlined solution for the convenient management of IP cameras and other devices that adhere to the ONVIF standard.
**Zabbix Agent 2 Plugin Template** 是一个用于创建 Zabbix agent 2 插件的模板仓库,以便更轻松地创建新的插件项目。
With ONVIF agent, users can easily configure, monitor, and control their ONVIF devices, enhancing the overall experience of managing surveillance systems and ensuring seamless integration within various environments.
此模板的主要目标是通过预先配置项目框架和持续集成,从而加速插件开发的设置阶段。
## Requirements
## 快速开始
- Zabbix agent 2 version 6.0.0 or newer
- Go programming language version 1.20 or newer (required only for building the plugin from the source)
### 先决条件
## Installation
- Go >= 1.20
- Zabbix agent 2 >=6.0.0
- [预编译二进制文件](https://www.zabbix.com/download_agents)
- [Docker 镜像](https://hub.docker.com/r/zabbix/zabbix-agent2)
The plugin can be compiled using `go build`.
### 从源代码构建
`go build`.