Toaster User Manual

The Yocto Project

Copyright © 2010-2020, The Linux Foundation

<docs@lists.yoctoproject.org>

Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons.

Note

• This version of this manual is for the 3.1 release of the Yocto Project. To be sure you have the latest version of the manual for this release, go to the Yocto Project documentation page and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files.

• If you located this manual through a web search, the version of the manual might not be the one you want (e.g. the search might have returned a manual much older than the Yocto Project version with which you are working). You can see all Yocto Project major releases by visiting the Releases page. If you need a version of this manual for a different Yocto Project release, visit the Yocto Project documentation page and select the manual set by using the “ACTIVE RELEASES DOCUMENTATION” or “DOCUMENTS ARCHIVE” pull-down menus.

• To report any inaccuracies or problems with this (or any other Yocto Project) manual, send an email to the Yocto Project documentation mailing list at docs@lists.yoctoproject.org or log into the freenode #yocto channel.

Revision	Date	Note
1.8	April 2015	The initial document released with the Yocto Project 1.8 Release
2.0	October 2015	Released with the Yocto Project 2.0 Release.
2.1	April 2016	Released with the Yocto Project 2.1 Release.
2.2	October 2016	Released with the Yocto Project 2.2 Release.
2.3	May 2017	Released with the Yocto Project 2.3 Release.
2.4	October 2017	Released with the Yocto Project 2.4 Release.
2.5	May 2018	Released with the Yocto Project 2.5 Release.
2.6	November 2018	Released with the Yocto Project 2.6 Release.
2.7	May 2019	Released with the Yocto Project 2.7 Release.
3.0	October 2019	Released with the Yocto Project 3.0 Release.
3.1	April 2020	Released with the Yocto Project 3.1 Release.

Table of Contents

• 1. Introduction
  • 1.1. Toaster Features
  • 1.2. Installation Options
• 2. Preparing to Use Toaster
  • 2.1. Setting Up the Basic System Requirements
  • 2.2. Establishing Toaster System Dependencies
    • 2.2.1. Install Toaster Packages
• 3. Setting Up and Using Toaster
  • 3.1. Starting Toaster for Local Development
  • 3.2. Setting a Different Port
  • 3.3. Setting Up Toaster Without a Web Server
  • 3.4. Setting Up Toaster Without a Build Server
  • 3.5. Setting up External Access
  • 3.6. The Directory for Cloning Layers
  • 3.7. The Build Directory
  • 3.8. Creating a Django Superuser
  • 3.9. Setting Up a Production Instance of Toaster
    • 3.9.1. Requirements
    • 3.9.2. Installation
  • 3.10. Using the Toaster Web Interface
    • 3.10.1. Toaster Web Interface Videos
    • 3.10.2. Additional Information About the Local Yocto Project Release
    • 3.10.3. Building a Specific Recipe Given Multiple Versions
• 4. Concepts and Reference
  • 4.1. Layer Source
    • 4.1.1. Setting Up and Using a Layer Source
      • 4.1.1.1. Understanding Your Layers
      • 4.1.1.2. Configuring Toaster to Hook Into Your Layer Index
        • 4.1.1.2.1. Use the Administration Interface
        • 4.1.1.2.2. Use the Fixture Feature
  • 4.2. Releases
    • 4.2.1. Pre-Configured Releases
  • 4.3. Configuring Toaster
    • 4.3.1. Configuring the Workflow
    • 4.3.2. Customizing Pre-Set Data
    • 4.3.3. Understanding Fixture File Format
      • 4.3.3.1. Defining the Default Distro and Other Values
      • 4.3.3.2. Defining BitBake Version
      • 4.3.3.3. Defining Release
      • 4.3.3.4. Defining the Release Default Layer Names
      • 4.3.3.5. Defining Layer Definitions
  • 4.4. Remote Toaster Monitoring
    • 4.4.1. Checking Health
    • 4.4.2. Determining Status of Builds in Progress
    • 4.4.3. Checking Status of Builds Completed
    • 4.4.4. Determining Status of a Specific Build
  • 4.5. Useful Commands
    • 4.5.1. buildslist
    • 4.5.2. builddelete
    • 4.5.3. perf
    • 4.5.4. checksettings
    • 4.5.5. runbuilds