diff options
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-setup-and-use.xml')
| -rw-r--r-- | documentation/toaster-manual/toaster-manual-setup-and-use.xml | 117 |
1 files changed, 64 insertions, 53 deletions
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. |
