User Guide

The FoundriesFactory™ Platform User Guide has walk-throughs covering tasks for working with your Factory.

Factory & Account Management has no prerequisites.

For most sections, you should have completed getting started and be familiar with the topics covered in the Tutorials.

For in depth details and specific use cases, see the Reference Manual.

• Flashing Instructions
  • Qualcomm Dragonwing RB3 Gen 2 Development Kit
  • Beaglebone Black
    • Preparation
    • Flashing
  • Raspberry Pi 4 or 5
    • Preparation
    • Flashing
  • Arduino Portenta X8
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 8M Nano Evaluation Kit
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 8M Mini Evaluation Kit
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 8M Mini/Nano Evaluation Kit with SE050ARD
    • Attaching the SE050
    • Installing the FoundriesFactory Image
  • i.MX 8M Quad Evaluation Kit
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 8M Quad Evaluation Kit with SE050ARD
    • Attaching the SE050
    • Installing the FoundriesFactory Image
  • i.MX 8M Plus Evaluation Kit
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 8M Plus Evaluation Kit With SE050ARD
    • Attaching the SE050
    • Installing the FoundriesFactory Image
  • i.MX 6UL Evaluation Kit
    • Pre-Preparation
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 6ULL Evaluation Kit
    • Pre-Preparation
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 6ULL Evaluation kit With SE050ARD
    • Attaching the SE050
    • Installing the FoundriesFactory Image
  • Apalis iMX6 with the Ixora Carrier Board
    • Preparation
    • Hardware Preparation
    • Flashing
  • Apalis iMX8 with the Ixora Carrier Board
    • Preparation
    • Hardware Preparation
    • Flashing
  • NXP i.MX 8QuadMax Multisensory Enablement Kit (MEK)
    • Preparation
    • Hardware Preparation
    • Flashing
  • i.MX 93 Evaluation Kit
    • Preparation
    • Hardware Preparation
    • Flashing
  • x86
    • Intel Core i7 CPU (and later): Booting From External Flash
      • Preparation
      • Flashing
    • Intel Core i7 CPU (and later): Installing to Internal Flash
      • Preparation
      • Flashing
      • Booting the Installer
• Fioctl
  • Auto Updating
  • Enabling/Disabling Apps
    • Via Fioctl
    • Via the LmP Device Register Script
  • Inspecting Targets
  • Common Commands
• QEMU
  • arm
    • Booting in QEMU
      • QEMU CLI
      • Image Resizing
    • Booting Graphically
  • arm64
    • Booting in QEMU
      • QEMU CLI
      • Image Resizing
    • Booting Graphically
  • x86_64
    • Booting in QEMU
      • QEMU CLI
      • Image Resizing
    • Booting Graphically
• Factory & Account Management
  • Factory Account Roles
    • How it Works: Walk Through
  • Managing Your Subscription
    • Changing Your Plan
      • Factory Upgrade
    • Payment and Billing
  • Team Based Factory Access
    • How it Works: Walk Through
      • Example
    • Team Based Access to Device Groups
      • Example
    • Changes to TUF Root
  • Setting When Devices are Considered Offline
    • How It Works: Walk Through
• Developer Workflow and Guidelines
  • Overview of Factory Configuration
  • Development Best Practices
    • Branching
    • Embedded and OS Development
    • Application Development
    • Tagging and Testing
      • Advanced Tagging
    • Managing Devices
  • Production Best Practices
• Intellectual Property Protection
• Custom CI
  • Custom CI for RootFS
    • Prerequisites
    • Bitbake
    • Push OSTree Repo To Cloud
    • Add OSTree Target
    • Check the OSTree Target
  • Custom CI To Build Compose App Targets
    • Prerequisites
    • Creating And Setting the Access Token
    • Set Token in GitHub Repo
    • Define GitHub Actions Workflow
    • Learn App Repo Structure Details
    • FoundriesFactory Utilities: Usage Details
    • Check the Workflow Result
• Configuring Automatic Git Mirroring
  • Creating Token
  • Configuring GitHub
    • Creating Mirror Action
    • GitHub Action
  • Configuring Bitbucket
• Working With Git Submodules
  • Create a GitHub Repository
  • Preparing the GitHub Repository
  • Adding the Submodule
  • Updating the Submodule Manually
  • Updating the Submodule Automatically
• Remote Access
  • WireGuard VPN
    • Actions on VPN Server
    • Enabling Remote Access to a Device
    • Changing Wireguard Server Address
    • Troubleshooting
      • Method 1
      • Method 2
      • Further Debug
• Foundries.io REST API
  • Prerequisites
  • Creating Token
  • Getting Started
  • Device List
  • Targets List
  • Configure Device
  • Enabling/Disabling Application
  • Learning More About the REST API
• Containers and Docker
  • Containers
    • Advanced Container Usage
      • Examples
    • Passing Arguments to Build Context
      • Example
    • Advanced Container Dependencies
      • Examples
  • Docker Credential Helper
  • Compose Apps
    • Compose Apps in a Factory
    • Compose Apps Distribution
    • How Does It Fit Together?
    • Examples
      • Single Container Application
      • A Flask Web App
  • Container Preloading
    • Configure the CI
    • Getting a New Image with Preloaded Containers
    • Checking the Preloaded Image
      • Restorable Type
    • Starting Compose Apps Automatically
    • Testing Auto Start
    • Common Advanced Scenario
  • Multi-Stage Container Builds
    • Single Stage Container
    • Multi-Stage Container
• Using Third-Party Private Container Registries
  • Configuring for CI Azure Container Registry (ACR)
    • Configuring Devices for ACR
  • Configuring CI for AWS ECR
    • Configuring Devices for AWS ECR
  • Configuring for CI Google Artifact Registry (GAR)
    • Configuring Devices for GAR
• Customizing the LmP
  • Building From Source: Development Container
    • Requirements
    • Build and Install the LmP for your Factory
    • Build and Install Without a Factory
      • Setup
      • Download the Layers
      • Setup the Build Environment
    • Build the Image
      • Install the Image
    • References
  • Extending the Linux microPlatform
    • Adding Packages to the Image
    • List of Available Recipes
    • Creating a Python3 Package from PyPi
    • Using FEATURES to Configure LmP
    • Including Private Git+ssh Repositories
  • LmP Customization
    • Customizing the Distro
    • Kernel Command Line Arguments
      • Distro: lmp
      • Distro: lmp-base
    • Automatically Loading a Kernel Module
    • Adding a new Systemd Startup Service
      • Setting a Static IP on the Device
    • LmP Users and Groups
      • Extending User Groups
      • Adding New LmP Users
      • Replacing Default fio User
    • LmP Time Servers
    • Installing Files Under var
• Auto Hostname
  • Adding the Recipe
  • LmP Auto Hostname Variables
  • Configuring the LmP Auto Hostname
  • Testing Auto Hostname
• Auto Register
  • Prerequisites
  • Creating Token
  • Enabling Recipe
  • Configuring the LmP Auto Register
  • Additional Configuration
  • Testing Auto Register
• Customizing Over the Air Updates
  • Callbacks
  • Custom Update Agents
    • Using The Custom SOTA Client Example
      • Forking the Custom SOTA Client
        • Custom SOTA Client Work Modes
  • Command Line Interface - CLI (Aktualizr-lite Manual Mode)
    • Available commands for Command Line Interface (CLI)
      • update
      • run
      • check
      • list
      • pull
      • install
      • rollback
    • Automating the use of CLI Operations
    • Creating Custom Logic for Update Decision
• Offline Updates
  • Prerequisites
  • Obtaining Offline Update Content
  • Signing the Offline Update Bundle
  • Performing the Offline Update
  • Usage Details
    • Post Install and Run Actions
    • Configuration Details
  • Offline Update Considerations
  • Controlling the Expiration Time of the Offline Update Bundle
    • Considerations About Offline Update Bundle Validity and TUF Rotation
    • Understanding the Math Behind the Offline Update Bundle Expiration Time
• Disk Encryption Support
  • Prerequisites
  • Enabling Support for Disk Encryption
    • Implementation Details for OP-TEE PKCS#11 Support
    • Testing TPM 2.0 Support With Qemu (x86) and swtpm
  • Implementation Details for OP-TEE PKCS#11 Support
    • Testing PKCS#11 Support With Qemu (arm64)
• Factory Reset
  • Full Factory Reset
  • Partial Factory Reset
    • Keep SOTA
    • Keep SOTA and Docker
    • RPMB
• Updating the Linux microPlatform Core
  • Updating Your Factory
    • lmp-manifest
      • Common Pitfalls
    • meta-subscriber-overrides
  • Verifying Your Work
  • Merging Back to Development
  • Common Errors and Tips
• Machines with Secure Aspects Enabled by FoundriesFactory
  • Supported Machines
  • Enabling
  • Using the Secure Machine
  • Using Custom Keys
    • Creating the Keys
    • Generate the MfgTools Scripts
  • Accessing Secure Storage
    • Writing to Secure Storage
    • Reading From Secure Storage
• Offline Factory TUF Keys
  • How to Rotate Offline TUF Root Key
  • How to Rotate Offline TUF Targets Key
  • How to View Offline TUF Keys
  • How to Backup Offline TUF Keys
  • Expert Mode
    • How to Add More Than 1 Offline TUF Keys
    • How to Increase the TUF Signature Threshold
    • Recommended Offline TUF Keys Schema
• Crypto Keys Used by FoundriesFactory at Build Time
  • Secure Boot Flow
    • i.MX Secure Boot Flow
    • UEFI Secure Boot Flow
  • FoundriesFactory Keys
    • How to Rotate the FoundriesFactory Keys
      • U-Boot Keys
      • OP-TEE Keys
      • TrustedFirmware-A Keys
      • Linux Kernel Modules Keys
• Software Bill of Materials
  • SBOMs and Builds
    • Yocto Project Artifacts
    • Syft Artifacts
  • Working With SBOMs
  • Going Further
• Waves and Production Targets
  • Suggested Flow
    • Waves Init
    • Waves Rollout
    • Waves Complete
    • Waves Cancel
    • Waves Status Summary
  • Waves Considerations
  • Production Workflow
• Details Of Device Gateway PKI Settings
  • Taking Ownership of Factory PKI Using the API
    • 1. Call the API to Generate CSRs
    • 2. Generate a Private Key and Certificate for Factory Root CA
    • 3. Optionally Generate Your Local Device CA
    • 4. Sign CSRs Received from the API
    • 5. Upload Generated Certificates to the API
  • Registering Factory Devices Using the API
• Rotating Device Certificate
  • Choosing an EST Server
    • FoundriesFactory Managed
    • User Managed
  • Performing a Certificate Rotation
    • Parameters
• Troubleshooting and FAQ
  • Errors and Solutions
    • Fioctl Errors
    • Aktualizr-Lite Common Reports
    • OTA Update Fails Because of Missing SPL Keys
    • Request Entity Too Large Error
      • Solution
    • Device Registration Common Errors
  • How Tos
    • Aktualizr-Lite and Fioconfig Polling Time
      • Option A: Changing Interval in Runtime
      • Option B: Changing Interval Included in the Build
    • Re-Register a Device
    • Read Secure Variables from Containers
    • Enable U-Boot Boot Delay
  • Tips and Abouts
    • Allowed Characters for Device Names and Tags
    • Bind Mounting a File Into a Container
    • NXP SE05X Secure Element and PKCS#11 Trusted Application
    • Debugging Network Connectivity
    • Debugging User Permissions
    • Updates To etc
    • Orphan Targets
    • Recreating Previous Targets
    • Update FoundriesFactory Manifest Merge Conflict
    • Jailhouse support in LmP is removed