MiniUPnP项目技术文档

1. 安装指南

依赖安装

在安装MiniUPnP项目之前，确保系统中已安装以下依赖项：

• GCC编译器
• make工具
• 实现UPnP协议的网络库（如libevent）

编译安装

以下是在Linux系统上编译和安装MiniUPnP的步骤：

1. 从Git仓库克隆项目：

   git clone https://github.com/miniupnp/miniupnp.git
   

2. 进入项目目录：

   cd miniupnp
   

3. 编译MiniUPnP客户端和守护进程：

   make
   

4. 安装MiniUPnP客户端和守护进程：

   make install
   

2. 项目的使用说明

MiniUPnP项目包含以下子项目：

• miniupnpc/：MiniUPnP客户端，用于控制UPnP IGD。
• miniupnpd/：MiniUPnP守护进程，实现了UPnP IGD，并支持NAT-PMP/PCP网关。
• minissdpd/：SSDP管理守护进程，与miniupnpc、miniupnpd、ReadyMedia等配合使用。

运行MiniUPnP守护进程

启动MiniUPnP守护进程：

sudo miniupnpd

使用MiniUPnP客户端

通过MiniUPnP客户端控制UPnP IGD，例如获取外部IP地址：

miniupnpc -l

3. 项目API使用文档

MiniUPnP项目提供了丰富的API供开发者使用，以下是一些常用的API：

• MiniUPnPClient_Init(): 初始化MiniUPnP客户端。
• MiniUPnPClient_GetExternalIP(): 获取外部IP地址。
• MiniUPnPClient_AddPortMapping(): 添加端口映射。
• MiniUPnPClient_DeletePortMapping(): 删除端口映射。

4. 项目安装方式

源代码编译安装

如前所述，您可以通过源代码编译的方式安装MiniUPnP项目。

包管理器安装

在某些Linux发行版中，可以使用包管理器安装MiniUPnP项目。例如，在Debian/Ubuntu系统中，可以使用以下命令：

sudo apt-get install miniupnp

请确保遵循上述指南，以便顺利安装和使用MiniUPnP项目。