View source for Setting up a production instance of Toaster

[[Category:Toaster]]
----
{| style="color:black; background-color:#ffffcc" width="100%" cellpadding="10" class="wikitable"
|This page is the development version of the documentation to provide the latest information, if you're using a release please refer to [https://docs.yoctoproject.org/toaster-manual/index.html the published manual]'''
|}
----
A production instance of Toaster is one in which you wish to share the Toaster instance with remote and multiple users. It is also the setup which can cope with heavier loads on the web service. These instructions setup toaster in Build mode where builds and projects are run, viewed and defined by the Toaster web interface.

== Requirements ==
* [http://www.yoctoproject.org/docs/2.0/yocto-project-qs/yocto-project-qs.html#packages Build requirements]
* Apache webserver
* mod-wsgi for Apache webserver
* Mysql database server

Ubuntu 14.04.3:
<code>
    $ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server python-virtualenv libmysqlclient-dev python-dev python-mysqldb
</code>

Fedora 22/RH:
<code>
    $ sudo dnf install httpd mod_wsgi python-virtualenv gcc mysql-devel
</code>

== Installation ==

'''1.''' Checkout a copy of Poky into the web server directory. We're going to be using /var/www/toaster.
<code>
  $ mkdir -p /var/www/toaster
  $ cd /var/www/toaster/
  $ git clone git://git.yoctoproject.org/poky
  $ cd poky
  $ git checkout jethro # change for any release name required
</code>


'''2.''' Initialise a virtualenv and install Toaster dependencies. (Use virtualenv to keep the python packages isolated from your system provided packages - not required but recommended, alternative use your OS's package manager to install the packages)

<code>
   $ cd /var/www/toaster/
   $ virtualenv venv
   $ source ./venv/bin/activate
   $ pip install -r ./poky/bitbake/toaster-requirements.txt
   $ pip install mysqlclient
</code>


'''3.''' Configure toaster edit /var/www/toaster/poky/bitbake/lib/toaster/toastermain/settings.py

Edit the DATABASE settings:
<code>
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.mysql', 
         'NAME': 'toaster_data',                     
         'USER': 'toaster',
         'PASSWORD': 'yourpasswordhere',
         'HOST': 'localhost',                 
         'PORT': '3306',                      
 }
</code>

Edit the [https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/#secret-key SECRET_KEY]:
<code>
 SECRET_KEY = 'YOUR SECRET RANDOM KEY HERE'
</code>

Edit the STATIC_ROOT:
<code>
 STATIC_ROOT = '/var/www/toaster/static_files/'
</code>


'''4.'''' Now add the database and user to your mysql server that we just defined
<code>
 $ mysql -u root -p
 mysql> CREATE DATABASE toaster_data;
 mysql> CREATE USER 'toaster'@'localhost' identified by 'yourpasswordhere';
 mysql> GRANT all on toaster_data.* to 'toaster'@'localhost';
 mysql> quit
</code>
n.b. You may want to decide on fewer [https://dev.mysql.com/doc/refman/5.1/en/grant.html privileges] to the toaster user. 


'''5.''' Get toaster to create the database schema, default data, update the TOASTER_DIR which is the build work dir and collect up the statically served files

<code>
 $ cd  /var/www/toaster/poky/
 $ ./bitbake/lib/toaster/manage.py migrate
 $ ./bitbake/lib/toaster/manage.py loadconf ./meta-yocto/conf/toasterconf.json
 $ TOASTER_DIR=/var/www/toaster/poky/ ./bitbake/lib/toaster/manage.py checksettings
 $ ./bitbake/lib/toaster/manage.py lsupdates
 $ ./bitbake/lib/toaster/manage.py collectstatic
</code>


'''6.''' Add a config file for Toaster to your Apache web server's configurations available directory.

Ubuntu/Debian put it here: /etc/apache2/conf-available/toaster.conf
Fedora/RH usually here: /etc/httpd/conf.d/toaster.conf
<code>

 Alias /static /var/www/toaster/static_files
 <Directory /var/www/toaster/static_files>
 	Order allow,deny
 	Allow from all
 	Require all granted
 </Directory>
 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"
 <Location />
     WSGIProcessGroup toaster_wsgi
 </Location>

</code>

In Ubuntu/Debain you will need to enable the config and module in Apache webserver
<code>
   $ sudo a2enmod wsgi
   $ sudo a2enconf toaster
</code>

Restart Apache web server to make sure all new configuration is loaded

Ubuntu/Debian:
<code>
   $ sudo service apache2 restart
</code>

Fedora/RH:
<code>
   $ sudo service httpd restart
</code>


'''7.''' Install the build runner service

This service needs to be running in order to dispatch builds the command that needs to be run is:

<code>
 $ source oe-init-build-env
 $ source toaster start noweb
</code>


Example upstart service /etc/init/toaster-buildservice.conf :
<pre>
 author "Michael W"
 description "start and stop toaster build service"
 version "1.0"

 start on started networking
 stop on runlevel [!2345]

 respawn

 script
   exec su toasterbuilder -c "cd /var/www/toaster/poky && source oe-init-build-env && source toaster start noweb"
 end script
</pre>


Example systemd service usually in /lib/systemd/system/toaster.service:
<pre> 
[Unit]
Description=Toaster runbuilds
 
[Service]
Type=forking
User=toaster
ExecStart=/var/www/toaster/toaster-service.sh start
ExecStop=/var/www/toaster/toaster-service.sh stop
 
[Install]
WantedBy=multi-user.target
</pre>
script /var/www/toaster/toaster-service.sh:
<pre>

#!/bin/bash
 
cd /var/www/toaster/poky/
 
source oe-init-build-env
if [ "$1" == 'start' ]; then
  source ../bitbake/bin/toaster start noweb
fi
 
if [ "$1" == 'stop' ]; then
  source ../bitbake/bin/toaster stop
fi
</pre>


N.b. You may wish to add a service entry to your OS's init system so that it starts up on start up as well as adding a dedicated user.


Now open up a browser and you can start using Toaster!