Toaster: Difference between revisions

From Yocto Project
Jump to navigationJump to search
(Updated dead link to old Yocto Project 1.0 docs)
 
(44 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Toaster]]
[[Category:Toaster]]
[[Toaster]] is a web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.
[[Toaster]] is a web-based interface to OpenEmbedded and BitBake.
This project was formely known as Web Hob / Webhob / webhob, and you may still find references to the old name in the documentation.
[[File:Screenshot toaster.png|thumb|Screenshot of Toaster 2.1]]
 
General discussion about '''Toaster''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/toaster https://lists.yoctoproject.org/listinfo/toaster]
General discussion about '''Toaster''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/toaster https://lists.yoctoproject.org/listinfo/toaster]


=== Using Toaster ===
=== Using Toaster ===


* [[Setting up a local instance of Toaster]]
Toaster can run in various modes and setups.
* [[Setting up a production instance of Toaster]]
* [https://www.yoctoproject.org/documentation/toaster-manual How to use the Toaster web interface]
* [[How to delete information from the Toaster database]]


=== About Toaster ===
* '''Local mode''' - in this mode Toaster is setup for use as a local development tool. It can be used to configure builds or just as a receiver for builds done on the command line with bitbake. You can launch it like this:


* [[Contribute to Toaster]]
$ source oe-init-build-env
* [[Toaster architecture design]]
$ source toaster start
* Toaster QA
* 1.7 scope and design
* Archive


== User interface ==
You then navigate to the link in your browser (e.g. http://localhost:8000) and configure a project. Or start building in the normal way with bitbake via the command line. Toaster will automatically pick up the builds and you will be able to see them on the build dashboard in your browser.
The design of the Toaster user interface takes place in iterations, and most recent designs supersede older ones.


The latest iteration is always available at: http://www.yoctoproject.org/toaster
* '''Production mode''' - All the same functionality as the local mode but with the web server setup as a shared service for multiple developers to use, this sets up Toaster as a wsgi application and [[Setting up a production instance of Toaster|requires additional configuration]].


Detailed design documentation is attached to Bugzilla features. Features with design documentation attached have "GUI design available" written in the Whiteboard field, so it is easy to search for them.
=== Toaster How-to's ===


=== Toaster 1.7 scope and design discussions ===
Specific pages with Toaster how-tos are available below.
 
We are currently planning work for the Yocto Project 1.7 release. [[toaster 1.7 design|Get involved]].
 
== Testing ==
Documentation and results related to [[Toaster]] Quality Assurance.
 
* [[ Toaster testing plan ]]
 
== Contributing to Toaster ==
Toaster is a community effort and welcomes your contribution.  


* [[Contribute to Toaster]]
* [[Contribute to Toaster]]
* [[Testing Toaster]]
* [[Setting up a local instance of Toaster]]
* [[Setting up a production instance of Toaster]] - documentation for Interactive mode
* [https://docs.yoctoproject.org/dunfell/toaster-manual/toaster-manual-setup-and-use.html#using-the-toaster-web-interface How to use the Toaster web interface]
* [[How to delete information from the Toaster database]]
* [[How to  support permission management in Build Mode for Toaster]]
* [[ToasterTable]]: Toaster's internal API for adding sortable, filterable, paged tables


== Old page content ==
=== About Toaster ===
[[File:Screenshot toaster analyis.png|thumb|Analysis of builds using Toaster]]


=== Design documentation for the Yocto Project 1.5 and 1.6 releases ===
* [[File:Working_with_design.pdf]]
 
* [https://bugzilla.yoctoproject.org/buglist.cgi?list_id=213820&columnlist=status_whiteboard%2Cassigned_to%2Ctarget_milestone%2Cbug_status%2Cshort_desc%2Cbug_severity%2Cpriority&classification=Build%20System%20%26%20Metadata&query_based_on=Toaster-Opens&query_format=advanced&bug_status=NEW&bug_status=ACCEPTED&bug_status=IN%20PROGRESS%20DESIGN&bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&bug_status=IN%20PROGRESS%20IMPLEMENTATION&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=WaitForUpstream&component=toaster&product=Toaster&known_name=Toaster-Opens Bug list]
The document [[File:Toaster_1.6_content_structure.pdf]] shows the content structure of Toaster in the 1.6 release.
* [[Toaster architecture design]]
 
* [[Toaster and bitbake communications]]
=== Other design documentation ===
* [[Toaster database]]
* [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Toaster
* [[Toaster testing plan]]
* [[File:WH_roadmap.pdf]] - the roadmap for Toaster development produced by the London-based agency Tobias&Tobias
* [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios
* [[File:Web_Hob_content_structure.pdf]] - Toaster information architecture, as it came out from the design project with Tobias&Tobias
 
=== Old design documents ===
* [[Web_Hob_design_project_with_T%26T]] - The outcome of the design project with the external agency Tobias&Tobias
* [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]
 
This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project.
 
General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]
 
There have been 2 main pieces of work related to Web Hob so far:
 
* [[Web Hob design project with T&T|A design project with the London-based agency Tobias & Tobias]]
* [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]
 
=== Web Hob information architecture ===
 
This document represents the content structure of the Web Hob application.
 
[[File:Web_Hob_content_structure.pdf]]
 
=== Different approaches to multi-user workflows ===
 
This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob.


* [[File:Multiuser_support_in_Web_Hob.pdf]]
=== In progress documentation ===


=== Visualisations index ===
We are currently preparing the documentation for the Toaster build functionality. The content here is just a brain dump of what we need to cover (in no particular order). Feel free to add and create content as you see fit:


The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].
*[[Using virtualenv]]
*[[Setting up a production instance of Toaster]]
*[[manage.py commands]] - this should include an explanation of lsupdates
*[[Start Toaster in managed mode]]

Latest revision as of 21:51, 30 November 2023

Toaster is a web-based interface to OpenEmbedded and BitBake.

Screenshot of Toaster 2.1

General discussion about Toaster happens on a dedicated mailing list: https://lists.yoctoproject.org/listinfo/toaster

Using Toaster

Toaster can run in various modes and setups.

  • Local mode - in this mode Toaster is setup for use as a local development tool. It can be used to configure builds or just as a receiver for builds done on the command line with bitbake. You can launch it like this:
$ source oe-init-build-env
$ source toaster start

You then navigate to the link in your browser (e.g. http://localhost:8000) and configure a project. Or start building in the normal way with bitbake via the command line. Toaster will automatically pick up the builds and you will be able to see them on the build dashboard in your browser.

  • Production mode - All the same functionality as the local mode but with the web server setup as a shared service for multiple developers to use, this sets up Toaster as a wsgi application and requires additional configuration.

Toaster How-to's

Specific pages with Toaster how-tos are available below.

About Toaster

Analysis of builds using Toaster

In progress documentation

We are currently preparing the documentation for the Toaster build functionality. The content here is just a brain dump of what we need to cover (in no particular order). Feel free to add and create content as you see fit:

Retrieved from "https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&oldid=86095"