summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/toaster-manual-setup-and-use.xml
Commit message (Collapse)AuthorAgeFilesLines
* toaster-manual: Fixed external linksScott Rifenbark2017-10-301-1/+1
| | | | | | | | | | Found four links going to the dev-manual that should have benn going to the ref-manual. These were for YP terms. Fixed them. (From yocto-docs rev: 0c75eda3a772d8c40e381e44e563a5b79b3d0cb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Created "Configuring Toaster" chapterKristi Rifenbark2017-10-161-4/+4
| | | | | | | | | | Deleted the existing JSON chapter, and replaced it with this new chapter. (From yocto-docs rev: 86f9fb9c567310ecd1b06944c4c9107ec30df29c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Rewrite of the 'Setting Up External Access' sectionKristi Rifenbark2017-10-161-7/+20
| | | | | | | (From yocto-docs rev: f3737aaeabf5ae169d07b72ef6b70e2b5d7cb4b7) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for "build-directory" term.Scott Rifenbark2017-06-221-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Changed the Webport address:Scott Rifenbark2016-07-191-2/+2
| | | | | | | | | | Using 0.0.0.0:8400 as a better way to set up this address. Easier on the user. (From yocto-docs rev: bef463d2743989596388fda7e97119f43da045a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: splitted long lineEd Bartosh2016-07-191-1/+2
| | | | | | | | | | | The TOASTER_DIR=... checksettings line is too long and got truncated when documenation in pdf format is made. Splitting it to two lines should fix this. (From yocto-docs rev: f3bf1c7b4094a9fda60f7f9d99363a947afed261) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: point keywords to Django documentationEd Bartosh2016-07-191-3/+7
| | | | | | | | | | Pointed SECRET_KEY, STATIC_ROOT and DATABASE keywords to the Django documentation. (From yocto-docs rev: d4a6291ad6ef40963c601e60dd861c76499d8b3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Update toaster start documentationMichael Wood2016-07-191-6/+22
| | | | | | | | | | | | - Update starting toaster to source toaster start - Add webport address documentation - Remove redundant "syncdb" call - Make it clearer that collectstatic uses STATIC_ROOT (From yocto-docs rev: 75516923f72b8d1f52cfd62281f71b637c9cac93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add OpenSUSE to the list of distrosEd Bartosh2016-07-191-1/+1
| | | | | | | | | | | Updated instructions of restarting apache. As OpenSUSE way of restarting apache is the same as Ubuntu and Debian it's enough to just add OpenSUSE to the list of distros. (From yocto-docs rev: 0aed02ca72303574d17996dc56484f76c772c864) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update runbuilds instructionsEd Bartosh2016-07-191-11/+42
| | | | | | | | | | | | Added sample configuration files and instructions for the runbuilds systemd service. Service runs runbuilds in a screen session for user convenience. User can attach to the session to see the runbuilds output, monitor logs and build environment. (From yocto-docs rev: 40beaa575fb96a06992a1d62bb45cd0cbbe2ae86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update apache configuration fileEd Bartosh2016-07-191-5/+15
| | | | | | | | | | | | | | | | Changed access control instructions to work with Apache 2.4 according to https://httpd.apache.org/docs/current/upgrading.html. Added 'Require all granted' for wsgi.py according to https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/modwsgi/. Changed python module path for WSGIDaemonProcess as python version changed and modules are installed to the different path. (From yocto-docs rev: 503b6c3c250936e889ce146bfcd301ed55e638d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions for OpenSUSEEd Bartosh2016-07-191-0/+4
| | | | | | | | | | Added description of the location of apache configuration file for OpenSUSE Leap 42.1 (From yocto-docs rev: 50f9a376072ce0b7d3ed4650ca3c3ea8e5ff14dc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: change mysql driverEd Bartosh2016-07-191-2/+1
| | | | | | | | | | | | | Here is a quote from Django 1.9 documentation regarding this: mysqlclient is a fork of MySQLdb which notably supports Python 3 and can be used as a drop-in replacement for MySQLdb. At the time of this writing, this is the recommended choice for using MySQL with Django. (From yocto-docs rev: deb02aeea4912f9d7978de3529467e4503eeeffb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions to create userEd Bartosh2016-07-191-2/+1
| | | | | | | | | | Creating separate toaster account would make production setup more isolated and maintainable. (From yocto-docs rev: 50ed20ad881da8d454a520903dadff20c5011fae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add list of packages for openSUSEEd Bartosh2016-07-191-0/+7
| | | | | | | | | Added package installation instructions for openSUSE Leap 42.1 (From yocto-docs rev: 895fd65a8641c877ef6eba49e20d34fd71dd7d66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update list of packagesEd Bartosh2016-07-191-2/+2
| | | | | | | | | | | Changed mod_wsgi package names as Toaster requires python 3 version of mod_wsgi. Added missing python3-pip, mariadb-server, mariadb-devel and python3-devel to the list of packages for Fedora. (From yocto-docs rev: 8a2da9855c0ed5dd137808fa976cbe707048551e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update distro versionsEd Bartosh2016-07-191-2/+3
| | | | | | | | | Changed Ubuntu and Fedora versions to the latest ones. (From yocto-docs rev: 50a7d0110e9f8c7c3c8c8c5b6e3a1495c9f9ff79) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Switch to pip3 dependency installerbrian avery2016-07-191-14/+14
| | | | | | | | | | | | | Our switch to python3 requires us to dump the virtualenv approach as long as we need python to resolve to python2 in the same shell that python3 resolves to python3. To enable users to install Toaster's python package dependencies locally, we are changing to using pip3 and these doc changes explain how to do that. (From yocto-docs rev: 06b8820bcb90d1855ccb2712b616bb89847a148f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions to create userEd Bartosh2016-07-191-2/+8
| | | | | | | | | | Creating separate toaster account would make production setup more isolated and maintainable. (From yocto-docs rev: 33c638d3e9a68d06d929276c6064d567ed7fe696) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark2016-04-181-1/+1
| | | | | | | | | Occurrences in many manuals and one figure. (From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed references using the DISTRO_NAME variableScott Rifenbark2016-04-061-1/+1
| | | | | | | | | | | | With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences of the DISTRO_NAME variable had to be checked to see if they really should be using the "NO_CAP" variable instead. Output and actual branch names are case-sensitive. (From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Edits to a previous patch.Scott Rifenbark2016-03-231-18/+22
| | | | | | | | | | I applied some grammar and writing edits to a large patch of new text. (From yocto-docs rev: 67cd700131e7cbca5769f25328772406f860d519) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Explain the local releaseBelen2016-03-231-445/+509
| | | | | | | | | | | | | 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>
* toaster-manual: Updated how manage.py createsuperuser command is runBelen Barros Pena2016-03-031-3/+7
| | | | | | | | | | | | The manage.py createsuperuser command must be run from the directory containing the Toaster database, and not from the root of the checkout directory, as the manual indicated. Amend the section to provide the correct instructions. (From yocto-docs rev: 41fa8a04c947169d971c5e1ecb4619249d1dc7b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Installation" to have TOASTER_DIR informationBelen Barros Pena2016-02-041-5/+26
| | | | | | | | | | | | | | In section 3.6 of the manual about setting up a production instance of Toaster, explain that TOASTER_DIR determines the location of the build directory, and that the checksettings command configures the build environment for Toaster. NOTE: I applied some minor fixes to the wording. (From yocto-docs rev: b900e4f3f7a1f798b82a25e350cb8626ffb5d786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated instructions for production setup.Scott Rifenbark2016-01-291-28/+15
| | | | | | | | | | | Current instructions were wrong. Applied changes to correct them. Author: Belen Barros Pena <belen.barros.pena@intel.com> (From yocto-docs rev: edbcd9e2ef35772008107ff00ebb8e6bc71b1d50) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updates on how to start Toaster.Ed Bartosh2016-01-151-59/+8
| | | | | | | | | | | | | | | Recently, the way to start Toaster has been simplified. The only way to start it now is to source toaster script. Builds can be run either from command line or from Toaster web interface. Updated instructions to start toaster according to the changes described above. (From yocto-docs rev: 2e980c9157abad073e7d08309a99cb2f515441c0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updates to toaster use chapter.Ed Bartosh2016-01-071-914/+5
| | | | | | | | | | | | * Removed obsolete bits that were already commented out of the XML file. * Added more detail to running Toaster and accessing the information. (From yocto-docs rev: d2b964e395273bde4f75ba3cd8e26a9e7d00b569) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster manual: Updated the set up and use chapterScott Rifenbark2015-10-271-15/+26
| | | | | | | | | Applied review changes from Belen. (From yocto-docs rev: 1b9a8c1ee031d0633a0ace930d014399a09e7172) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new Toaster functionality descriptions.Scott Rifenbark2015-10-271-3/+470
| | | | | | | | | | Flow and usage information has changed. Changes here reflect that from the Toaster Team. (From yocto-docs rev: 9774dec014b6d13623988b0d7c050c9e6deaad6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: New section on PREFERRED_VERSIONScott Rifenbark2015-10-211-51/+106
| | | | | | | | | | | | Added a new section in the interface use area that describes how to build a version of a recipe that is not the default version. Four new figures were added to support the description. (From yocto-docs rev: 232a875fb8fff97ce0578cf50b2a102bdaed1758) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs and others: Rewrite of the QSScott Rifenbark2015-07-281-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed redundant video.Scott Rifenbark2015-04-241-18/+13
| | | | | | | (From yocto-docs rev: 4188241b40cf1ce5b70e21cd5f65362758742b02) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new video link for toaster configuration.Scott Rifenbark2015-04-101-0/+5
| | | | | | (From yocto-docs rev: 8e418e1b203d749bd939bf0f109fb8fce6053ceb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* toaster-manual: Review edits applied.Scott Rifenbark2015-04-021-47/+32
| | | | | | | | | | Some steps updated according to Belen and a video link fixed to not point to Belen's Youtube area. (From yocto-docs rev: 557c22fdd287160f6aabac0928ce6bd8d6af3394) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Applied final review edits.Scott Rifenbark2015-04-021-53/+64
| | | | | | | | | This should be it unless there are late coming comments. (From yocto-docs rev: cb32e3330a6fe2d26425f8765689749afcd989e9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added a new video that shows fido features.Scott Rifenbark2015-04-011-0/+5
| | | | | | | (From yocto-docs rev: a94d6dec039d9b60468c0b26d48b9aa76c300afb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Created links to Youtube for the GUI vidsScott Rifenbark2015-04-011-4/+50
| | | | | | | | | | I could not get the embedded vids working very well. So we defaulted to just linking to the Youtube locations directly. (From yocto-docs rev: 95bef674ec04eec94f568ab00b94f7174d456011) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Draft of Manual.Scott Rifenbark2015-04-011-155/+765
| | | | | | | | | Fixes [YOCTO #6901] (From yocto-docs rev: 258b46b0f3e23045b5fb8c97d03dceb69db5ce20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: 2nd draft for review.Scott Rifenbark2015-02-171-247/+288
| | | | | | | | | | | Fixes [YOCTO #6901] This is the 2nd review draft of the manual. (From yocto-docs rev: 9f541e4421e0e74e59e3b3da1896b6c1254daf08) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added two chapter files.Scott Rifenbark2015-02-171-0/+326
Fixes [YOCTO #6901] These are the second and third chapters of the Toaster Manual. (From yocto-docs rev: 6ff4e3dfff391efdbb0f36dc6800bf115abcfc92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>