diff options
Diffstat (limited to 'documentation')
3 files changed, 113 insertions, 98 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index 05184fa1eb..cc118643cd 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml | |||
@@ -12,19 +12,18 @@ | |||
12 | This final chapter provides conceptual information on layer sources, | 12 | This final chapter provides conceptual information on layer sources, |
13 | releases, and JSON configuration files. | 13 | releases, and JSON configuration files. |
14 | Also provided is a quick look at some useful | 14 | Also provided is a quick look at some useful |
15 | <filename>manage.py</filename> commands. | 15 | <filename>manage.py</filename> commands that are Toaster-specific. |
16 | Information on <filename>manage.py</filename> commands does exist | 16 | Information on <filename>manage.py</filename> commands does exist |
17 | across the Web and the information in this manual by no means | 17 | across the Web and the information in this manual by no means |
18 | attempts to provide a command reference. | 18 | attempts to provide a command comprehensive reference. |
19 | However, having relevant command useful for the Toaster context | ||
20 | is helpful. | ||
21 | </para> | 19 | </para> |
22 | 20 | ||
23 | <section id='layer-source'> | 21 | <section id='layer-source'> |
24 | <title>Layer Source</title> | 22 | <title>Layer Source</title> |
25 | 23 | ||
26 | <para> | 24 | <para> |
27 | In general, a layer source is some source of existing layers. | 25 | In general, a "layer source" is a source of information about |
26 | existing layers. | ||
28 | In particular, we are concerned with layers that you can use | 27 | In particular, we are concerned with layers that you can use |
29 | with the Yocto Project and Toaster. | 28 | with the Yocto Project and Toaster. |
30 | This chapter describes a particular type of layer source called | 29 | This chapter describes a particular type of layer source called |
@@ -145,7 +144,7 @@ | |||
145 | </section> | 144 | </section> |
146 | 145 | ||
147 | <section id='select-the-toasterconf-json-file'> | 146 | <section id='select-the-toasterconf-json-file'> |
148 | <title>Select the <filename>toasterconf.json</filename> File</title> | 147 | <title>Select for Use the <filename>toasterconf.json</filename> File</title> |
149 | 148 | ||
150 | <para> | 149 | <para> |
151 | If you do not want to use the Administration | 150 | If you do not want to use the Administration |
@@ -155,8 +154,8 @@ | |||
155 | </para> | 154 | </para> |
156 | 155 | ||
157 | <para> | 156 | <para> |
158 | When you set up Toaster in Build Mode, you are prompted to | 157 | When you set up Toaster in Build Mode, you are prompted |
159 | select a Toaster configuration file. | 158 | to select a Toaster configuration file. |
160 | This configuration file is used to set up the initial | 159 | This configuration file is used to set up the initial |
161 | configuration values within the Toaster database | 160 | configuration values within the Toaster database |
162 | including the layer sources. | 161 | including the layer sources. |
@@ -309,9 +308,8 @@ | |||
309 | $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-yocto/conf/toasterconf.json | 308 | $ bitbake/lib/toaster/manage.py loadconf /home/scottrif/poky/meta-yocto/conf/toasterconf.json |
310 | </literallayout> | 309 | </literallayout> |
311 | After entering this command, you need to update the | 310 | After entering this command, you need to update the |
312 | information from the layer index to populate the | 311 | Toaster database with the information coming from your |
313 | Toaster database with the information from your layer | 312 | new layer source. |
314 | index. | ||
315 | To do that, you should run the | 313 | To do that, you should run the |
316 | "<filename>lsupdates</filename>" command from the directory | 314 | "<filename>lsupdates</filename>" command from the directory |
317 | that contains the Toaster database. | 315 | that contains the Toaster database. |
@@ -329,7 +327,7 @@ | |||
329 | information is available by using the Toaster web interface. | 327 | information is available by using the Toaster web interface. |
330 | To do that, visit the "All compatible layers" page inside a | 328 | To do that, visit the "All compatible layers" page inside a |
331 | Toaster project. | 329 | Toaster project. |
332 | The layers from your layer index should be listed there. | 330 | The layers from your layer source should be listed there. |
333 | </para> | 331 | </para> |
334 | </section> | 332 | </section> |
335 | </section> | 333 | </section> |
@@ -340,6 +338,8 @@ | |||
340 | <title>Releases</title> | 338 | <title>Releases</title> |
341 | 339 | ||
342 | <para> | 340 | <para> |
341 | When you create a Toaster project using the web interface, | ||
342 | you are asked to choose a "Release." | ||
343 | In the context of Toaster, the term "Release" refers to a set of | 343 | In the context of Toaster, the term "Release" refers to a set of |
344 | layers and a BitBake version the OpenEmbedded build system uses | 344 | layers and a BitBake version the OpenEmbedded build system uses |
345 | to build something. | 345 | to build something. |
@@ -347,8 +347,6 @@ | |||
347 | correspond to Yocto Project release branches. | 347 | correspond to Yocto Project release branches. |
348 | However, you can modify, delete, and create new releases | 348 | However, you can modify, delete, and create new releases |
349 | according to your needs. | 349 | according to your needs. |
350 | When you create a Toaster project using the web interface, | ||
351 | you are asked to choose a "Release." | ||
352 | This section provides some background information on releases. | 350 | This section provides some background information on releases. |
353 | </para> | 351 | </para> |
354 | 352 | ||
@@ -461,7 +459,7 @@ | |||
461 | This name is never exposed through Toaster. | 459 | This name is never exposed through Toaster. |
462 | </para></listitem> | 460 | </para></listitem> |
463 | <listitem><para><emphasis>Git URL:</emphasis> | 461 | <listitem><para><emphasis>Git URL:</emphasis> |
464 | The URL <filename>giturl</filename> | 462 | The URL (<filename>giturl</filename>) |
465 | for the BitBake Git repository cloned | 463 | for the BitBake Git repository cloned |
466 | for Toaster projects. | 464 | for Toaster projects. |
467 | </para></listitem> | 465 | </para></listitem> |
@@ -493,9 +491,6 @@ | |||
493 | (<filename>defaultlayers</filename>) automatically | 491 | (<filename>defaultlayers</filename>) automatically |
494 | added to the project configuration when a project is | 492 | added to the project configuration when a project is |
495 | created. | 493 | created. |
496 | You can download the recommended configuration | ||
497 | for this case from | ||
498 | <ulink url='&YOCTO_WIKI_URL;/wiki/File:Toasterconf.json.txt.patch'></ulink>. | ||
499 | </para></listitem> | 494 | </para></listitem> |
500 | <listitem><para><emphasis>Layer Source Priorities</emphasis> | 495 | <listitem><para><emphasis>Layer Source Priorities</emphasis> |
501 | A specification of | 496 | A specification of |
@@ -522,9 +517,11 @@ | |||
522 | <para> | 517 | <para> |
523 | To summarize what comprises a release, consider the following | 518 | To summarize what comprises a release, consider the following |
524 | example from a Toaster JSON file. | 519 | example from a Toaster JSON file. |
525 | The configuration names the release "master" and sets it to | 520 | The configuration names the release "master" and uses the |
526 | use the master branch of the | 521 | "master" branch provided by the layer source of type |
527 | <filename>openembedded-core</filename> layer. | 522 | "layerindex", which is called "OpenEmbedded", and sets |
523 | the <filename>openembedded-core</filename> layer as the one | ||
524 | to be added by default to any projects created in Toaster. | ||
528 | The BitBake version used would be defined as shown earlier | 525 | The BitBake version used would be defined as shown earlier |
529 | in the previous list: | 526 | in the previous list: |
530 | <literallayout class='monospaced'> | 527 | <literallayout class='monospaced'> |
@@ -548,13 +545,13 @@ | |||
548 | <title>JSON Files</title> | 545 | <title>JSON Files</title> |
549 | 546 | ||
550 | <para> | 547 | <para> |
551 | If you are going to be using the Toaster in Build Mode, it must | 548 | If you are going to be using Toaster in Build Mode, it must |
552 | be initially configured before use. | 549 | be initially configured before use. |
553 | Configuration customizes layer source settings and Toaster defaults | 550 | Configuration customizes layer source settings and Toaster defaults |
554 | for all users and is performed by the person responsible for | 551 | for all users and is performed by the person responsible for |
555 | Toaster Configuration (i.e the Toaster Administrator). | 552 | Toaster Configuration (i.e the Toaster Administrator). |
556 | The Toaster Administrator performs this configuration through the | 553 | The Toaster Administrator performs this configuration through the |
557 | admin web interface. | 554 | Django administration interface. |
558 | </para> | 555 | </para> |
559 | 556 | ||
560 | <para> | 557 | <para> |
@@ -575,10 +572,10 @@ | |||
575 | <filename>toasterconf.json</filename>. | 572 | <filename>toasterconf.json</filename>. |
576 | The Toaster Administrator can customize the file prior to loading | 573 | The Toaster Administrator can customize the file prior to loading |
577 | it into Toaster. | 574 | it into Toaster. |
578 | In the Local Toaster Build Mode, the system startup script | 575 | When you set up Toaster locally to run in Build Mode, the system |
579 | actively looks for compatible configuration files and prompts | 576 | startup script actively looks for compatible configuration files |
580 | you to select a file to load if it detects that the database has | 577 | and prompts you to select a file to load if it detects that the |
581 | not been configured. | 578 | database has not been configured. |
582 | </para> | 579 | </para> |
583 | 580 | ||
584 | <section id='json-file-choices'> | 581 | <section id='json-file-choices'> |
@@ -630,7 +627,7 @@ | |||
630 | <para> | 627 | <para> |
631 | The <filename>toasterconf.json</filename> file consists of | 628 | The <filename>toasterconf.json</filename> file consists of |
632 | easily readable areas: configuration, layer sources, BitBake, | 629 | easily readable areas: configuration, layer sources, BitBake, |
633 | default, and releases. | 630 | default release, and releases. |
634 | </para> | 631 | </para> |
635 | 632 | ||
636 | <section id='json-config-area'> | 633 | <section id='json-config-area'> |
@@ -760,8 +757,13 @@ | |||
760 | <para> | 757 | <para> |
761 | This area of the JSON file defines the version of | 758 | This area of the JSON file defines the version of |
762 | BitBake Toaster uses. | 759 | BitBake Toaster uses. |
763 | As shipped, Toaster is configured to recognize three | 760 | As shipped, Toaster is configured to recognize four |
764 | versions of BitBake: master, dizzy, and HEAD. | 761 | versions of BitBake: master, dizzy, and HEAD. |
762 | <note> | ||
763 | HEAD is a special option that builds whatever is | ||
764 | available on disk, without checking out any remote | ||
765 | Git repositories. | ||
766 | </note> | ||
765 | </para> | 767 | </para> |
766 | 768 | ||
767 | <para> | 769 | <para> |
@@ -937,14 +939,16 @@ | |||
937 | using the | 939 | using the |
938 | <link linkend='toaster-command-builddelete'><filename>builddelete</filename></link> | 940 | <link linkend='toaster-command-builddelete'><filename>builddelete</filename></link> |
939 | command. | 941 | command. |
940 | For example, assuming default repository and build directory | 942 | Here is an example that assumes default repository and build |
941 | names, the following two commands put you in the | 943 | directory names: |
942 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
943 | and then return a list of the current builds, which would | ||
944 | be one in this case: | ||
945 | <literallayout class='monospaced'> | 944 | <literallayout class='monospaced'> |
946 | $ cd $HOME/poky/build | 945 | $ cd ~/poky/build |
947 | $ python ../bitbake/lib/toaster/manage.py buildslist | 946 | $ python ../bitbake/lib/toaster/manage.py buildslist |
947 | </literallayout> | ||
948 | If your Toaster database had only one build, the above | ||
949 | <filename>buildslist</filename> command would return something | ||
950 | like the following: | ||
951 | <literallayout class='monospaced'> | ||
948 | 1: qemux86 poky core-image-minimal | 952 | 1: qemux86 poky core-image-minimal |
949 | </literallayout> | 953 | </literallayout> |
950 | </para> | 954 | </para> |
@@ -1000,7 +1004,7 @@ | |||
1000 | <literallayout class='monospaced'> | 1004 | <literallayout class='monospaced'> |
1001 | $ bitbake/lib/toaster/manage.py checksettings | 1005 | $ bitbake/lib/toaster/manage.py checksettings |
1002 | </literallayout> | 1006 | </literallayout> |
1003 | In Managed Mode, Toaster uses settings that are based on the | 1007 | In Build Mode, Toaster uses settings that are based on the |
1004 | database to configure the building tasks. | 1008 | database to configure the building tasks. |
1005 | The <filename>checksettings</filename> command verifies that | 1009 | The <filename>checksettings</filename> command verifies that |
1006 | the database settings are valid in the sense that they have | 1010 | the database settings are valid in the sense that they have |
@@ -1026,8 +1030,8 @@ | |||
1026 | <title><filename>loadconf</filename></title> | 1030 | <title><filename>loadconf</filename></title> |
1027 | 1031 | ||
1028 | <para> | 1032 | <para> |
1029 | The <filename>loadconf</filename> command loads a Toaster | 1033 | The <filename>loadconf</filename> command loads an |
1030 | configuration file (JSON file). | 1034 | existing Toaster configuration file (JSON file). |
1031 | You must run this on a new database that does not have any | 1035 | You must run this on a new database that does not have any |
1032 | data. | 1036 | data. |
1033 | Running this command on an existing database that has data | 1037 | Running this command on an existing database that has data |
@@ -1037,8 +1041,8 @@ | |||
1037 | $ bitbake/lib/toaster/manage.py loadconf <replaceable>filepath</replaceable> | 1041 | $ bitbake/lib/toaster/manage.py loadconf <replaceable>filepath</replaceable> |
1038 | </literallayout> | 1042 | </literallayout> |
1039 | The <filename>loadconf</filename> command configures a database | 1043 | The <filename>loadconf</filename> command configures a database |
1040 | based on the supplied <filename>toasterconf.json</filename> | 1044 | based on the supplied existing |
1041 | file. | 1045 | <filename>toasterconf.json</filename> file. |
1042 | For information on the <filename>toasterconf.json</filename>, | 1046 | For information on the <filename>toasterconf.json</filename>, |
1043 | see the | 1047 | see the |
1044 | "<link linkend='toaster-json-files'>JSON Files</link>" | 1048 | "<link linkend='toaster-json-files'>JSON Files</link>" |
@@ -1050,7 +1054,7 @@ | |||
1050 | <title><filename>runbuilds</filename></title> | 1054 | <title><filename>runbuilds</filename></title> |
1051 | 1055 | ||
1052 | <para> | 1056 | <para> |
1053 | The <filename>runbuilds</filename> command launched | 1057 | The <filename>runbuilds</filename> command launches |
1054 | scheduled builds. | 1058 | scheduled builds. |
1055 | Access the command as follows: | 1059 | Access the command as follows: |
1056 | <literallayout class='monospaced'> | 1060 | <literallayout class='monospaced'> |
@@ -1061,8 +1065,8 @@ | |||
1061 | per schedule. | 1065 | per schedule. |
1062 | The command returns after the builds start but before they | 1066 | The command returns after the builds start but before they |
1063 | complete. | 1067 | complete. |
1064 | The "toasterui" build recorded updates the database when the | 1068 | The Toaster Logging Interface records and updates the database |
1065 | builds complete. | 1069 | when the builds complete. |
1066 | </para> | 1070 | </para> |
1067 | </section> | 1071 | </section> |
1068 | </section> | 1072 | </section> |
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 @@ | |||
209 | you install and set up a front-end web server. | 209 | you install and set up a front-end web server. |
210 | This server allows for load balancing and | 210 | This server allows for load balancing and |
211 | multi-threading over Toaster and | 211 | multi-threading over Toaster and |
212 | <filename>django</filename> WSGI. | 212 | <ulink url='https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/'><filename>django</filename> WSGI</ulink>. |
213 | Here is an example that uses Apache web server. | 213 | Here is an example that uses Apache web server. |
214 | <literallayout class='monospaced'> | 214 | <literallayout class='monospaced'> |
215 | $ apt-get install apache2 libapache2-mod-wsgi | 215 | $ apt-get install apache2 libapache2-mod-wsgi |
@@ -282,19 +282,41 @@ | |||
282 | </para></listitem> | 282 | </para></listitem> |
283 | <listitem><para><emphasis>Enable Build Logging to the Common SQL Server for Each Build Directory you are Using:</emphasis> | 283 | <listitem><para><emphasis>Enable Build Logging to the Common SQL Server for Each Build Directory you are Using:</emphasis> |
284 | In the Build Directory, create the required | 284 | In the Build Directory, create the required |
285 | <filename>conf/toaster.conf</filename> file as | 285 | <filename>conf/toaster.conf</filename> file by doing |
286 | described in | 286 | the following: |
287 | <ulink url='https://wiki.yoctoproject.org/wiki/Setting_up_a_local_instance_of_Toaster'>BitBake Extra Options</ulink>. | 287 | <note> |
288 | Briefly, for each Build Directory, you need to inherit | 288 | The following statements are automatically added |
289 | the | 289 | to the <filename>toaster.conf</filename> file |
290 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-toaster'>toaster</ulink> | 290 | when Toaster starts through the |
291 | class by setting the following in your | 291 | <filename>toaster start</filename> command. |
292 | <filename>local.conf</filename> configuration file: | 292 | </note> |
293 | <literallayout class='monospaced'> | 293 | <itemizedlist> |
294 | <listitem><para> | ||
295 | Be sure that Toaster inherits the | ||
296 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-toaster'><filename>toaster</filename></ulink> | ||
297 | class and it is enabled in Bitbake in order to | ||
298 | record target image package information: | ||
299 | <literallayout class='monospaced'> | ||
294 | INHERIT += "toaster" | 300 | INHERIT += "toaster" |
301 | </literallayout> | ||
302 | </para></listitem> | ||
303 | <listitem><para> | ||
304 | Enable build history in BitBake. | ||
305 | Build history is needed to record target image | ||
306 | package information: | ||
307 | <literallayout class='monospaced'> | ||
295 | INHERIT += "buildhistory" | 308 | INHERIT += "buildhistory" |
296 | BUILDHISTORY_COMMIT = "1" | 309 | BUILDHISTORY_COMMIT = "1" |
297 | </literallayout> | 310 | </literallayout> |
311 | This last command is not strictly needed. | ||
312 | However, without it build history will not | ||
313 | properly work. | ||
314 | For information on build history, see the | ||
315 | "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" | ||
316 | section in the Yocto Project Development | ||
317 | Manual. | ||
318 | </para></listitem> | ||
319 | </itemizedlist> | ||
298 | You also need to point to the database. | 320 | You also need to point to the database. |
299 | You can do this by exporting the | 321 | You can do this by exporting the |
300 | <filename>DATABASE_URL</filename> variable as follows: | 322 | <filename>DATABASE_URL</filename> variable as follows: |
@@ -434,8 +456,7 @@ | |||
434 | Toaster configuration file. | 456 | Toaster configuration file. |
435 | Toaster configurations are stored in | 457 | Toaster configurations are stored in |
436 | JSON files called | 458 | JSON files called |
437 | <filename>toasterconf.json</filename> and supports | 459 | <filename>toasterconf.json</filename>. |
438 | several types. | ||
439 | For information on JSON files, see the | 460 | For information on JSON files, see the |
440 | "<link linkend='toaster-json-files'>JSON Files</link>" | 461 | "<link linkend='toaster-json-files'>JSON Files</link>" |
441 | section.</para> | 462 | section.</para> |
@@ -498,27 +519,6 @@ | |||
498 | MANAGED="True" | 519 | MANAGED="True" |
499 | </literallayout> | 520 | </literallayout> |
500 | </para></listitem> | 521 | </para></listitem> |
501 | <listitem><para><emphasis>Configure the Build Environment:</emphasis> | ||
502 | Configure the build environment by running the | ||
503 | following: | ||
504 | <literallayout class='monospaced'> | ||
505 | bitbake/lib/toaster/manage.py checksettings | ||
506 | </literallayout> | ||
507 | For reference information on Toaster-specific | ||
508 | <filename>manage.py</filename> commands, see the | ||
509 | "<link linkend='toaster-useful-commands'>Useful Commands</link>" | ||
510 | section. | ||
511 | </para></listitem> | ||
512 | <listitem><para><emphasis>Load a Configuration File:</emphasis> | ||
513 | Load a configuration file by running the following: | ||
514 | <literallayout class='monospaced'> | ||
515 | bitbake/lib/toaster/manage.py loadconf <replaceable>path-to-toasterconf.json-file</replaceable> | ||
516 | </literallayout> | ||
517 | For reference information on Toaster-specific | ||
518 | <filename>manage.py</filename> commands, see the | ||
519 | "<link linkend='toaster-useful-commands'>Useful Commands</link>" | ||
520 | section. | ||
521 | </para></listitem> | ||
522 | <listitem><para><emphasis>Set Up Toaster for Normal Usage:</emphasis> | 522 | <listitem><para><emphasis>Set Up Toaster for Normal Usage:</emphasis> |
523 | You need to configure each build environment, layer | 523 | You need to configure each build environment, layer |
524 | sources, and BitBake versions.</para> | 524 | sources, and BitBake versions.</para> |
@@ -675,7 +675,7 @@ | |||
675 | build artifacts, downloading sources, and running | 675 | build artifacts, downloading sources, and running |
676 | builds. | 676 | builds. |
677 | All three directories need to be writable by | 677 | All three directories need to be writable by |
678 | the "poky" user. | 678 | the user, which is "poky" in this example. |
679 | The build artifacts directory needs to readable by the | 679 | The build artifacts directory needs to readable by the |
680 | apache user. | 680 | apache user. |
681 | You also need free disk space in the range of | 681 | You also need free disk space in the range of |
@@ -688,33 +688,42 @@ | |||
688 | </literallayout> | 688 | </literallayout> |
689 | </para></listitem> | 689 | </para></listitem> |
690 | <listitem><para><emphasis>Set Up the <filename>toasterconf.json</filename> File:</emphasis> | 690 | <listitem><para><emphasis>Set Up the <filename>toasterconf.json</filename> File:</emphasis> |
691 | Download the <filename>toasterconf.json</filename> file | 691 | <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>Download the hosted <filename>toasterconf.json</filename> file</ulink> |
692 | from the | 692 | from the Yocto Project wiki and edit it to suit your |
693 | <ulink url='https://wiki.yoctoproject.org/wiki/File:Toasterconf.json.txt.patch'>File:Toasterconf.json.txt.patch</ulink> | 693 | environment. |
694 | wiki page and edit it to suit your environment. | ||
695 | For information on the relevant sections of the file, | 694 | For information on the relevant sections of the file, |
696 | see the | 695 | see the |
697 | "<link linkend='toaster-json-files'>JSON Files</link>" | 696 | "<link linkend='toaster-json-files'>JSON Files</link>" |
697 | section.</para> | ||
698 | <para>After editing the file, load it by running | ||
699 | the following: | ||
700 | <literallayout class='monospaced'> | ||
701 | $ bitbake/lib/toaster/manage.py loadconf path-to-toasterconf.json-file | ||
702 | </literallayout> | ||
703 | For reference information on Toaster-specific | ||
704 | <filename>manage.py</filename>, see the | ||
705 | "<link linkend='toaster-useful-commands'>Useful Commands</link>" | ||
698 | section. | 706 | section. |
699 | </para></listitem> | 707 | </para></listitem> |
700 | <listitem><para><emphasis>Check the Toaster Settings:</emphasis> | 708 | <listitem><para><emphasis>Check the Toaster Settings:</emphasis> |
701 | You can check the Toaster settings by running this | 709 | Configure the build environment by running the |
702 | command: | 710 | following: |
703 | <literallayout class='monospaced'> | 711 | <literallayout class='monospaced'> |
704 | $ bitbake/lib/toaster/manage.py checksettings | 712 | $ bitbake/lib/toaster/manage.py checksettings |
705 | </literallayout> | 713 | </literallayout> |
706 | When prompted, paste in the directory paths created | 714 | When prompted, paste in the directory paths created |
707 | previously during Step 9. | 715 | previously during Step 7. |
708 | Alternatively, you can select the edited | 716 | For reference information on Toaster-specific |
709 | <filename>toasterconf.json</filename> file set up in | 717 | <filename>manage.py</filename>, see the |
710 | Step 5. | 718 | "<link linkend='toaster-useful-commands'>Useful Commands</link>" |
719 | section. | ||
711 | </para></listitem> | 720 | </para></listitem> |
712 | <listitem><para><emphasis>Install and Set Up the Web Server:</emphasis> | 721 | <listitem><para><emphasis>Install and Set Up the Web Server:</emphasis> |
713 | For a production environment, it is recommended that | 722 | For a production environment, it is recommended that |
714 | you install and set up a front-end web server. | 723 | you install and set up a front-end web server. |
715 | This server allows for load balancing and | 724 | This server allows for load balancing and |
716 | multi-threading over Toaster and | 725 | multi-threading over Toaster and |
717 | <filename>django</filename> WSGI. | 726 | <ulink url='https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/'><filename>django</filename> WSGI</ulink>. |
718 | Here is an example that uses Apache web server: | 727 | Here is an example that uses Apache web server: |
719 | <literallayout class='monospaced'> | 728 | <literallayout class='monospaced'> |
720 | $ apt-get install apache2 libapache2-mod-wsgi | 729 | $ apt-get install apache2 libapache2-mod-wsgi |
@@ -764,7 +773,7 @@ | |||
764 | </literallayout> | 773 | </literallayout> |
765 | </para></listitem> | 774 | </para></listitem> |
766 | <listitem><para><emphasis>Start Toaster:</emphasis> | 775 | <listitem><para><emphasis>Start Toaster:</emphasis> |
767 | Synchronize the databases for toaster, and then start | 776 | Synchronize the databases for Toaster, and then start |
768 | up the web server. | 777 | up the web server. |
769 | Here is an example that continues with the assumed | 778 | Here is an example that continues with the assumed |
770 | components from the previous steps: | 779 | components from the previous steps: |
@@ -803,13 +812,13 @@ | |||
803 | <listitem><para><emphasis>Open the Browser:</emphasis> | 812 | <listitem><para><emphasis>Open the Browser:</emphasis> |
804 | Once the Apache server is running, connect to it with | 813 | Once the Apache server is running, connect to it with |
805 | your favorite browser and verify that the Toaster | 814 | your favorite browser and verify that the Toaster |
806 | interface comes up. | 815 | interface comes up: |
807 | You can track accesses and errors in the Apache | ||
808 | service logs: | ||
809 | <literallayout class='monospaced'> | 816 | <literallayout class='monospaced'> |
810 | http://localhost:8000/toastergui | 817 | http://localhost:8000/toastergui |
811 | </literallayout> | 818 | </literallayout> |
812 | You can now use the Toaster web interface. | 819 | You can now use the Toaster web interface to do thing |
820 | such as track accesses and errors in the Apache | ||
821 | service logs. | ||
813 | </para></listitem> | 822 | </para></listitem> |
814 | </orderedlist> | 823 | </orderedlist> |
815 | </para> | 824 | </para> |
@@ -823,8 +832,10 @@ | |||
823 | The Toaster web interface allows you to do the following: | 832 | The Toaster web interface allows you to do the following: |
824 | <itemizedlist> | 833 | <itemizedlist> |
825 | <listitem><para> | 834 | <listitem><para> |
826 | Browse all OpenEmbedded layers available for your | 835 | Browse published layers in the |
827 | selected version of the build system | 836 | <ulink url='http://layers.openembedded.org'>OpenEmbedded Metadata Index</ulink> |
837 | that are available for your selected version of the build | ||
838 | system. | ||
828 | </para></listitem> | 839 | </para></listitem> |
829 | <listitem><para> | 840 | <listitem><para> |
830 | Import your own layers for building. | 841 | Import your own layers for building. |
diff --git a/documentation/toaster-manual/toaster-manual.xml b/documentation/toaster-manual/toaster-manual.xml index 7371ca2b8d..b53277fa69 100644 --- a/documentation/toaster-manual/toaster-manual.xml +++ b/documentation/toaster-manual/toaster-manual.xml | |||
@@ -33,7 +33,7 @@ | |||
33 | <revhistory> | 33 | <revhistory> |
34 | <revision> | 34 | <revision> |
35 | <revnumber>1.8</revnumber> | 35 | <revnumber>1.8</revnumber> |
36 | <date>Sometime in 2015</date> | 36 | <date>October 2015</date> |
37 | <revremark>Released with the Yocto Project 1.8 Release.</revremark> | 37 | <revremark>Released with the Yocto Project 1.8 Release.</revremark> |
38 | </revision> | 38 | </revision> |
39 | </revhistory> | 39 | </revhistory> |
@@ -51,7 +51,7 @@ | |||
51 | <note> | 51 | <note> |
52 | For the latest version of this manual associated with this | 52 | For the latest version of this manual associated with this |
53 | Yocto Project release, see the | 53 | Yocto Project release, see the |
54 | <ulink url='&YOCTO_DOCS_ADT_URL;'>Toaster User Manual</ulink> | 54 | <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink> |
55 | from the Yocto Project website. | 55 | from the Yocto Project website. |
56 | </note> | 56 | </note> |
57 | 57 | ||