Toaster: Difference between revisions
From Yocto Project
Jump to navigationJump to search
(Updated dead link to old Yocto Project 1.0 docs) |
|||
| (25 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Toaster]] | [[Category:Toaster]] | ||
[[Toaster]] is a web-based interface to OpenEmbedded and BitBake. | [[Toaster]] is a web-based interface to OpenEmbedded and BitBake. | ||
[[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 === | ||
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 [[Setting up a production instance of Toaster|requires additional configuration]]. | |||
=== Toaster How-to's === | |||
Specific pages with Toaster how-tos are available below. | |||
* [[Contribute to Toaster]] | |||
* [[Testing Toaster]] | |||
* [[Setting up a local instance of Toaster]] | * [[Setting up a local instance of Toaster]] | ||
* [[Setting up a production instance of Toaster]] | * [[Setting up a production instance of Toaster]] - documentation for Interactive mode | ||
* [https:// | * [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 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 | |||
=== About Toaster === | === About Toaster === | ||
[[File:Screenshot toaster analyis.png|thumb|Analysis of builds using Toaster]] | |||
* [[ | * [[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] | * [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] | ||
* [[Toaster architecture design]] | * [[Toaster architecture design]] | ||
* [[Toaster and bitbake communications]] | |||
* [[Toaster database]] | |||
* [[Toaster testing plan]] | * [[Toaster testing plan]] | ||
=== In progress documentation === | === In progress documentation === | ||
| Line 25: | Line 45: | ||
*[[Using virtualenv]] | *[[Using virtualenv]] | ||
*[[ | *[[Setting up a production instance of Toaster]] | ||
*[[manage.py commands]] - this should include an explanation of lsupdates | *[[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.
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.
- Contribute to Toaster
- Testing Toaster
- Setting up a local instance of Toaster
- Setting up a production instance of Toaster - documentation for Interactive mode
- 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
About Toaster
- File:Working with design.pdf
- Bug list
- Toaster architecture design
- Toaster and bitbake communications
- Toaster database
- Toaster testing plan
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:
- Using virtualenv
- Setting up a production instance of Toaster
- manage.py commands - this should include an explanation of lsupdates
- Start Toaster in managed mode
