Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
wget -qO deployll.sh https://raw.githubusercontent.com/LearningLocker/deploy/master/deployll.sh && bash deployll.sh

UPGRADING

You may choose to upgrade your Learning Locker to take advantage of new features and bug fixes. To make this process easier, it is strongly recommended that any Learning Locker running for production use has the database (Mongo) running on different servers to that of the application. This means you can seamlessly update your application without having to move your data.

...

If you plan on keeping the Mongo database on the same server as the application, you will need to perform a backup and restoration of your Mongo data between upgrades. For this reason we strongly recommend placing your database separate to your application.

LOGS

By default, logs are written to /var/log/learninglocker/

INSTALL LOG

If there is a problem installing the script, you can view the full install log output here: /var/log/learninglocker/install.log

SERVICE LOGS

Individual logs for the different services outputs (stdout) and errors (stderr) are available in this directory under the following names:

...

Logs may have slightly different names due to rotation

RESTARTING THE SERVICES

To restart the services, simply run the following command:

...

Where learninglocker is the system user you chose to install with in the script (defaults to learninglocker)

MANAGING THE SERVICES

The PM2 service manages the 4 micro-services that Learning Locker requires. This is installed by default with the install script under the system user you chose.

...

Code Block
sudo su learninglocker

SERVICE STATUS

To view the status of your processes (using the default learninglocker system user):

...

Code Block
┌──────────┬─────────┬────────┬───┬──────┬────────────┐
│ Name     │ mode    │ status │ ↺ │ cpu  │ memory     │
├──────────┼─────────┼────────┼───┼──────┼────────────┤
│ API      │ cluster │ online │ 0 │ 0%   │ 144.0 MB   │
│ UIServer │ cluster │ online │ 0 │ 0%   │ 105.8 MB   │
│ Worker   │ cluster │ online │ 0 │ 0%   │ 109.5 MB   │
│ xAPI     │ cluster │ online │ 0 │ 0%   │ 81.8 MB    │
└──────────┴─────────┴──-─────┴───┴──────┴────────────┘

SERVICE LOGS

You can view a tail of the logs by running:

...

Code Block
pm2 logs --lines 1000

RESTARTING THE SERVICES MANUALLY

You can restart all the services by running:

...

Code Block
pm2 restart UIServer

APPLICATION STRUCTURE

There are two main repositories that are installed as part of a fresh Learning Locker installation, the Learning Locker application and xAPI service. An in depth look at what both these packages do can be read in the Architecture Overview.

...

We also install the xAPI Service here, inside the current/xapi/ directory.

CONFIGURATION & ENVIRONMENT VARIABLES

Each of these applications has their own .env. These hold all the configurations that the applications require in order to run, from database settings to logging configuration.

...

A full description of all configuration values in both repositories is available in the Configuration Guide

...

PRODUCTION INSTALLATIONS

For production installations, we recommend the minimum configuration:

...

If this sounds too costly or challenging, you may wish to consider using the Learning Pool Data Cloud SaaS enterprise solution. If you require more advice for your setup, please get in touch via hello@learninglocker.net.

...

CUSTOM INSTALLATIONS

Please follow instructions here if you wish to install Learning Locker manually.