summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/setup-and-use.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/toaster-manual/setup-and-use.rst')
-rw-r--r--documentation/toaster-manual/setup-and-use.rst49
1 files changed, 24 insertions, 25 deletions
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
index ded771e796..a0c27499ba 100644
--- a/documentation/toaster-manual/setup-and-use.rst
+++ b/documentation/toaster-manual/setup-and-use.rst
@@ -23,8 +23,8 @@ Once in that directory, source the build environment script::
23 23
24 $ source oe-init-build-env 24 $ source oe-init-build-env
25 25
26Next, from the build directory (e.g. 26Next, from the :term:`Build Directory` (e.g. ``poky/build``), start Toaster
27``poky/build``), start Toaster using this command:: 27using this command::
28 28
29 $ source toaster start 29 $ source toaster start
30 30
@@ -124,14 +124,14 @@ causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``.
124The Build Directory 124The Build Directory
125=================== 125===================
126 126
127Toaster creates a build directory within your Source Directory (e.g. 127Toaster creates a :term:`Build Directory` within your Source Directory (e.g.
128``poky``) to execute the builds. 128``poky``) to execute the builds.
129 129
130Alternatively, if you would like all of your Toaster related files and 130Alternatively, if you would like all of your Toaster related files and
131directories to be in a particular location, you can set the 131directories to be in a particular location, you can set the
132``TOASTER_DIR`` environment variable, which takes precedence over your 132``TOASTER_DIR`` environment variable, which takes precedence over your
133current working directory. Setting this environment variable causes 133current working directory. Setting this environment variable causes
134Toaster to use ``$TOASTER_DIR/build`` as the build directory. 134Toaster to use ``$TOASTER_DIR/build`` as the :term:`Build Directory`.
135 135
136Creating a Django Superuser 136Creating a Django Superuser
137=========================== 137===========================
@@ -152,10 +152,10 @@ superuser by following these steps:
152 $ export PATH=$PATH:$HOME/.local/bin 152 $ export PATH=$PATH:$HOME/.local/bin
153 153
154#. From the directory containing the Toaster database, which by default 154#. From the directory containing the Toaster database, which by default
155 is the :term:`Build Directory`, 155 is the :term:`Build Directory`, invoke the ``createsuperuser`` command from
156 invoke the ``createsuperuser`` command from ``manage.py``:: 156 ``manage.py``::
157 157
158 $ cd ~/poky/build 158 $ cd poky/build
159 $ ../bitbake/lib/toaster/manage.py createsuperuser 159 $ ../bitbake/lib/toaster/manage.py createsuperuser
160 160
161#. Django prompts you for the username, which you need to provide. 161#. Django prompts you for the username, which you need to provide.
@@ -179,7 +179,7 @@ example, if you are running Toaster locally, use the following URL::
179 http://127.0.0.1:8000/admin 179 http://127.0.0.1:8000/admin
180 180
181You can use the Django administration interface to set Toaster configuration 181You can use the Django administration interface to set Toaster configuration
182parameters such as the build directory, layer sources, default variable 182parameters such as the :term:`Build Directory`, layer sources, default variable
183values, and BitBake versions. 183values, and BitBake versions.
184 184
185Setting Up a Production Instance of Toaster 185Setting Up a Production Instance of Toaster
@@ -211,7 +211,7 @@ Be sure you meet the following requirements:
211 211
212- If you are using Ubuntu, run the following:: 212- If you are using Ubuntu, run the following::
213 213
214 $ sudo apt-get install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev 214 $ sudo apt install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev
215 215
216- If you are using Fedora or a RedHat distribution, run the 216- If you are using Fedora or a RedHat distribution, run the
217 following:: 217 following::
@@ -239,7 +239,7 @@ Perform the following steps to install Toaster:
239 $ git clone git://git.yoctoproject.org/poky 239 $ git clone git://git.yoctoproject.org/poky
240 $ git checkout &DISTRO_NAME_NO_CAP; 240 $ git checkout &DISTRO_NAME_NO_CAP;
241 241
242#. Install Toaster dependencies using the --user flag which keeps the 242#. Install Toaster dependencies using the ``--user`` flag which keeps the
243 Python packages isolated from your system-provided packages:: 243 Python packages isolated from your system-provided packages::
244 244
245 $ cd /var/www/toaster/ 245 $ cd /var/www/toaster/
@@ -311,14 +311,13 @@ Perform the following steps to install Toaster:
311 migrations). The next line sets the Toaster root directory 311 migrations). The next line sets the Toaster root directory
312 ``TOASTER_DIR`` and the location of the Toaster configuration file 312 ``TOASTER_DIR`` and the location of the Toaster configuration file
313 ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The 313 ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The
314 ``TEMPLATECONF`` value reflects the contents of 314 :term:`TEMPLATECONF` value reflects the contents of
315 ``poky/.templateconf``, and by default, should include the string 315 ``poky/.templateconf``, and by default, should include the string
316 "poky". For more information on the Toaster configuration file, see 316 "poky". For more information on the Toaster configuration file, see
317 the ":ref:`toaster-manual/reference:Configuring Toaster`" section. 317 the ":ref:`toaster-manual/reference:Configuring Toaster`" section.
318 318
319 This line also runs the ``checksettings`` command, which configures 319 This line also runs the ``checksettings`` command, which configures
320 the location of the Toaster :term:`Build Directory`. 320 the location of the Toaster :term:`Build Directory`. The Toaster
321 The Toaster
322 root directory ``TOASTER_DIR`` determines where the Toaster build 321 root directory ``TOASTER_DIR`` determines where the Toaster build
323 directory is created on the file system. In the example above, 322 directory is created on the file system. In the example above,
324 ``TOASTER_DIR`` is set as follows:: 323 ``TOASTER_DIR`` is set as follows::
@@ -326,7 +325,7 @@ Perform the following steps to install Toaster:
326 /var/www/toaster/poky 325 /var/www/toaster/poky
327 326
328 327
329 This setting causes the Toaster build directory to be:: 328 This setting causes the Toaster :term:`Build Directory` to be::
330 329
331 /var/www/toaster/poky/build 330 /var/www/toaster/poky/build
332 331
@@ -362,11 +361,11 @@ Perform the following steps to install Toaster:
362 361
363 /etc/httpd/conf.d/toaster.conf 362 /etc/httpd/conf.d/toaster.conf
364 363
365 If you are using OpenSUSE, put it here:: 364 If you are using openSUSE, put it here::
366 365
367 /etc/apache2/conf.d/toaster.conf 366 /etc/apache2/conf.d/toaster.conf
368 367
369 Following is a sample Apache configuration for Toaster you can follow: 368 Here is a sample Apache configuration for Toaster you can follow:
370 369
371 .. code-block:: apache 370 .. code-block:: apache
372 371
@@ -380,13 +379,13 @@ Perform the following steps to install Toaster:
380 Require all granted 379 Require all granted
381 </IfModule> 380 </IfModule>
382 </Directory> 381 </Directory>
383 382
384 <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain> 383 <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain>
385 <Files "wsgi.py"> 384 <Files "wsgi.py">
386 Require all granted 385 Require all granted
387 </Files> 386 </Files>
388 </Directory> 387 </Directory>
389 388
390 WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages 389 WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages
391 WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py" 390 WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
392 <Location /> 391 <Location />
@@ -402,7 +401,7 @@ Perform the following steps to install Toaster:
402 $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py 401 $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py
403 402
404 Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu, 403 Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu,
405 Debian, and OpenSUSE use:: 404 Debian, and openSUSE use::
406 405
407 $ sudo service apache2 restart 406 $ sudo service apache2 restart
408 407
@@ -417,13 +416,13 @@ Perform the following steps to install Toaster:
417 416
418 [Unit] 417 [Unit]
419 Description=Toaster runbuilds 418 Description=Toaster runbuilds
420 419
421 [Service] 420 [Service]
422 Type=forking User=toaster 421 Type=forking User=toaster
423 ExecStart=/usr/bin/screen -d -m -S runbuilds /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start 422 ExecStart=/usr/bin/screen -d -m -S runbuilds /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start
424 ExecStop=/usr/bin/screen -S runbuilds -X quit 423 ExecStop=/usr/bin/screen -S runbuilds -X quit
425 WorkingDirectory=/var/www/toaster/poky 424 WorkingDirectory=/var/www/toaster/poky
426 425
427 [Install] 426 [Install]
428 WantedBy=multi-user.target 427 WantedBy=multi-user.target
429 428
@@ -433,11 +432,11 @@ Perform the following steps to install Toaster:
433 up executable permissions:: 432 up executable permissions::
434 433
435 #!/bin/bash 434 #!/bin/bash
436 435
437 #export http_proxy=http://proxy.host.com:8080 436 #export http_proxy=http://proxy.host.com:8080
438 #export https_proxy=http://proxy.host.com:8080 437 #export https_proxy=http://proxy.host.com:8080
439 #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy 438 #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy
440 cd ~/poky/ 439 cd poky/
441 source ./oe-init-build-env build 440 source ./oe-init-build-env build
442 source ../bitbake/bin/toaster $1 noweb 441 source ../bitbake/bin/toaster $1 noweb
443 [ "$1" == 'start' ] && /bin/bash 442 [ "$1" == 'start' ] && /bin/bash
@@ -496,7 +495,7 @@ The Toaster web interface allows you to do the following:
496Toaster Web Interface Videos 495Toaster Web Interface Videos
497---------------------------- 496----------------------------
498 497
499Following are several videos that show how to use the Toaster GUI: 498Here are several videos that show how to use the Toaster GUI:
500 499
501- *Build Configuration:* This 500- *Build Configuration:* This
502 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and 501 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and
@@ -625,7 +624,7 @@ To specify ``bash`` 3.2.48 as the version to build, enter
625 :scale: 75% 624 :scale: 75%
626 625
627After clicking the "Add variable" button, the settings for 626After clicking the "Add variable" button, the settings for
628``PREFERRED_VERSION`` are added to the bottom of the BitBake variables 627:term:`PREFERRED_VERSION` are added to the bottom of the BitBake variables
629list. With these settings, the OpenEmbedded build system builds the 628list. With these settings, the OpenEmbedded build system builds the
630desired version of the recipe rather than the default version: 629desired version of the recipe rather than the default version:
631 630