Welcome to My Documentation¶

Complete user and developer documentation for My - the centralized management platform.

What is My?¶

My is a comprehensive management platform that provides:

• Centralized Authentication using Logto as Identity Provider
• Hierarchical Organization Management (Owner, Distributor, Reseller, Customer)
• Role-Based Access Control (RBAC) with dual-role system
• System Monitoring with real-time inventory and heartbeat tracking
• User Management with automatic welcome emails and self-service features

Documentation Structure¶

📚 User Guide¶

Complete guides for end users and administrators:

💻 Developer Documentation¶

Technical documentation for developers and integrators:

• Backend API - Go REST API server with JWT authentication
• Collect Service - Inventory and heartbeat collection service
• Sync Tool - RBAC synchronization CLI tool
• Project Overview - Complete project documentation and architecture

Quick Start¶

🧑 For End Users¶

1. Log in with your credentials
2. Create organizations based on your business hierarchy
3. Add users and assign appropriate roles
4. Create systems for your customers
5. Register systems to enable monitoring

🧑‍💻 For Developers¶

1. Clone the repository
2. Read the Project documentation
3. Set up your development environment
4. Follow the RBAC configuration guide

Key Features¶

🔐 Security First¶

• Argon2id secret hashing (memory-hard, GPU-resistant)
• Token Split Pattern for system credentials
• JWT-based authentication with token blacklisting
• RBAC with hierarchical permissions

🏢 Business Hierarchy¶

Owner (Nethesis)
    ↓
Distributors
    ↓
Resellers
    ↓
Customers

Each level manages only their downstream organizations.

👥 Dual-Role System¶

Organization Roles (business hierarchy): - Owner, Distributor, Reseller, Customer

User Roles (technical capabilities): - Admin, Support, and more

Effective permissions = Organization Role + User Role

📊 Real-Time Monitoring¶

• Heartbeat tracking every 5 minutes
• Inventory collection every 6 hours
• Automatic change detection with diff analysis
• Status indicators: Active 🟢 / Inactive 🟡 / Unknown ⚪ / Deleted 🔴

🔄 System Lifecycle¶

graph LR
    A[Create System] --> B[Receive secret]
    B --> C[Register System]
    C --> D[Get system_key]
    D --> E[Send Inventory]
    D --> F[Send Heartbeat]
    E --> G[Monitored]
    F --> G

Getting Help¶

For Users¶

• Browse the User Guide sections
• Check the troubleshooting sections in each guide
• Contact your system administrator

For Developers¶

• Read the component-specific READMEs
• Check the API documentation
• Review the architecture documentation in DESIGN.md
• Open an issue on GitHub

Technology Stack¶

• Backend: Go 1.24+ with Gin framework
• Database: PostgreSQL with migrations
• Cache: Redis for high-performance caching
• Identity: Logto for authentication and RBAC
• Frontend: Vue.js 3 (see separate repository)

Version Information¶

Current version: 0.0.3 (Pre-production)

This documentation is continuously updated. Last update: 2025-11-06