ADL Learning Record Store (LRS)

The project includes a Certbot container to generate SSL certificates for publicly available domains.

To generate a certificate and automatically restart the nginx container with the new certificate, run: sudo ./certbot/generate.sh <your-domain-name>

If the generation fails, you can restore a temporary SSL certificate using: sudo ./init-ssl.sh <your-domain-name>

The recommended method for installing the ADL LRS is using Docker and Docker Compose. This implementation is designed to support the IEEE 9274.1.1 Base Standard (xAPI 2.0).

Note: The current version is considered stable but is intended as a proof of concept for a limited number of users.

# Use Docker and Docker Compose for installation
# Refer to the project wiki for detailed step-by-step instructions

By default, the LRS uses example.com as the site name. To change this to a custom domain and name, follow these steps:

1. Enter the Django shell: sudo ./open-shell.sh
2. Run the following commands within the shell to create the new site:

   from django.contrib.sites.models import Site
   site = Site.objects.create(domain='your.domain.com', name='Your Site Name')
   site.save()

3. Update your settings.ini file to use the new SITE_ID (which will be 2 if it was the second site created):

   [site]
   SITE_ID: 2

The Docker implementation does not create a Django superuser by default. Once the LRS service is fully available (this may take some time after the containers are up), you can create an admin account by running the create-admin.sh script from the project root. This user only needs to be created once, as the Postgres container persists data across sessions.

sudo create-admin.sh

The following resources are available via the project wiki to assist with advanced setup and maintenance:

• Infrastructure: Setting up Nginx and uWSGI.
• Security: OAuth implementation help.
• Database: Procedures for clearing the database.
• Development: Information on test coverage and code profiling with cProfile.

Configuration for the database and email services is managed via the /lrs/settings.ini file.

Database Configuration

Modify the values under the [database] header in /lrs/settings.ini to connect to a different database.

SMTP (Email) Configuration

Modify the values under the [email] header in /lrs/settings.ini.

• Google: Use standard Google settings.
• Office 365 / Other providers: Ensure you enable TLS rather than SSL.

The amqp service (using RabbitMQ) is required for activity metadata. You can configure the Erlang cookie, default user, password, and virtual host via environment variables.

amqp:
  image: "rabbitmq:3-management"
  environment:
    RABBITMQ_ERLANG_COOKIE: "SWQOKODSQALRPCLNMEQG"
    RABBITMQ_DEFAULT_USER: "rabbitmq"
    RABBITMQ_DEFAULT_PASS: "rabbitmq"
    RABBITMQ_DEFAULT_VHOST: "/"

The nginx service acts as a proxy for LRS traffic on ports 80 and 443. It requires a HOSTNAME build argument. SSL automation is handled by the certbot service, which shares volumes with Nginx for certificate management.

nginx:
  build: 
    context: docker/nginx
    args:
      HOSTNAME: "${HOSTNAME}"
  ports:
    - "80:80"
    - "443:443"
  volumes:
    - ./docker/nginx/letsencrypt:/usr/share/nginx/html
    - ./docker/certbot/etc:/usr/share/keys
  links:
    - lrs

certbot:
  image: certbot/certbot
  volumes:
    - ./docker/keys:/var/lib/letsencrypt
    - ./docker/nginx/letsencrypt:/data/letsencrypt
    - ./docker/certbot/etc:/etc/letsencrypt
    - ./docker/certbot/log:/var/log/letsencrypt
  depends_on:
    - nginx

The postgres service stores LRS statements. You can configure the database name, user, and password using environment variables. Data is persisted to the local directory ./docker/data/postgres.

postgres:
  image: library/postgres:9.5
  environment: 
    POSTGRES_DB: lrs
    POSTGRES_USER: lrs_owner
    POSTGRES_PASSWORD: lrs_password
  volumes:
    - ./docker/data/postgres:/var/lib/postgresql/data

The redis service is required for handling activity metadata. Data is persisted to the local directory ./docker/data/redis.

redis:
  image: redis:7
  volumes:
    - ./docker/data/redis:/data

The lrs service runs the core ADL LRS logic via uWSGI. It depends on the postgres and amqp services. Logs are persisted to ./docker/data/lrs/logs.

lrs:
  build: 
    context: .
  ports:
    - "127.0.0.1:8000:8000"
  links:
    - postgres
    - amqp
  volumes:
    - ./docker/data/lrs/logs:/opt/lrs/logs