Welcome to Ferrocodex Documentation

Ferrocodex is a secure operational technology (OT) configuration management platform designed for industrial environments. It provides offline-first configuration management for industrial equipment with enterprise-grade security features and comprehensive asset hierarchy management.

Contents:

• Getting Started
  • System Requirements
  • Installation
  • First Launch
  • Basic Workflow
  • Next Steps
  • Getting Help
• User Guide
  • Dashboard
  • Asset Management
  • Configuration Management
  • Import and Export
  • Asset Identity Vault
  • Firmware Management
  • Search and Filter
  • Audit Trail
  • User Settings
  • Keyboard Shortcuts
  • Tips and Best Practices
• Asset Hierarchy Management Guide
  • Overview
  • Understanding Asset Types
  • Hierarchical Navigation
  • Custom Metadata System
  • Advanced Search & Filtering
  • Cybersecurity-Compliant Naming
  • Bulk Operations
  • Workflow Management
  • Performance Optimization
  • Best Practices
  • Troubleshooting
  • Conclusion
• Firmware Management Guide
  • Overview
  • Getting Started with Firmware
  • Firmware Analysis Features
  • Golden Firmware Management
  • Firmware Deployment Workflows
  • Firmware and Configuration Integration
  • Compliance and Reporting
  • Advanced Topics
  • Troubleshooting Firmware Issues
  • Best Practices Summary
• Administrator Guide
  • Administrator Role Overview
  • User Management
  • Identity Vault Administration
  • Asset Hierarchy Administration (v0.5.0)
  • System Configuration
  • Audit Log Management
  • Compliance and Reporting
  • Best Practices
  • Administrative Checklist
• Security Best Practices
  • Security Architecture
  • Access Control
  • Asset Naming Security (v0.5.0)
  • Physical Security
  • Operational Security
  • Network Security
  • Identity Vault Security
  • Incident Response
  • Compliance and Standards
  • Security Checklist
  • Security Contact
• Troubleshooting
  • Installation Issues
  • Login and Authentication
  • Performance Issues
  • Asset Hierarchy Issues (v0.5.0)
  • Configuration Management
  • Display Issues
  • Data and Storage
  • Identity Vault Issues
  • Error Messages
  • Getting Help
• Migration Guide
  • Overview
  • Pre-Migration Planning
  • Version-Specific Migrations
  • Data Migration Procedures
  • Handling Migration Issues
  • Post-Migration Tasks
  • Best Practices
  • Emergency Contacts

What’s New in v0.5.0

Asset Hierarchy Management System - Complete transformation of asset organization:

• Hierarchical Organization: Folder-based structure with unlimited nesting for intuitive asset management

• Advanced Search: SQLite FTS5 full-text search with sub-200ms performance across all metadata

• Custom Metadata: Flexible field definitions with templates, validation rules, and JSON schema support

• Cybersecurity Compliance: Enforced naming conventions following security best practices

• Bulk Operations: Import/export, batch updates, and multi-asset management capabilities

• Drag-and-Drop Interface: Intuitive reorganization with visual tree navigation

• Keyboard Navigation: Full keyboard support for power users and accessibility

Overview

Ferrocodex helps industrial organizations manage their equipment configurations securely and efficiently. Key features include:

• Asset Hierarchy Management (v0.5.0): Organize assets in hierarchical structures with folders and devices

• Advanced Search & Filtering (v0.5.0): Full-text search with complex filtering and metadata queries

• Custom Metadata System (v0.5.0): Define equipment-specific fields with validation and templates

• Offline-First Design: Work without internet connectivity in air-gapped environments

• Version Control: Track all configuration changes with built-in branching and auditing

• Identity Vault: Secure credential management with password rotation and compliance tracking

• Role-Based Access: Administrator and Engineer roles with granular permissions

• Enterprise Security: AES-256 encryption, secure authentication, and comprehensive audit trails

• Cross-Platform: Available for Windows, macOS, and Linux

Who Should Use Ferrocodex?

• OT Engineers: Managing configurations for PLCs, SCADA systems, and industrial equipment

• System Administrators: Overseeing configuration management processes and user access

• Security Teams: Ensuring compliance and tracking all configuration changes

• Operations Teams: Maintaining consistent configurations across facilities

Quick Links

• Getting Started - Install and set up Ferrocodex

• User Guide - Learn how to use all features

• Administrator Guide - Administrator functions and management

• Security Best Practices - Understand security best practices

• Troubleshooting - Solve common issues

Support

For support during the alpha phase, please contact your Ferrocodex representative or submit issues through the designated support channel.

Indices and tables

• Index

• Search Page