aboutsummaryrefslogtreecommitdiffstats
path: root/README
AgeCommit message (Collapse)Author
2024-04-09README: update to new yocto-patches mailing listTim Orling
Change the canonical, definitive place to send patches to the new yocto-patches@lists.yoctoproject.org list. Signed-off-by: Tim Orling <tim.orling@konsulko.com>
2020-06-30README: Correcting mailing list.Amber Elliot
Signed-off-by: Amber Elliot <amber.n.elliot@intel.com> Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
2020-02-05Fix backup instructions when large logs are recordedPaul Eggleton
If the database contains task logs that are over the default max packet size for MariaDB, then attempting to dump the database will fail, but it won't be immediately obvious that that has happened - the gzipped sql file will simply be truncated and have an error in it. To fix the underlying issue, add an option to the example command for database backup to increase the max packet size to 512MB. (Restoring the database doesn't seem to suffer the same issue). In future we should probably look at writing a script to do this and in it properly check the return of mysqldump so that any problems get noticed immediately. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-10-02README: add basic documentation on db backup and restorePaul Eggleton
Make it a bit easier for the user to back up and restore the database. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-08-06README: add reference to using import_layers to updatepaule/importlayersPaul Eggleton
This is now be practical to use for updating as well as the initial import. Additionally the user doesn't need to be using the debug option by default so drop it from the example command. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-07-17README: add pointer to import layer index dataPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-07-17Add license / note for django-registration-templatesPaul Eggleton
(The templates have of course been modified.) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-07-17Rework README documentsPaul Eggleton
Change the focus to really be on the docker-based setup: * Integrate docker/README into the main README * Move all documentation of the standalone setup to README.devel Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-07-17docker: add setup scriptAmber Elliot
Adding setup script for docker containers. The script will edit all necessary configuration files, build and launch all containers, and do the initial database setup - including populating the database with data supplied by the user. Changed docker/README to reflect new setup instructions. Signed-off-by: Amber Elliot <amber.n.elliot@intel.com> Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2019-07-17docker: Add docker-compose filePaul Eggleton
This makes deployment (and updates) much easier. You still need to follow some setup instructions in the docker/README file, but the number of steps is reduced and most commands simplified. Thanks to Konrad Scherer <Konrad.Scherer@windriver.com> for suggesting this (although the docker-compose.yml here was written from scratch). Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-11-19README: add missing mention of TableSorterPaul Eggleton
The RRS code uses this but we weren't mentioning that here. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-11-19Replace uitablefilter usage with jQueryPaul Eggleton
We were using uitablefilter.js to provide live filtering of table rows based upon a search field value, but it turns out this module really isn't necessary - we can accomplish the same thing using simple jQuery code. While we're at it, enable the search field on the layers list page to work in conjunction with with the drop-down layer type selection, fix pasting into the search field and refreshing with a search specified. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-11-06Replace nvd3 with Chart.jsPaul Eggleton
nvd3 and its python/django wrappers appear to be no longer actively maintained, and at least the wrappers were a bit clunky to use. Looking around for a suitable replacement, Chart.js seems capable, has no additional dependencies and is fairly simple to use. As a bonus we get to drop a few Python dependencies from our list. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-09-20Upgrade to Bootstrap 3Paul Eggleton
Use a more modern version of Bootstrap and take the opportunity to upgrade jQuery to the latest version at the same time. This provides better browser compatibility, moves to MIT license, allows us to make the site more responsive for different devices in future, and provides theming capabilities for custom installs among other improvements. (I chose to upgrade to v3 for now rather than straight to v4 as it was easier to do this gradually.) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-08-13README: add setup info for other distro comparisonsPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-08-06README: tweak to make Docker setup more prominentPaul Eggleton
The Docker-based setup method is preferred for production, so rearrange things a little to make it a bit easier to follow. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-07-19README: add an example virtualenv-based setupPaul Eggleton
A while ago I was trying to help someone new get started with a development setup for the layer index and it occurred to me that the virtualenv-based environment I am using for development isn't actually covered in the documentation, so I wrote something quick for them but didn't do anything further with it until now. Here it is in more fleshed out form for the README. Also clarify the python requirements for the update script a little bit. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-05-01requirements.txt: bump Django and other dependency versionsPaul Eggleton
Since Django 1.8 is now out of support, and we've cleaned up the issues, bump the Django requirement to 1.11 and update other dependencies at the same time. Fixes [YOCTO #12696] (requires preceding commits) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2018-02-20README: update dependency versionsPaul Eggleton
Update the minor version of Django, and replace the list of dependencies with a pointer to requirements.txt since there's not much point maintaining that in two places (and the README wasn't complete anyway). Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2017-09-01Asynchronous email notifications, task executionDiana Thayer
This patch adds asynchronous task execution using a Celery backend and RabbitMQ task queue, so that the layer submission process to proceed even in the event that sending the notification email fails, and establishing an asynchronous execution mechanism that we can use in the future e.g. for triggering parse operations from the web UI. This pertains to bug 11197: https://bugzilla.yoctoproject.org/show_bug.cgi?id=11197 It updates the README to reflect the installation and configuration of a basic RabbitMQ setup, adds a 'tasks.py' file to contain task definitions, updates the 'edit_layer_view' function to send emails to administrators about new and updated layers asynchronously, modifies the 'settings.py' to include a default configuration for a RabbitMQ connection, and updates the Dockerfile to start a Celery worker alongside the Gunicorn daemon. Fixes [YOCTO #11197]. Signed-off-by: Diana Thayer <garbados@gmail.com> Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2017-01-16README: add basic instructions for enabling OE-Classic functionalityPaul Eggleton
This wasn't documented anywhere so I've added it here. I'm not sure it'll get used outside of the live OE index but it's at least useful for anyone else who needs to debug it. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2017-01-13README: update latest tested versionPaul Eggleton
We might as well show the latest tested point release. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-10-18README: update setup instructionsPaul Eggleton
With Django 1.8 you don't need to use syncdb since migrate does all of the database structure setup (and in fact in 1.9 it has been removed - we don't support that version yet but it's good to avoid that issue in future). The only other thing that syncdb did was to create a superuser, and there is now a specific command to do that. Since you do need to actually log in as part of some of the later steps, we now tell the user explicitly to run that in the first step. Additionally, add a section about what to do when upgrading - normally this is straightforward, but if you're upgrading from prior to the Django 1.8 move then you need to fake the initial migration or it'll fail (since the structure is already present). Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-09-20Update to Django 1.8Paul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-09-20Drop south migrationsPaul Eggleton
These cannot be used with Django 1.8 and thus we need to remove them. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-08-01Use python3 commands in READMEPaul Eggleton
If you're in a virtualenv it doesn't make a difference, but outside of one it will. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-06-12Handle Python 2 and Python 3 branches in the same indexPaul Eggleton
Add a model to support setting a python command and virtualenv per branch, which allows you to parse master with python3 and krogoth with python2 for example. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-06-12Support (and require) Python 3Paul Eggleton
We need to be able to support Python 3 so that we can parse master of OE-Core with bitbake (which now requires it). This now means the interface itself and the update script require Python 3.4+. Part of the implementation for [YOCTO #9704]. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-06-12Upgrade to Django 1.6+Paul Eggleton
I'd like to be upgrading to 1.8 but that causes problems with South, and we're not quite ready to dispense with our existing migrations yet. Part of the implementation for [YOCTO #9620]. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2016-06-10update.py: allow updating all branches with one commandPaul Eggleton
Allow updating multiple branches, and if no branches are specified, update all branches that have a new "updates_enabled" flag field set to True. This avoids the need to have a separate shell script which runs update.py for each branch (and thus has hardcoded knowledge of each active branch in the index, i.e. it needs to be kept up-to-date in addition to the database.) The migration will default updates_enabled to True for all branches so if you wish to take advantage of this functionality, the flag will need to be set to False for any branches that shouldn't be updated. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2015-10-07Docker based environment setupAlex Franco
Replicate production setup in Docker containers [YOCTO #7575] Signed-off-by: Alex Franco <alejandro.franco@linux.intel.com> Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2014-09-24adding CORS policy for the APIAlexandru DAMIAN
We add the corsheaders application in order to enable the CORS policy for the read-only REST API. This is needed to allow AJAX queries to the layerindex application from a browser environment. Signed-off-by: Alexandru DAMIAN <alexandru.damian@intel.com>
2014-09-24expose REST API for layerindexAlexandru DAMIAN
This patch enables a read-only REST API for the layerindex application using Django REST Framework. The objects of types Branch, LayerBranch and LayerItem are exposed to queries so that the layerindex application can function as a Layer Source in Toaster. The library dependencies are documented in the requirements.txt file. Signed-off-by: Alexandru DAMIAN <alexandru.damian@intel.com>
2014-03-04README: update tested versions for required packagesPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2014-03-03Fix OE-Classic stats page for update to latest django-nvd3 (0.6.0)Paul Eggleton
Update d3/nvd3 js files in the process, but hold off on nv.d3.css for now because the latest version breaks the formatting/fading on tooltips. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-12-28Use Django sites framework to specify website titlePaul Eggleton
This allows specifying the site title in the database, instead of hardcoding it in the template. Just change it to something other than "example.com" to apply your own title. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-12-27README: add some instructions on creating the core layerPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-11-14README: note that LAYER_FETCH_DIR needs to be an absolute pathPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-11-13README: add instruction to run migration on installPaul Eggleton
Since South was added this is an additional mandatory step for new installations. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-09-20README: update for recent changesPaul Eggleton
* There is no longer a frontpage template * BitBake requires Python 2.7.3 so we might as well state it here also Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-09-05Add support for importing OE-Classic recipesPaul Eggleton
Add a script for doing a one-time import of OE-Classic recipe information, so comparisons against OE-Core can be performed; this is stored using a new ClassicRecipe model supporting additional fields for tracking migration status. The migration status fields can be updated as well as viewed and summarised in graph format. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-06-03Enable south and add initial migrationsPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-03-06README: clarify in licensing section that Bootstrap includes GlyphiconsPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-03-06Add introductory front pagePaul Eggleton
Give the user a friendly introduction instead of plunging them straight into the layers list. (Of course if people want to link directly to the layers list they still can.) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-03-06README: Clarify requirementsPaul Eggleton
* Add tested versions * Web server only needed for production Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-03-06Move all templates to a templates directoryPaul Eggleton
This should allow the templates to be found and swapped out more easily. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-03-05Add support for handling multiple branchesPaul Eggleton
Change the data structure to support multiple branches. At the top level there is a set list of Branch objects, and then a LayerBranch object between each layer and the maintainers, dependencies, recipes and machines, so that the set of each can be different per branch. The branch is a session option, and can be selected via a drop-down that is shown for all pages. Additionally, with this change we avoid the need to run the update script within a build environment set up with oe-init-build-env - since we need a specific version of BitBake per branch we now use our own copy of BitBake which is fetched by the script itself. The update script will need to be called multiple times however - once per branch. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-02-28README: add note about setting DEBUGPaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-02-28Add CAPTCHA to submission formPaul Eggleton
This should prevent spamming even though this is less likely with this kind of site. The CAPTCHA does not show when editing, only submitting, and is also not shown for authenticated users. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2013-02-20Add a basic about pagePaul Eggleton
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>