Dev to master

* docs: update README docs

* feat: add webhook testing prg

* fix: correct API key authentication config

* feat: add GitHub commit message convention

* refactor: script reengineering

Author: tkspuk

.gitmessage

@@ -0,0 +1,19 @@
+# <type>: <description>
+#
+# Types:
+#   feat     : New feature
+#   fix      : Bug fix
+#   docs     : Documentation changes
+#   style    : Code style changes
+#   refactor : Code refactoring
+#   test     : Test related changes
+#   chore    : Other changes
+#
+# Examples:
+#   feat: Add xxx functionality
+#   fix: Fix API response error
+#   docs: Update xxx documentation
+#   style: Adjust code formatting
+#   refactor: Refactor xxx module
+#   test: Add xxx functionality tests
+#   chore: Update dependency versions 

AUTHORS.md

@@ -4,7 +4,7 @@
 
 - GitHub: [@tkspuk](https://github.com/tkspuk)  
 - Email: tkspuk@gmail.com  
-- Role: Project Owner, Product Lead & Contributing Developer  
+- Role: Creator & Contributing Developer  
 - Bio: Senior network engineer specializing in AI infrastructure and system architecture. Responsible for product vision, planning, and partial implementation of key features.
 
 ---

CONTRIBUTING.md

@@ -15,7 +15,7 @@ cd netpulse
 
 ```bash
 # Generate environment variables
-bash ./scripts/check_env.sh generate
+bash ./scripts/setup_env.sh generate
 
 # Start development services
 docker compose up -d
@@ -51,6 +51,52 @@ black --check .
 - Use Ruff for linting
 - Add type hints where appropriate
 
+## Git Commit Guidelines
+
+We use a simple commit message format to maintain clear code history.
+
+### Commit Message Format
+
+```
+<type>: <description>
+```
+
+### Types
+
+- **feat**: New feature
+- **fix**: Bug fix
+- **docs**: Documentation changes
+- **style**: Code style changes (formatting, etc.)
+- **refactor**: Code refactoring
+- **test**: Test related changes
+- **chore**: Other changes
+
+### Examples
+
+```
+feat: Add user login functionality
+fix: Fix API response error
+docs: Update README installation guide
+style: Adjust code formatting
+refactor: Refactor user authentication module
+test: Add login functionality tests
+chore: Update dependency versions
+```
+
+### Pre-commit Checklist
+
+- Code passes all tests
+- Code passes linting checks
+- New features include corresponding tests
+
+### Setup Git Commit Template (Optional)
+
+```bash
+bash ./scripts/setup_git_template.sh
+```
+
+After setup, the commit message template will be automatically loaded when running `git commit`.
+
 ## Reporting Issues
 
 Please use GitHub Issues to report bugs or request features.

README-zh.md

@@ -3,10 +3,11 @@
 [![Docker](https://img.shields.io/badge/Docker-Ready-blue?logo=docker)](https://hub.docker.com)
 [![Python](https://img.shields.io/badge/Python-3.12+-green?logo=python)](https://python.org)
 [![License](https://img.shields.io/badge/License-MIT-blue)](LICENSE)
+[![Documentation](https://img.shields.io/badge/Docs-ReadTheDocs-blue)](https://netpulse.readthedocs.io/)
 
 简体中文 | [English](README.md)
 
-NetPulse 是一个高性能的分布式网络设备管理 API 框架。它通过创新的长连接技术提供统一接口，并通过插件机制无缝集成 Netmiko、NAPALM 等主流开源工具和厂商 API，让网络设备管理变得简单、高效、可靠。
+NetPulse 是一个专为现代网络自动化设计的高性能分布式网络设备管理API框架。它通过长连接技术提供统一接口，并通过插件机制无缝集成Netmiko、NAPALM等主流开源工具和PyEAPI等厂商API，让网络设备管理变得简单、高效、可靠。
 
 ## 为什么选择 NetPulse？
 
@@ -44,13 +45,13 @@ NetPulse 提供了强大的插件系统，支持多种功能扩展：
 
 ## 快速开始
 
-NetPulse 提供了详细的文档，包括快速入门、架构说明、API参考和最佳实践等。完整文档即将发布到 readthedocs，目前您可以查看以下内容：
+NetPulse 提供了详细的文档，包括快速入门、架构说明、API参考和最佳实践等。访问我们的文档站点获取完整指南：
 
-* [快速入门](docs/zh/getting-started/quick-start.md) - 5分钟上手指南
-* [架构设计](docs/zh/architecture/overview.md) - 系统架构说明
-* [API 参考](docs/zh/guides/api/README.md) - 完整的 API 文档
-* [插件开发](docs/zh/development/README.md) - 插件开发指南
-* [部署指南](docs/zh/getting-started/deployment.md) - 详细的部署文档
+* [📖 快速入门](https://netpulse.readthedocs.io/zh/latest/getting-started/quick-start.html) - 5分钟快速上手
+* [🏗️ 架构设计](https://netpulse.readthedocs.io/zh/latest/architecture/overview.html) - 系统架构概览
+* [🔌 API 参考](https://netpulse.readthedocs.io/zh/latest/guides/api.html) - 完整的 RESTful API 文档
+* [⚙️ 插件开发](https://netpulse.readthedocs.io/zh/latest/development/index.html) - 构建自定义驱动和插件
+* [🚀 部署指南](https://netpulse.readthedocs.io/zh/latest/getting-started/deployment.html) - 生产环境部署说明
 
 ### Docker 一键部署
 
@@ -60,14 +61,14 @@ git clone https://github.com/netpulse/netpulse.git
 cd netpulse
 
 # 一键部署
-bash ./scripts/docker_deploy.sh
+bash ./scripts/docker_auto_deploy.sh
 ```
 
 ### 手动配置部署
 
 ```bash
 # 1. 生成环境配置
-bash ./scripts/check_env.sh generate
+bash ./scripts/setup_env.sh generate
 
 # 2. 配置必要的环境变量
 cat << EOF > .env
@@ -78,6 +79,29 @@ EOF
 
 # 3. 启动服务
 docker compose up -d
+
+### 快速API测试
+
+部署完成后，使用简单的健康检查测试API：
+
+```bash
+# 测试健康检查端点
+curl -H "X-API-KEY: your_secure_api_key" http://localhost:9000/health
+
+# 测试设备命令（请替换为您的设备详情）
+curl -X POST http://localhost:9000/device/execute \
+  -H "X-API-KEY: your_secure_api_key" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "driver": "netmiko",
+    "connection_args": {
+      "device_type": "cisco_ios",
+      "host": "192.168.1.1",
+      "username": "admin",
+      "password": "admin123"
+    },
+    "command": "show version"
+  }'
 ```
 
 ## 参与贡献
@@ -92,13 +116,19 @@ docker compose up -d
 
 详细信息请参考 [贡献指南](CONTRIBUTING.md)。
 
+## 社区与支持
+
+* 📚 **[文档](https://netpulse.readthedocs.io/)** - 完整指南和API参考
+* 🐛 **[问题反馈](https://github.com/scitix/netpulse/issues)** - 报告bug和请求功能
+
+https://github.com/scitix/netpulse
 ## 开源协议
 
 本项目采用 MIT 协议 - 详见 [LICENSE](LICENSE) 文件。
 
 ## 作者
 
-* **Locus Li** – 项目负责人
+* **Locus Li** – 项目发起人 & 维护者
 * **Yongkun Li** – 首席开发者
 
 查看 [AUTHORS.md](AUTHORS.md) 了解所有贡献者信息。

README.md

@@ -3,10 +3,11 @@
 [![Docker](https://img.shields.io/badge/Docker-Ready-blue?logo=docker)](https://hub.docker.com)
 [![Python](https://img.shields.io/badge/Python-3.12+-green?logo=python)](https://python.org)
 [![License](https://img.shields.io/badge/License-MIT-blue)](LICENSE)
+[![Documentation](https://img.shields.io/badge/Docs-ReadTheDocs-blue)](https://netpulse.readthedocs.io/)
 
 [简体中文](README-zh.md) | English
 
-NetPulse is a high-performance distributed network device management API framework. Through innovative persistent connection technology and unified interfaces, it seamlessly integrates with mainstream tools like Netmiko, NAPALM, and vendor APIs to make network device management simple, efficient, and reliable.
+NetPulse is a high-performance distributed network device management API framework designed for modern network automation. It provides unified interfaces through persistent connection technology and seamlessly integrates with mainstream open-source tools like Netmiko, NAPALM, and vendor APIs like PyEAPI, making network device management simple, efficient, and reliable.
 
 ## Why NetPulse?
 
@@ -44,13 +45,13 @@ NetPulse offers a powerful plugin system supporting various functional extension
 
 ## Quick Start
 
-NetPulse provides comprehensive documentation including quick start guides, architecture explanations, API references, and best practices. The complete documentation will be available on readthedocs soon. Currently, you can refer to:
+NetPulse provides comprehensive documentation including quick start guides, architecture explanations, API references, and best practices. Visit our documentation site for complete guides:
 
-* [Quick Start](docs/en/getting-started/quick-start.md) - 5-minute guide
-* [Architecture](docs/en/architecture/overview.md) - System architecture
-* [API Reference](docs/en/guides/api/README.md) - Complete API documentation
-* [Plugin Development](docs/en/development/README.md) - Development guide
-* [Deployment Guide](docs/en/getting-started/deployment.md) - Detailed deployment instructions
+* [📖 Quick Start](https://netpulse.readthedocs.io/en/latest/getting-started/quick-start.html) - Get started in 5 minutes
+* [🏗️ Architecture](https://netpulse.readthedocs.io/en/latest/architecture/overview.html) - System architecture overview
+* [🔌 API Reference](https://netpulse.readthedocs.io/en/latest/guides/api.html) - Complete RESTful API documentation
+* [⚙️ Plugin Development](https://netpulse.readthedocs.io/en/latest/development/index.html) - Build custom drivers and plugins
+* [🚀 Deployment Guide](https://netpulse.readthedocs.io/en/latest/getting-started/deployment.html) - Production deployment instructions
 
 ### Docker Quick Deploy
 
@@ -60,14 +61,14 @@ git clone https://github.com/netpulse/netpulse.git
 cd netpulse
 
 # One-click deployment
-bash ./scripts/docker_deploy.sh
+bash ./scripts/docker_auto_deploy.sh
 ```
 
 ### Manual Configuration
 
 ```bash
 # 1. Generate environment configuration
-bash ./scripts/check_env.sh generate
+bash ./scripts/setup_env.sh generate
 
 # 2. Configure essential environment variables
 cat << EOF > .env
@@ -78,6 +79,29 @@ EOF
 
 # 3. Start the service
 docker compose up -d
+
+### Quick API Test
+
+After deployment, test the API with a simple health check:
+
+```bash
+# Test health endpoint
+curl -H "X-API-KEY: your_secure_api_key" http://localhost:9000/health
+
+# Test device command (replace with your device details)
+curl -X POST http://localhost:9000/device/execute \
+  -H "X-API-KEY: your_secure_api_key" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "driver": "netmiko",
+    "connection_args": {
+      "device_type": "cisco_ios",
+      "host": "192.168.1.1",
+      "username": "admin",
+      "password": "admin123"
+    },
+    "command": "show version"
+  }'
 ```
 
 ## Contributing
@@ -92,13 +116,18 @@ We welcome all forms of contributions! Here's how you can contribute:
 
 For more details, please refer to our [Contributing Guide](CONTRIBUTING.md).
 
+## Community & Support
+
+* 📚 **[Documentation](https://netpulse.readthedocs.io/)** - Complete guides and API reference
+* 🐛 **[Issues](https://github.com/scitix/netpulse/issues)** - Report bugs and request features
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 ## Authors
 
-* **Locus Li** – Project Owner
+* **Locus Li** – Creator & Maintainer
 * **Yongkun Li** – Lead Developer
 
 See [AUTHORS.md](AUTHORS.md) for a full list of contributors.

config/config.yaml

@@ -1,7 +1,7 @@
 server:
   host: 0.0.0.0
   port: 9000
-  api_key: SOME-API-KEY
+  api_key: ${NETPULSE_SERVER__API_KEY}
   api_key_name: X-API-KEY
   gunicorn_worker: 4
 

docs/en/getting-started/deployment.md

@@ -45,7 +45,7 @@ The fastest way with minimal user interaction.
 
 ```bash
 # One-click deployment script
-bash ./scripts/docker_deploy.sh
+bash ./scripts/docker_auto_deploy.sh
 ```
 
 This script will automatically complete:
@@ -85,7 +85,7 @@ More control while automating tedious parts.
 
 ```bash
 # Automatically generate secure environment variables
-bash ./scripts/check_env.sh generate
+bash ./scripts/setup_env.sh generate
 ```
 
 #### Step 2: Review and Customize (Optional)
@@ -225,7 +225,7 @@ docker compose exec redis redis-cli --tls \
   -p 6379 -a "$NETPULSE_REDIS__PASSWORD" ping
 
 # Test API health endpoint
-curl -H "Authorization: Bearer $NETPULSE_SERVER__API_KEY" \
+curl -H "X-API-KEY: $NETPULSE_SERVER__API_KEY" \
      http://localhost:9000/health
 
 # Expected response: {"code": 0, "message": "success", "data": "ok"}
@@ -390,7 +390,7 @@ Deploying Nginx Ingress can achieve load balancing and HTTPS access.
    
    Make sure you have created the `.env` file:
    ```bash
-   bash ./scripts/check_env.sh generate
+   bash ./scripts/setup_env.sh generate
    ```
 
 2. **Redis connection failed**
@@ -412,7 +412,7 @@ Deploying Nginx Ingress can achieve load balancing and HTTPS access.
 ### Getting Help
 
 - Check logs: `docker compose logs -f`
-- Verify environment: `bash ./scripts/check_env.sh check`
+- Verify environment: `bash ./scripts/setup_env.sh check`
 - Review [Configuration Guide](../guides/configuration.md)
 
 ---

docs/en/getting-started/first-steps.md

@@ -21,15 +21,18 @@ Before starting, please ensure:
 
 ## API Authentication
 
-NetPulse uses Bearer Token authentication:
+NetPulse uses API Key authentication. All endpoints require authentication:
 
 ```bash
-# API key format
-Authorization: Bearer YOUR_API_KEY
+# API key format (Header)
+X-API-KEY: YOUR_API_KEY
 
-# Example
-curl -H "Authorization: Bearer sk-1234567890abcdef" \
+# Example using header
+curl -H "X-API-KEY: your_api_key_here" \
      http://localhost:9000/health
+
+# Alternative using query parameter
+curl "http://localhost:9000/health?X-API-KEY=your_api_key_here"
 ```
 
 ## Basic API Calls
@@ -39,7 +42,7 @@ curl -H "Authorization: Bearer sk-1234567890abcdef" \
 First, test if the API service is running normally:
 
 ```bash
-curl -H "Authorization: Bearer YOUR_API_KEY" \
+curl -H "X-API-KEY: YOUR_API_KEY" \
      http://localhost:9000/health
 ```
 
@@ -58,7 +61,7 @@ curl -H "Authorization: Bearer YOUR_API_KEY" \
 View API version and feature information:
 
 ```bash
-curl -H "Authorization: Bearer YOUR_API_KEY" \
+curl -H "X-API-KEY: YOUR_API_KEY" \
      http://localhost:9000/
 ```