From d5abcfb25877d8dbc71e3c57a476b696d980cc99 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 1 Apr 2015 14:45:56 -0700 Subject: toaster-manual: Applied final review edits. This should be it unless there are late coming comments. (From yocto-docs rev: cb32e3330a6fe2d26425f8765689749afcd989e9) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../toaster-manual-setup-and-use.xml | 117 +++++++++++---------- 1 file changed, 64 insertions(+), 53 deletions(-) (limited to 'documentation/toaster-manual/toaster-manual-setup-and-use.xml') diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index bed38508ff..2a32912e38 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml @@ -209,7 +209,7 @@ you install and set up a front-end web server. This server allows for load balancing and multi-threading over Toaster and - django WSGI. + django WSGI. Here is an example that uses Apache web server. $ apt-get install apache2 libapache2-mod-wsgi @@ -282,19 +282,41 @@ Enable Build Logging to the Common SQL Server for Each Build Directory you are Using: In the Build Directory, create the required - conf/toaster.conf file as - described in - BitBake Extra Options. - Briefly, for each Build Directory, you need to inherit - the - toaster - class by setting the following in your - local.conf configuration file: - + conf/toaster.conf file by doing + the following: + + The following statements are automatically added + to the toaster.conf file + when Toaster starts through the + toaster start command. + + + + Be sure that Toaster inherits the + toaster + class and it is enabled in Bitbake in order to + record target image package information: + INHERIT += "toaster" + + + + Enable build history in BitBake. + Build history is needed to record target image + package information: + INHERIT += "buildhistory" BUILDHISTORY_COMMIT = "1" - + + This last command is not strictly needed. + However, without it build history will not + properly work. + For information on build history, see the + "Maintaining Build Output Quality" + section in the Yocto Project Development + Manual. + + You also need to point to the database. You can do this by exporting the DATABASE_URL variable as follows: @@ -434,8 +456,7 @@ Toaster configuration file. Toaster configurations are stored in JSON files called - toasterconf.json and supports - several types. + toasterconf.json. For information on JSON files, see the "JSON Files" section. @@ -498,27 +519,6 @@ MANAGED="True" - Configure the Build Environment: - Configure the build environment by running the - following: - - bitbake/lib/toaster/manage.py checksettings - - For reference information on Toaster-specific - manage.py commands, see the - "Useful Commands" - section. - - Load a Configuration File: - Load a configuration file by running the following: - - bitbake/lib/toaster/manage.py loadconf path-to-toasterconf.json-file - - For reference information on Toaster-specific - manage.py commands, see the - "Useful Commands" - section. - Set Up Toaster for Normal Usage: You need to configure each build environment, layer sources, and BitBake versions. @@ -675,7 +675,7 @@ build artifacts, downloading sources, and running builds. All three directories need to be writable by - the "poky" user. + the user, which is "poky" in this example. The build artifacts directory needs to readable by the apache user. You also need free disk space in the range of @@ -688,33 +688,42 @@ Set Up the toasterconf.json File: - Download the toasterconf.json file - from the - File:Toasterconf.json.txt.patch - wiki page and edit it to suit your environment. + Download the hosted toasterconf.json file + from the Yocto Project wiki and edit it to suit your + environment. For information on the relevant sections of the file, see the "JSON Files" + section. + After editing the file, load it by running + the following: + + $ bitbake/lib/toaster/manage.py loadconf path-to-toasterconf.json-file + + For reference information on Toaster-specific + manage.py, see the + "Useful Commands" section. Check the Toaster Settings: - You can check the Toaster settings by running this - command: + Configure the build environment by running the + following: $ bitbake/lib/toaster/manage.py checksettings When prompted, paste in the directory paths created - previously during Step 9. - Alternatively, you can select the edited - toasterconf.json file set up in - Step 5. + previously during Step 7. + For reference information on Toaster-specific + manage.py, see the + "Useful Commands" + section. Install and Set Up the Web Server: For a production environment, it is recommended that you install and set up a front-end web server. This server allows for load balancing and multi-threading over Toaster and - django WSGI. + django WSGI. Here is an example that uses Apache web server: $ apt-get install apache2 libapache2-mod-wsgi @@ -764,7 +773,7 @@ Start Toaster: - Synchronize the databases for toaster, and then start + Synchronize the databases for Toaster, and then start up the web server. Here is an example that continues with the assumed components from the previous steps: @@ -803,13 +812,13 @@ Open the Browser: Once the Apache server is running, connect to it with your favorite browser and verify that the Toaster - interface comes up. - You can track accesses and errors in the Apache - service logs: + interface comes up: http://localhost:8000/toastergui - You can now use the Toaster web interface. + You can now use the Toaster web interface to do thing + such as track accesses and errors in the Apache + service logs. @@ -823,8 +832,10 @@ The Toaster web interface allows you to do the following: - Browse all OpenEmbedded layers available for your - selected version of the build system + Browse published layers in the + OpenEmbedded Metadata Index + that are available for your selected version of the build + system. Import your own layers for building. -- cgit v1.2.3-54-g00ecf