ADL's Open Source Learning Record Store (LRS) is used to store learning data collected with the Experience API.
Clone or download
Latest commit ba18dd5 Apr 21, 2018

readme.md

ADL LRS

Installation tested on Ubuntu 14.04 machine with Python 2.7.6, Ubuntu 14.04+ is recommended. Updated to be compliant with the 1.0.3 xAPI spec.

This version is stable, but only intended to support a small amount of users as a proof of concept. While it uses programming best practices, it is not designed to take the place of an enterprise system.

Installation

Install Postgres (The apt-get upgrade is only needed if you're running Ubuntu 14. If running 15+ you can skip to installing postgresql. Also version 9.4+ is needed)

admin:~$ wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
admin:~$ sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" >> /etc/apt/sources.list.d/postgresql.list'
admin:~$ sudo apt-get update
admin:~$ sudo apt-get upgrade

admin:~$ sudo apt-get install postgresql-9.4 postgresql-server-dev-9.4 postgresql-contrib-9.4
(can install 9.5 if on Ubuntu 16)

admin:~$ sudo -u postgres createuser -P -s <db_owner_name>
Enter password for new role: <db_owner_password>
Enter it again: <db_owner_password>
admin:~$ sudo -u postgres psql template1
template1=# CREATE DATABASE lrs OWNER <db_owner_name>;
template1=# \q (exits shell)

Install Prerequisites

admin:~$ sudo apt-get install git fabric python-setuptools python-dev\
    libxml2-dev libxslt1-dev gcc
admin:~$ sudo easy_install pip
admin:~$ sudo pip install virtualenv

Clone the LRS repository

admin:~$ cd <wherever you want to put the LRS>
admin:~$ git clone https://github.com/adlnet/ADL_LRS.git
admin:~$ cd ADL_LRS/

Set the LRS configuration

Create a settings.ini file and place it in the adl_lrs directory. Visit the Settings wiki page to set it up.

Setup the environment

admin:ADL_LRS$ fab setup_env
admin:ADL_LRS$ source ../env/bin/activate
(env)admin:ADL_LRS$

Setup the LRS

This creates the top level folders, logs and media at the same level as the project folder, ADL_LRS. Throughout the readme and the other install guides for celery and nginx you will most likely want to direct any log files to the logs directory. Inside of logs there are directorys for celery, supervisord, uwsgi and nginx.

(env)admin:ADL_LRS$ fab setup_lrs
...
You just installed Django's auth system, which means you don't have any superusers defined.
Would you like to create one now? (yes/no): yes
Username (leave blank to use '<system_user_name>'):
E-mail address:
Password: <this can be different than your system password since this will just be for the LRS site>
Password (again):
Superuser created successfully.

...

If you get some sort of authentication error here, make sure that Django and PostgreSQL are both using the same form of authentication (adl_lrs/settings.py and pg_hba.conf) and that the credentials given in settings.py are the same as those you created.

IMPORTANT: You MUST setup celery for retrieving the activity metadata from the ID as well as voiding statements that might have come in out of order. Visit the Using Celery wiki page for installation instructions.

Starting

While still in the ADL_LRS directory, run

(env)dbowner:ADL_LRS$ ./manage.py runserver

This starts a lightweight development web server on the local machine. By default, the server runs on port 8000 on the IP address 127.0.0.1. You can pass in an IP address and port number explicitly. This will serve your static files without setting up Nginx but must NOT be used for production purposes. Press CTRL + C to stop the server

Set your site domain

Visit the admin section of your website (/admin). Click Sites and you'll see the only entry is 'example.com' (The key for this in the DB is 1 and it maps back to the SITE_ID value in settings). Change the domain and name to the domain you're going to use. If running locally it could be localhost:8000, or if production could be lrs.adlnet.gov (DON'T include the scheme here). Once again this does not change the domain it's running on...you want to set that up first then change this value to your domain name.

Whenever you want to exit the virtual environment, just type deactivate

For other ways to start and run the LRS, please visit our Wiki.

Test LRS

(env)dbowner:ADL_LRS$ fab test_lrs

Helpful Information

Contributing to the project

We welcome contributions to this project. Fork this repository, make changes, and submit pull requests. If you're not comfortable with editing the code, please submit an issue and we'll be happy to address it.

License

Copyright ©2016 Advanced Distributed Learning

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.