toaster-manual: Explain the local release
The fact that the Local Yocto Project release does not provide any compatible layers confuses people. Add a section about the local release to explain what it does. [YOCTO #9229] (From yocto-docs rev: cc7ebcd5a66ff3041a7fdd17e697dfb60b08cadd) Signed-off-by: Belen <belen@icarus.isw.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
d06c7b8ce6
commit
00fe95d133
Binary file not shown.
After Width: | Height: | Size: 159 KiB |
Binary file not shown.
After Width: | Height: | Size: 136 KiB |
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
|
@ -115,451 +115,515 @@
|
||||||
To access the Django administration interface, you must
|
To access the Django administration interface, you must
|
||||||
create a superuser by following these steps:
|
create a superuser by following these steps:
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
If you used <filename>virtualenv</filename>, which is
|
If you used <filename>virtualenv</filename>, which is
|
||||||
recommended, to set up the Toaster system dependencies,
|
recommended, to set up the Toaster system dependencies,
|
||||||
you need be sure the virtual environment is activated.
|
you need be sure the virtual environment is activated.
|
||||||
To activate this environment, use the following:
|
To activate this environment, use the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ source venv/bin/activate
|
$ source venv/bin/activate
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
From the directory containing the Toaster database,
|
From the directory containing the Toaster database,
|
||||||
which by default is the
|
which by default is the
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
|
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
|
||||||
invoke the <filename>createsuperuser</filename> command
|
invoke the <filename>createsuperuser</filename> command
|
||||||
from <filename>manage.py</filename>:
|
from <filename>manage.py</filename>:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ cd ~/poky/build
|
$ cd ~/poky/build
|
||||||
$ ../bitbake/lib/toaster/manage.py createsuperuser
|
$ ../bitbake/lib/toaster/manage.py createsuperuser
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Django prompts you for the username, which you need to
|
Django prompts you for the username, which you need to
|
||||||
provide.
|
provide.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Django prompts you for an email address, which is
|
Django prompts you for an email address, which is
|
||||||
optional.
|
optional.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Django prompts you for a password, which you must provide.
|
Django prompts you for a password, which you must provide.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Django prompts you to re-enter your password for verification.
|
Django prompts you to re-enter your password for verification.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
After completing these steps, the following confirmation message
|
After completing these steps, the following confirmation message
|
||||||
appears:
|
appears:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
Superuser created successfully.
|
Superuser created successfully.
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Creating a superuser allows you to access the Django administration
|
Creating a superuser allows you to access the Django administration
|
||||||
interface through a browser.
|
interface through a browser.
|
||||||
The URL for this interface is the same as the URL used for the
|
The URL for this interface is the same as the URL used for the
|
||||||
Toaster instance with "/admin" on the end.
|
Toaster instance with "/admin" on the end.
|
||||||
For example, if you are running Toaster locally, use the
|
For example, if you are running Toaster locally, use the
|
||||||
following URL:
|
following URL:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
http://127.0.0.1:8000/admin
|
http://127.0.0.1:8000/admin
|
||||||
</literallayout>
|
</literallayout>
|
||||||
You can use the Django administration interface to set Toaster
|
You can use the Django administration interface to set Toaster
|
||||||
configuration parameters such as the build directory, layer sources,
|
configuration parameters such as the build directory, layer sources,
|
||||||
default variable values, and BitBake versions.
|
default variable values, and BitBake versions.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='toaster-setting-up-a-production-instance-of-toaster'>
|
<section id='toaster-setting-up-a-production-instance-of-toaster'>
|
||||||
<title>Setting Up a Production Instance of Toaster</title>
|
<title>Setting Up a Production Instance of Toaster</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
You can use a production instance of Toaster to share the
|
You can use a production instance of Toaster to share the
|
||||||
Toaster instance with remote users, multiple users, or both.
|
Toaster instance with remote users, multiple users, or both.
|
||||||
The production instance is also the setup that can cope with
|
The production instance is also the setup that can cope with
|
||||||
heavier loads on the web service.
|
heavier loads on the web service.
|
||||||
Use the instructions in the following sections to set up
|
Use the instructions in the following sections to set up
|
||||||
Toaster to run builds through the Toaster web interface.
|
Toaster to run builds through the Toaster web interface.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<section id='toaster-production-instance-requirements'>
|
<section id='toaster-production-instance-requirements'>
|
||||||
<title>Requirements</title>
|
<title>Requirements</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Be sure you meet the following requirements:
|
Be sure you meet the following requirements:
|
||||||
<note>
|
<note>
|
||||||
You must comply with all Apache,
|
You must comply with all Apache,
|
||||||
<filename>mod-wsgi</filename>, and Mysql requirements.
|
<filename>mod-wsgi</filename>, and Mysql requirements.
|
||||||
</note>
|
</note>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Have all the build requirements as described in
|
Have all the build requirements as described in
|
||||||
"<link linkend='toaster-setting-up-the-basic-system-requirements'>Setting Up the Basic System Requirements</link>"
|
"<link linkend='toaster-setting-up-the-basic-system-requirements'>Setting Up the Basic System Requirements</link>"
|
||||||
chapter.
|
chapter.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Have an Apache webserver.
|
Have an Apache webserver.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Have <filename>mod-wsgi</filename> for the Apache
|
Have <filename>mod-wsgi</filename> for the Apache
|
||||||
webserver.
|
webserver.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Use the Mysql database server.
|
Use the Mysql database server.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
If you are using Ubuntu 14.04.3, run the following:
|
If you are using Ubuntu 14.04.3, run the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server virtualenv libmysqlclient-dev
|
$ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server virtualenv libmysqlclient-dev
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
If you are using Fedora 22 or a RedHat distribution, run
|
If you are using Fedora 22 or a RedHat distribution, run
|
||||||
the following:
|
the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ sudo dnf install httpd mod_wsgi python-virtualenv gcc mysql-devel
|
$ sudo dnf install httpd mod_wsgi python-virtualenv gcc mysql-devel
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='toaster-installation-steps'>
|
<section id='toaster-installation-steps'>
|
||||||
<title>Installation</title>
|
<title>Installation</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Perform the following steps to install Toaster:
|
Perform the following steps to install Toaster:
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Checkout a copy of <filename>poky</filename>
|
Checkout a copy of <filename>poky</filename>
|
||||||
into the web server directory.
|
into the web server directory.
|
||||||
You will be using <filename>/var/www/toaster</filename>:
|
You will be using <filename>/var/www/toaster</filename>:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ mkdir -p /var/www/toaster
|
$ mkdir -p /var/www/toaster
|
||||||
$ cd /var/www/toaster/
|
$ cd /var/www/toaster/
|
||||||
$ git clone git://git.yoctoproject.org/poky
|
$ git clone git://git.yoctoproject.org/poky
|
||||||
$ git checkout &DISTRO_NAME;
|
$ git checkout &DISTRO_NAME;
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Initialize a virtual environment and install Toaster
|
Initialize a virtual environment and install Toaster
|
||||||
dependencies.
|
dependencies.
|
||||||
Using a virtual environment keeps the Python packages
|
Using a virtual environment keeps the Python packages
|
||||||
isolated from your system-provided packages:
|
isolated from your system-provided packages:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ cd /var/www/toaster/
|
$ cd /var/www/toaster/
|
||||||
$ virtualenv venv
|
$ virtualenv venv
|
||||||
$ source ./venv/bin/activate
|
$ source ./venv/bin/activate
|
||||||
$ pip install -r ./poky/bitbake/toaster-requirements.txt
|
$ pip install -r ./poky/bitbake/toaster-requirements.txt
|
||||||
$ pip install mysql
|
$ pip install mysql
|
||||||
$ pip install MySQL-python
|
$ pip install MySQL-python
|
||||||
</literallayout>
|
</literallayout>
|
||||||
<note>
|
<note>
|
||||||
Isolating these packages is not required but is
|
Isolating these packages is not required but is
|
||||||
recommended.
|
recommended.
|
||||||
Alternatively, you can use your operating system's
|
Alternatively, you can use your operating system's
|
||||||
package manager to install the packages.
|
package manager to install the packages.
|
||||||
</note>
|
</note>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Configure Toaster by editing
|
Configure Toaster by editing
|
||||||
<filename>/var/www/toaster/poky/bitbake/lib/toaster/toastermain/settings.py</filename>
|
<filename>/var/www/toaster/poky/bitbake/lib/toaster/toastermain/settings.py</filename>
|
||||||
as follows:
|
as follows:
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Edit the <filename>DATABASE</filename> settings:
|
Edit the <filename>DATABASE</filename> settings:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
DATABASES = {
|
DATABASES = {
|
||||||
'default': {
|
'default': {
|
||||||
'ENGINE': 'django.db.backends.mysql',
|
'ENGINE': 'django.db.backends.mysql',
|
||||||
'NAME': 'toaster_data',
|
'NAME': 'toaster_data',
|
||||||
'USER': 'toaster',
|
'USER': 'toaster',
|
||||||
'PASSWORD': 'yourpasswordhere',
|
'PASSWORD': 'yourpasswordhere',
|
||||||
'HOST': 'localhost',
|
'HOST': 'localhost',
|
||||||
'PORT': '3306',
|
'PORT': '3306',
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Edit the <filename>SECRET_KEY</filename>:
|
Edit the <filename>SECRET_KEY</filename>:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
SECRET_KEY = '<replaceable>your_secret_key</replaceable>'
|
SECRET_KEY = '<replaceable>your_secret_key</replaceable>'
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Edit the <filename>STATIC_ROOT</filename>:
|
Edit the <filename>STATIC_ROOT</filename>:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
STATIC_ROOT = '/var/www/toaster/static_files/'
|
STATIC_ROOT = '/var/www/toaster/static_files/'
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Add the database and user to the <filename>mysql</filename>
|
Add the database and user to the <filename>mysql</filename>
|
||||||
server defined earlier:
|
server defined earlier:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ mysql -u root -p
|
$ mysql -u root -p
|
||||||
mysql> CREATE DATABASE toaster_data;
|
mysql> CREATE DATABASE toaster_data;
|
||||||
mysql> CREATE USER 'toaster'@'localhost' identified by 'yourpasswordhere';
|
mysql> CREATE USER 'toaster'@'localhost' identified by 'yourpasswordhere';
|
||||||
mysql> GRANT all on toaster_data.* to 'toaster'@'localhost';
|
mysql> GRANT all on toaster_data.* to 'toaster'@'localhost';
|
||||||
mysql> quit
|
mysql> quit
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Get Toaster to create the database schema,
|
Get Toaster to create the database schema,
|
||||||
default data, and gather the statically-served files:
|
default data, and gather the statically-served files:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ cd /var/www/toaster/poky/
|
$ cd /var/www/toaster/poky/
|
||||||
$ ./bitbake/lib/toaster/manage.py syncdb
|
$ ./bitbake/lib/toaster/manage.py syncdb
|
||||||
$ ./bitbake/lib/toaster/manage.py migrate
|
$ ./bitbake/lib/toaster/manage.py migrate
|
||||||
$ TOASTER_DIR=`pwd` TOASTER_CONF=./meta-yocto/conf/toasterconf.json ./bitbake/lib/toaster/manage.py checksettings
|
$ TOASTER_DIR=`pwd` TOASTER_CONF=./meta-yocto/conf/toasterconf.json ./bitbake/lib/toaster/manage.py checksettings
|
||||||
$ ./bitbake/lib/toaster/manage.py collectstatic
|
$ ./bitbake/lib/toaster/manage.py collectstatic
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
For the above set of commands, after moving to the
|
For the above set of commands, after moving to the
|
||||||
<filename>poky</filename> directory,
|
<filename>poky</filename> directory,
|
||||||
the <filename>syncdb</filename> and <filename>migrate</filename>
|
the <filename>syncdb</filename> and <filename>migrate</filename>
|
||||||
commands ensure the database
|
commands ensure the database
|
||||||
schema has had changes propagated correctly (i.e.
|
schema has had changes propagated correctly (i.e.
|
||||||
migrations).
|
migrations).
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The next line sets the Toaster root directory
|
The next line sets the Toaster root directory
|
||||||
<filename>TOASTER_DIR</filename> and the location of
|
<filename>TOASTER_DIR</filename> and the location of
|
||||||
the Toaster configuration file
|
the Toaster configuration file
|
||||||
<filename>TOASTER_CONF</filename>, which is
|
<filename>TOASTER_CONF</filename>, which is
|
||||||
relative to the Toaster root directory
|
relative to the Toaster root directory
|
||||||
<filename>TOASTER_DIR</filename>.
|
<filename>TOASTER_DIR</filename>.
|
||||||
For more information on the Toaster configuration file
|
For more information on the Toaster configuration file
|
||||||
<filename>TOASTER_CONF</filename>, see the
|
<filename>TOASTER_CONF</filename>, see the
|
||||||
<link linkend='toaster-json-files'>JSON Files</link>
|
<link linkend='toaster-json-files'>JSON Files</link>
|
||||||
section of this manual.
|
section of this manual.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This line also runs the <filename>checksettings</filename>
|
This line also runs the <filename>checksettings</filename>
|
||||||
command, which configures the location of the Toaster
|
command, which configures the location of the Toaster
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build directory</ulink>.
|
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build directory</ulink>.
|
||||||
The Toaster root directory <filename>TOASTER_DIR</filename>
|
The Toaster root directory <filename>TOASTER_DIR</filename>
|
||||||
determines where the Toaster build directory
|
determines where the Toaster build directory
|
||||||
is created on the file system.
|
is created on the file system.
|
||||||
In the example above,
|
In the example above,
|
||||||
<filename>TOASTER_DIR</filename> is set as follows:
|
<filename>TOASTER_DIR</filename> is set as follows:
|
||||||
<literallayout class="monospaced">
|
<literallayout class="monospaced">
|
||||||
/var/www/toaster/poky
|
/var/www/toaster/poky
|
||||||
</literallayout>
|
</literallayout>
|
||||||
This setting causes the Toaster build directory to be:
|
This setting causes the Toaster build directory to be:
|
||||||
<literallayout class="monospaced">
|
<literallayout class="monospaced">
|
||||||
/var/www/toaster/poky/build
|
/var/www/toaster/poky/build
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Finally, the <filename>collectstatic</filename> command
|
Finally, the <filename>collectstatic</filename> command
|
||||||
is a Django framework command that collects all the
|
is a Django framework command that collects all the
|
||||||
statically served files into a designated directory to
|
statically served files into a designated directory to
|
||||||
be served up by the Apache web server.
|
be served up by the Apache web server.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Add an Apache configuration file for Toaster to your Apache web
|
Add an Apache configuration file for Toaster to your Apache web
|
||||||
server's configuration directory.
|
server's configuration directory.
|
||||||
If you are using Ubuntu or Debian, put the file here:
|
If you are using Ubuntu or Debian, put the file here:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
/etc/apache2/conf-available/toaster.conf
|
/etc/apache2/conf-available/toaster.conf
|
||||||
</literallayout>
|
</literallayout>
|
||||||
If you are using Fedora or RedHat, put it here:
|
If you are using Fedora or RedHat, put it here:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
/etc/httpd/conf.d/toaster.conf
|
/etc/httpd/conf.d/toaster.conf
|
||||||
</literallayout>
|
</literallayout>
|
||||||
Following is a sample Apache configuration for Toaster
|
Following is a sample Apache configuration for Toaster
|
||||||
you can follow:
|
you can follow:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
Alias /static /var/www/toaster/static_files
|
Alias /static /var/www/toaster/static_files
|
||||||
<Directory /var/www/toaster/static_files>
|
<Directory /var/www/toaster/static_files>
|
||||||
Order allow,deny
|
Order allow,deny
|
||||||
Allow from all
|
Allow from all
|
||||||
Require all granted
|
Require all granted
|
||||||
</Directory>
|
</Directory>
|
||||||
|
|
||||||
WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/venv/lib/python2.7/site-packages
|
WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/venv/lib/python2.7/site-packages
|
||||||
|
|
||||||
WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
|
WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
|
||||||
<Location />
|
<Location />
|
||||||
WSGIProcessGroup toastern_wsgi
|
WSGIProcessGroup toastern_wsgi
|
||||||
</Location>
|
</Location>
|
||||||
</literallayout>
|
</literallayout>
|
||||||
If you are using Ubuntu or Debian,
|
If you are using Ubuntu or Debian,
|
||||||
you will need to enable the config and module for Apache:
|
you will need to enable the config and module for Apache:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ sudo a2enmod wsgi
|
$ sudo a2enmod wsgi
|
||||||
$ sudo a2enconf toaster
|
$ sudo a2enconf toaster
|
||||||
$ chmod +x bitbake/lib/toaster/toastermain/wsgi.py
|
$ chmod +x bitbake/lib/toaster/toastermain/wsgi.py
|
||||||
</literallayout>
|
</literallayout>
|
||||||
Finally, restart Apache to make sure all new configuration
|
Finally, restart Apache to make sure all new configuration
|
||||||
is loaded.
|
is loaded.
|
||||||
For Ubuntu and Debian use:
|
For Ubuntu and Debian use:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ sudo service apache2 restart
|
$ sudo service apache2 restart
|
||||||
</literallayout>
|
</literallayout>
|
||||||
For Fedora and RedHat use:
|
For Fedora and RedHat use:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ sudo service httpd restart
|
$ sudo service httpd restart
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Install the build runner service.
|
Install the build runner service.
|
||||||
This service needs to be running in order to dispatch
|
This service needs to be running in order to dispatch
|
||||||
builds.
|
builds.
|
||||||
Use this command:
|
Use this command:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
/var/www/toaster/poky/bitbake/lib/toaster/manage.py runbuilds
|
/var/www/toaster/poky/bitbake/lib/toaster/manage.py runbuilds
|
||||||
</literallayout>
|
</literallayout>
|
||||||
Here is an example:
|
Here is an example:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# toaster run builds dispatcher
|
# toaster run builds dispatcher
|
||||||
cd /var/www/toaster/
|
cd /var/www/toaster/
|
||||||
source ./venv/bin/activate
|
source ./venv/bin/activate
|
||||||
./bitbake/lib/toaster/manage.py runbuilds
|
./bitbake/lib/toaster/manage.py runbuilds
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
You can now open up a browser and start using Toaster.
|
You can now open up a browser and start using Toaster.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='using-the-toaster-web-interface'>
|
<section id='using-the-toaster-web-interface'>
|
||||||
<title>Using the Toaster Web Interface</title>
|
<title>Using the Toaster Web Interface</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The Toaster web interface allows you to do the following:
|
The Toaster web interface allows you to do the following:
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Browse published layers in the
|
Browse published layers in the
|
||||||
<ulink url='http://layers.openembedded.org'>OpenEmbedded Metadata Index</ulink>
|
<ulink url='http://layers.openembedded.org'>OpenEmbedded Metadata Index</ulink>
|
||||||
that are available for your selected version of the build
|
that are available for your selected version of the build
|
||||||
system.
|
system.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Import your own layers for building.
|
Import your own layers for building.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Add and remove layers from your configuration.
|
Add and remove layers from your configuration.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Set configuration variables.
|
Set configuration variables.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Select a target or multiple targets to build.
|
Select a target or multiple targets to build.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Start your builds.
|
Start your builds.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
See what was built (recipes and packages) and what
|
See what was built (recipes and packages) and what
|
||||||
packages were installed into your final image.
|
packages were installed into your final image.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Browse the directory structure of your image.
|
Browse the directory structure of your image.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
See the value of all variables in your build configuration,
|
See the value of all variables in your build configuration,
|
||||||
and which files set each value.
|
and which files set each value.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Examine error, warning and trace messages to aid in
|
Examine error, warning and trace messages to aid in
|
||||||
debugging.
|
debugging.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
See information about the BitBake tasks executed and
|
See information about the BitBake tasks executed and
|
||||||
reused during your build, including those that used
|
reused during your build, including those that used
|
||||||
shared state.
|
shared state.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
See dependency relationships between recipes, packages
|
See dependency relationships between recipes, packages
|
||||||
and tasks.
|
and tasks.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
See performance information such as build time, task time,
|
See performance information such as build time, task time,
|
||||||
CPU usage, and disk I/O.
|
CPU usage, and disk I/O.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<section id='web-interface-videos'>
|
<section id='web-interface-videos'>
|
||||||
<title>Toaster Web Interface Videos</title>
|
<title>Toaster Web Interface Videos</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Following are several videos that show how to use the Toaster GUI:
|
Following are several videos that show how to use the Toaster GUI:
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para><emphasis>Build Configuration:</emphasis>
|
<listitem><para><emphasis>Build Configuration:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=qYgDZ8YzV6w'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=qYgDZ8YzV6w'>video</ulink>
|
||||||
overviews and demonstrates build configuration for Toaster.
|
overviews and demonstrates build configuration for Toaster.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Build Custom Layers:</emphasis>
|
<listitem><para><emphasis>Build Custom Layers:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=QJzaE_XjX5c'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=QJzaE_XjX5c'>video</ulink>
|
||||||
shows you how to build custom layers that are used with
|
shows you how to build custom layers that are used with
|
||||||
Toaster.
|
Toaster.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis>
|
<listitem><para><emphasis>Toaster Homepage and Table Controls:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=QEARDnrR1Xw'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=QEARDnrR1Xw'>video</ulink>
|
||||||
goes over the Toaster entry page, and provides
|
goes over the Toaster entry page, and provides
|
||||||
an overview of the data manipulation capabilities of
|
an overview of the data manipulation capabilities of
|
||||||
Toaster, which include search, sorting and filtering by
|
Toaster, which include search, sorting and filtering by
|
||||||
different criteria.
|
different criteria.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Build Dashboard:</emphasis>
|
<listitem><para><emphasis>Build Dashboard:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=KKqHYcnp2gE'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=KKqHYcnp2gE'>video</ulink>
|
||||||
shows you the build dashboard, a page providing an
|
shows you the build dashboard, a page providing an
|
||||||
overview of the information available for a selected build.
|
overview of the information available for a selected build.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Image Information:</emphasis>
|
<listitem><para><emphasis>Image Information:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=XqYGFsmA0Rw'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=XqYGFsmA0Rw'>video</ulink>
|
||||||
walks through the information Toaster provides
|
walks through the information Toaster provides
|
||||||
about images: packages installed and root file system.
|
about images: packages installed and root file system.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Configuration:</emphasis>
|
<listitem><para><emphasis>Configuration:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=UW-j-T2TzIg'>video</ulink>
|
||||||
provides Toaster build configuration information.
|
provides Toaster build configuration information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Tasks:</emphasis>
|
<listitem><para><emphasis>Tasks:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=D4-9vGSxQtw'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=D4-9vGSxQtw'>video</ulink>
|
||||||
shows the information Toaster provides about the
|
shows the information Toaster provides about the
|
||||||
tasks run by the build system.
|
tasks run by the build system.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Recipes and Packages Built:</emphasis>
|
<listitem><para><emphasis>Recipes and Packages Built:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=x-6dx4huNnw'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=x-6dx4huNnw'>video</ulink>
|
||||||
shows the information Toaster provides about recipes
|
shows the information Toaster provides about recipes
|
||||||
and packages built.
|
and packages built.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Performance Data:</emphasis>
|
<listitem><para><emphasis>Performance Data:</emphasis>
|
||||||
This
|
This
|
||||||
<ulink url='https://www.youtube.com/watch?v=qWGMrJoqusQ'>video</ulink>
|
<ulink url='https://www.youtube.com/watch?v=qWGMrJoqusQ'>video</ulink>
|
||||||
shows the build performance data provided by
|
shows the build performance data provided by
|
||||||
Toaster.
|
Toaster.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='toaster-web-interface-preferred-version'>
|
<section id='a-note-on-the-local-yocto-project-release'>
|
||||||
<title>Building a Specific Recipe Given Multiple Versions</title>
|
<title>A Note on the Local Yocto Project Release</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This note only applies if you have set up Toaster
|
||||||
|
for local development, as explained in
|
||||||
|
<link linkend='starting-toaster-for-local-development'>
|
||||||
|
section 3.1.</link>
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
When you create a project in Toaster, you will be asked to
|
||||||
|
provide a name and to select a Yocto Project release. One
|
||||||
|
of the release options you will find is called
|
||||||
|
<emphasis>Local Yocto Project</emphasis>.
|
||||||
|
<imagedata fileref="figures/new-project.png" align="center" width="9in" />
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
When you select the <emphasis>Local Yocto Project</emphasis>
|
||||||
|
release, Toaster will run your builds using the local Yocto
|
||||||
|
Project clone you have in your computer: the same clone
|
||||||
|
you are using to run Toaster. Unless you manually update
|
||||||
|
this clone, your builds will always use the same Git revision.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
If you select any of the other release options, Toaster
|
||||||
|
will fetch the tip of your selected release from the upstream
|
||||||
|
<ulink url='https://git.yoctoproject.org'>Yocto Project
|
||||||
|
repository</ulink> every time you run a build. This effectively
|
||||||
|
means that if your selected release is updated upstream, the
|
||||||
|
Git revision you are using for your builds will change.
|
||||||
|
If you are doing development locally, you might not want this
|
||||||
|
to happen. In that case, the <emphasis>Local Yocto Project</emphasis>
|
||||||
|
release might be the right choice.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
However, the <emphasis>Local Yocto Project</emphasis> release
|
||||||
|
will not provide you with any compatible layers, other than the
|
||||||
|
three core layers that come with the Yocto Project:
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>
|
||||||
|
<ulink url='http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/'>openembedded-core</ulink>
|
||||||
|
</para></listitem>
|
||||||
|
<listitem><para>
|
||||||
|
<ulink url='http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/'>meta-poky</ulink>
|
||||||
|
</para></listitem>
|
||||||
|
<listitem><para>
|
||||||
|
<ulink url='http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/'>meta-yocto-bsp</ulink>
|
||||||
|
</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
<imagedata fileref="figures/compatible-layers.png" align="center" width="9in" />
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
If you want to build any other layers, you will need to
|
||||||
|
manually import them into your Toaster project, using the
|
||||||
|
<emphasis>Import layer</emphasis> page.
|
||||||
|
<imagedata fileref="figures/import-layer.png" align="center" width="9in" />
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id='toaster-web-interface-preferred-version'>
|
||||||
|
<title>Building a Specific Recipe Given Multiple Versions</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Occasionally, a layer might provide more than one version of
|
Occasionally, a layer might provide more than one version of
|
||||||
|
|
Loading…
Reference in New Issue