English | 简体中文

💡 Welcome to click ⭐Star⭐ in the upper right corner to support us!

Open source software is not the same as free. SagooIOT is released under the GPL-3.0 open source license and provides technical exchange and learning. However, according to this license, modified or derived code from SagooIOT may not be released or sold as closed-source commercial software. If you need to use SagooIOT for any commercial purposes locally, please contact the project manager for commercial licensing to ensure your use complies with the GPL license.

SagooIOT is a lightweight enterprise-grade IoT platform developed in Go. It provides complete IoT access, management, analysis and application solutions, supporting cross-platform standalone or distributed deployment. You can quickly build a complete IoT business system with device management, data processing, alert notifications, rule engine, video monitoring, edge computing and other functions.

• 🚀 Fast Deployment - Out-of-the-box, start a complete IoT platform in minutes
• 📱 Full Stack Separation - GoFrame 2.9 backend + Vue 3 frontend, clear and maintainable architecture
• 🔌 Flexible Access - Support TCP, UDP, HTTP, Websocket, MQTT, CoAP, OPC UA, Modbus, SNMP, IEC104, JT808, GB212 and other protocols
• 🧩 Plugin-Driven - Unique hot-pluggable plugin system supporting C/C++, Python, Go multi-language development
• ⚡ High-Performance Data Processing - Integrated TDengine time-series database supporting million-level data points at second-level processing
• 🏭 Edge-Friendly - Support offline deployment, local rule execution, automatic alerts suitable for edge computing scenarios

• Operating System - Linux, macOS, Windows
• Go Version - 1.23.0 or higher
• Memory - 4GB (Recommended 8GB+)
• Disk Space - 20GB (Recommended 50GB+)
• Network - Stable network connection

# Clone the project
git clone https://github.com/sagoo-cloud/sagooiot.git
cd sagooiot

# Create necessary directories
mkdir -p resource/log

# Initialize database (refer to manifest/sql/)
# Need to import database initialization script in MySQL

Create .env file in project root or modify manifest/config/config.dev.yaml:

# Database configuration
database:
  mysql:
    host: localhost
    port: 3306
    name: sagooiot
    user: root
    password: your_password

# Redis configuration
redis:
  host: localhost
  port: 6379
  password: ''

# MQTT configuration (if needed)
mqtt:
  broker: mqtt://localhost:1883

# Download dependencies
go mod download

# Run application
go run main.go

# Application will start at http://localhost:8000

# Ensure Docker and Docker Compose are installed
docker --version
docker-compose --version

cd manifest/docker-compose

# Use docker-compose to start all services (MySQL, Redis, SagooIOT, etc.)
docker-compose -f docker-compose.yml up -d

# View logs
docker-compose logs -f sagooiot

# Stop services
docker-compose down

• Web UI - http://localhost:8000
• API - http://localhost:8000/api
• Default Account - admin / admin123456

⚠️ Strongly recommended to change default password after first login!

┌────────────────────────────────────────────────────────────┐
│                   Frontend Layer (Web UI)                  │
│            Vue 3 + Element Plus + TypeScript               │
└────────────────────────────────────────────────────────────┘
                           ↓
┌────────────────────────────────────────────────────────────┐
│              GoFrame 2.9 Application Service Layer          │
│  ┌──────────────┬──────────────┬──────────────────────────┐ │
│  │Device Manager│Data Processing│  Alert & Notification   │ │
│  │Thing Model   │Rule Engine    │  Data Analysis          │ │
│  │Permission    │Data Center    │  Real-time Push         │ │
│  │System Mgmt   │Task Scheduler │  Other Modules          │ │
│  └──────────────┴──────────────┴──────────────────────────┘ │
└────────────────────────────────────────────────────────────┘
                           ↓
┌────────────────────────────────────────────────────────────┐
│            Protocol Access Layer (Multi-Protocol)           │
│  TCP │ MQTT │ UDP │ CoAP │ HTTP │ Websocket │ RPC         │
│              ↓                                              │
│        Plugin System (C/C++/Python/Go)                      │
│  Modbus TCP/RTU/ASCII │ IEC61850 │ OPC UA │ Canopen       │
└────────────────────────────────────────────────────────────┘
                           ↓
┌────────────────────────────────────────────────────────────┐
│         Storage & Message Middleware Layer                  │
│  ┌──────────┬──────────┬──────────┬──────────┐             │
│  │  MySQL   │  Redis   │ TDengine │  MinIO   │             │
│  │Relational│Cache/Queue│TimeSeries│File Store │             │
│  └──────────┴──────────┴──────────┴──────────┘             │
│  MQTT Broker │ Elasticsearch │ Other Storage Components    │
└────────────────────────────────────────────────────────────┘

Device → Protocol Access → Protocol Parse → Data Validation → Business Process → Data Storage
                    ↓
            Real-time Push → WebSocket → Frontend Display
                
                ↓
          Rule Engine → Alert Judgment → Notification Send
              
                ↓
          Data Analysis → Visualization Report

1. Thing Model Management - Define device properties, events, services, support JSON format import, flexible adaptation for various devices
2. Product Management - Unified management of device type products, support product version, batch operations, product classification
3. Device Management - Complete device lifecycle management: registration, configuration, online/offline, activation, disable, delete
4. Device Tree - Tree-view display of device relationships and grouping, support multi-dimensional classification and permission control
5. Device Tags - Flexible tag system for easy device classification, query, and permission isolation
6. Real-time Data - Device real-time status display, historical data query, data export (Excel/CSV)

1. Multi-Protocol Adaptation - Native support for TCP, UDP, HTTP, Websocket, MQTT, CoAP protocols
2. Protocol Gateway - Protocol conversion and gateway management, support heterogeneous device access (provide secondary development SDK for quick new protocol development)
3. Network Tunnel - Internal network penetration and secure encryption, support P2P connection and proxy forwarding
4. Plugin System - Unique hot-pluggable plugin architecture:
   • Support C/C++, Python, Go multi-language writing
   • Cross-process communication (gRPC) ensures isolation
   • Plugin lifecycle management and hot updates
   • Rich plugin examples and documentation
5. Data Collection Protocols - Integrated Modbus TCP/RTU/ASCII, IEC61850, OPC UA, IEC104 and other industrial protocols

1. Data Center - Build custom data models, third-party API integration, database direct connection, data management
2. Rule Engine - Visual rule editor, support JavaScript expressions, flexible condition combinations
3. Data Transformation - ETL pipeline, data format conversion, field mapping
4. Real-time Analysis - Stream data processing, aggregation computation, window functions
5. Time-Series Database - Deep integration with TDengine, InfluxDB
6. Data Export - Important data support export (Excel, CSV, JSON)

1. Alert Rules - Create, edit, enable/disable rules, support multiple condition triggers (value range, change rate, frequency, etc.)
2. Alert Levels - Custom alert levels (critical, important, normal, tip) and color marking
3. Alert Logs - Query alert history, statistics and analysis, support time range and condition filtering
4. Alert Processing - Alert confirmation, escalation, processing records, processing notes
5. Notification Templates - Email, SMS, webhook, DingTalk, WeChat Enterprise multi-channel notifications
6. Notification Configuration - Notification channel management, recipient configuration, notification time limits
7. Message Push - WebSocket real-time alert push, support multiple push strategies
8. Alert Statistics - Alert data visualization reports, support statistics by time, device, level
9. Alert Governance - Support alert suppression, duplicate alert merging, alert denoising functions

1. Edge Computing - Support local deployment and execution at edge side, achieve offline autonomy
2. Offline Alert - Automatic alert and notification when device goes offline, support offline duration configuration
3. Auto Execution - Automatic device command execution, support delayed execution and retry
4. Scene Management - Create and manage application scenarios (multi-device linkage rules), support scenario triggering and orchestration

1. User Management - User creation, edit, delete, disable/enable, department assignment, role assignment, password reset
2. Department Management - Tree organization structure, department permission isolation, data permission control, department cascade
3. Role Management - Role creation, menu permission assignment, button permission assignment, data permission levels
4. Position Management - Position configuration, association with users, position permissions
5. Menu Management - Dynamic menu configuration, button permission flags, API permission mapping, menu sorting
6. Permission Management - RBAC-based permission control, support Casbin advanced permission policies, permission caching
7. Dictionary Management - System dictionary maintenance, enum value definition, dictionary classification, dictionary export
8. Parameter Management - System parameter dynamic configuration, parameter classification, parameter editing and version management
9. Organization Management - Multi-level organization structure support, organization permission isolation, organization-level data aggregation

1. Operation Log - Record user operations (add/delete/update/query), change history, operation details, IP address tracking
2. Login Log - Login success/failure records, abnormal login alerts, login IP restriction, login location display
3. Device Log - Device upload logs, communication logs, error logs, device command execution logs
4. System Monitoring - Real-time monitoring CPU, memory, disk, network, system processes, database connection pool
5. Online Users - Real-time user status display, session management, forced logout, online user count statistics
6. Scheduled Tasks - Task scheduling and management, execution records, failure retry, task log query

1. Code Generation - Front-end and back-end code auto-generation, CRUD templates, complete API and UI
2. API Documentation - Swagger auto-generation, online testing tool, API version management
3. File Management - File upload download, file sharing, version control, MinIO integration
4. Module Extension - Modular architecture, quick plugin development, SDK provision
5. Development Examples - Provide rich development examples and documentation for quick start with secondary development
6. OpenAPI - Complete OpenAPI specification support for convenient third-party integration
7. North-Bound Interface - Provide standardized north-bound interfaces for integration with other systems

1. OAuth 2.0 - Third-party OAuth integration (GitHub, WeChat, DingTalk, WeChat Enterprise, etc.)
2. OAuth Provider - Act as OAuth provider supporting third-party application access
3. Login Authentication - Account password, phone number, email, QR code scan and other authentication methods
4. Session Management - gToken JWT token management, session timeout configuration, forced logout, concurrent login control
5. Audit Trail - User behavior audit, sensitive operation records, operation traceability
6. SK/AK - Support access key based authentication, suitable for API calls

• Real-time factory equipment monitoring, production data collection
• Equipment maintenance alerts, fault prediction and handling
• Production efficiency analysis and optimization

• Building equipment (HVAC, lighting, security) linkage control
• Energy consumption management and optimization
• Environmental monitoring (temperature, humidity, air quality, etc.)

• Real-time environmental data collection and monitoring
• Pollutant alert and alarm
• Environmental data reporting and compliance verification

• Field sensor deployment and data collection
• Environmental monitoring (temperature, humidity, light, soil moisture)
• Automated irrigation and fertilization control

• Photovoltaic, wind, energy storage device monitoring
• Real-time generation statistics and analysis
• Battery management system (BMS) integration

• Vehicle device access and management
• Vehicle location tracking and route planning
• Fault alert and maintenance reminders

We welcome all forms of contribution! Whether code, documentation, bug reports or feature suggestions, they all help improve our project.

1. Visit Issues page
2. Click "New Issue" button
3. Select appropriate template (Bug report or feature suggestion)
4. Describe the issue or suggestion in detail
5. Submit the issue

1. Fork the project

   Click the Fork button in upper right corner

2. Clone to local

   git clone https://github.com/your-username/sagooiot.git
   cd sagooiot

3. Create feature branch

   git checkout -b feature/AmazingFeature

4. Make changes and test

   # Modify code
   # Run tests
   go test ./...

5. Commit changes

   git add .
   git commit -m 'Add some AmazingFeature'

6. Push to branch

   git push origin feature/AmazingFeature

7. Open Pull Request

   • Open PR on GitHub
   • Describe changes and purpose
   • Wait for maintainer review and merge

• Code Style - Follow Go official coding standards, use gofmt format code
• Commit Message - Use clear, concise commit messages, format: [type] short description
  • [feat] - New feature
  • [fix] - Bug fix
  • [docs] - Documentation update
  • [refactor] - Code refactoring
  • [test] - Test related
  • [ci] - CI/CD related
• Testing - Ensure all tests pass before submitting PR
• Documentation - New features should include corresponding documentation updates
• Branch Naming - Use meaningful branch names, e.g., feature/xxx or fix/xxx

• 📝 Documentation Translation - Help translate documentation to other languages
• 🐛 Bug Fixing - Report and fix discovered issues
• ✨ New Features - Implement new features or improve existing ones
• 📚 Tutorials & Examples - Write tutorials and integration examples
• 🌍 Localization - Support more languages and regions
• 🎨 UI/UX Improvement - Improve user interface and experience

Thanks to all developers and users who contributed to SagooIOT! Your support and feedback drive project development.

A: SagooIOT follows GPL-3.0 open source license, personal learning and use are completely free. For commercial licensing, please contact the project team.

A: SagooIOT supports access of any devices supporting TCP, MQTT, UDP, CoAP, HTTP, Websocket and other protocols. Additional protocols can be supported through plugins.

A: SagooIOT integrates TDengine time-series database supporting million-level data points at second-level processing. Also supports data sharding and cache optimization solutions.

A: Completely supported. SagooIOT can be deployed on AWS, Alibaba Cloud, Tencent Cloud, Huawei Cloud and any cloud platform, supporting Docker and Kubernetes.

A: Through device command function in device management module for remote control. Support real-time and scheduled control.

A: Fully supported. You can deploy SagooIOT on your own servers or intranet, data belongs completely to you.

A: SagooIOT supports offline deployment and local rule execution, can run on edge devices achieving edge computing and offline autonomy.

A: Supported. SagooIOT provides complete OpenAPI and north-bound interfaces for easy integration with third-party systems.

SagooIOT Community Edition is an open source learning project not related to commercial activities. Users should comply with laws and regulations when using this project and must not engage in illegal activities.

• If SagooIOT discovers users engaged in illegal activities, it will cooperate with relevant authorities to investigate and report to government
• Users bear all legal liability arising from illegal activities themselves
• If a third party is damaged due to user use, users must compensate accordingly under law
• Users bear all risks in using all resources of SagooIOT
• This project provides no guarantees or warranties

Thanks for all the support from stars and contributors!

This project is licensed under GPL-3.0. See LICENSE file for details.

• QQ Official Group - 686637608
• Official Website - http://www.sagoo.cn
• GitHub - https://github.com/sagoo-cloud/sagooiot
• Gitee - https://gitee.com/sagoo-cloud/sagooiot
• Documentation Center - http://iotdoc.sagoo.cn/