RackPlane Documentation¶
Welcome to RackPlane Documentation¶
This documentation covers installation, configuration, and usage of RackPlane - a multi-tenant SaaS platform for inventory and asset management across multiple industries including datacenter, healthcare, and warehouse.
Quick Links¶
| I want to... | Go to... |
|---|---|
| Get started quickly | Getting Started Guide |
| Set up a new organization | Multi-Tenant Onboarding |
| Learn asset management | Asset Management Training |
| Customize branding | White-Label Configuration |
| Manage users and tenants | Administrator Guide |
| Access the API | API Reference |
Documentation Structure¶
📚 Guides¶
Step-by-step guides for common tasks and setup procedures.
| Guide | Description |
|---|---|
| Getting Started | First login and basic orientation |
| Multi-Tenant Onboarding | Complete tenant setup process |
| Location Setup | Datacenter, room, and rack configuration |
| Label Printing | Brother PT-E550W printer setup |
🎓 Training Materials¶
In-depth training for specific features and workflows.
| Training | Description |
|---|---|
| Asset Management | Complete asset lifecycle management |
| White-Label Configuration | Branding and terminology customization |
| Administrator Guide | Tenant and user management |
| Network Ports | Port management and cable connections |
| Reports | Generating and exporting reports |
🏥 Industry Verticals¶
Specialized guides for different industry use cases.
| Vertical | Description |
|---|---|
| Healthcare Vertical | Medical supply management, expiration tracking, lot numbers |
| Warehouse Vertical | Bin locations, pick/pack workflows, inventory counts |
🔌 API Reference¶
Technical documentation for API integration.
| Reference | Description |
|---|---|
| API Overview | Authentication and common patterns |
| Assets API | Asset CRUD operations |
| Locations API | Location management |
| Users API | User management |
| Version API | API versioning endpoints |
By Role¶
For New Users¶
- Getting Started - Orientation and first steps
- Asset Management - Core functionality
For Tenant Administrators¶
- Administrator Guide - User management
- White-Label Configuration - Customization
- Multi-Tenant Onboarding - Adding organizations
For Developers¶
- API Reference - REST API documentation
- Integration Guide - Third-party integrations
- Development Setup - Local development environment
For Super Administrators¶
- Administrator Guide - Platform management
- Multi-Tenant Onboarding - Tenant provisioning
- Security Guide - Security best practices
Feature Documentation¶
Core Features¶
- Multi-Tenant Architecture - Complete tenant isolation
- Asset Management - Full lifecycle tracking
- Location Hierarchy - Datacenter → Room → Rack → U-position
- Stock Management - Spare parts and inventory
Advanced Features¶
- Network Ports - Port-to-port cable connections
- Label Printing - QR code asset labels
- OCR Scanning - Label and invoice parsing
- NetBox Integration - Bidirectional sync (Pro+)
White-Label Features¶
- Branding - Logo, colors, app name
- Terminology - Industry-specific language
- Vertical Packs - Pre-configured industry settings
- Feature Toggles - Enable/disable capabilities
Industry Verticals¶
- Datacenter - Rack management, power efficiency, network ports
- Healthcare - Expiration tracking, lot numbers, FEFO, compliance
- Warehouse - Bin locations, pick/pack, inventory counts
Subscription Tiers¶
| Feature | Community | Starter | Pro | MSP |
|---|---|---|---|---|
| Asset Management | ✅ | ✅ | ✅ | ✅ |
| Label Printing | ❌ | ✅ | ✅ | ✅ |
| Cloud OCR | ❌ | 100/mo | 500/mo | ∞ |
| API Access | ❌ | ❌ | ✅ | ✅ |
| NetBox Sync | ❌ | ❌ | ✅ | ✅ |
| Multi-Tenant | ❌ | ❌ | ❌ | ✅ |
| White-Label | ❌ | ❌ | ❌ | ✅ |
Getting Help¶
In-App Help¶
- Contextual help icons throughout the application
- Tooltips on hover
- Guided tours for new users
Support Channels¶
- Documentation: You are here!
- Email: support@rackplane.com
- GitHub: Issues and Discussions
API Documentation¶
- Swagger UI:
/api/docson your installation - ReDoc:
/api/redocfor alternative view
Version Information¶
| Component | Version |
|---|---|
| API Version | v1.0.0 |
| Supported Versions | v1 |
| Documentation Updated | December 2024 |
Check /api/version for current API version information.
Contributing to Documentation¶
We welcome contributions to improve this documentation:
- Fork the repository
- Edit documentation files in
/docs - Submit a pull request
Please follow: - Markdown formatting standards - Clear, concise language - Include examples where helpful - Keep navigation links updated