Milkhan/trax2-starter-lrs

TRAX LRS 2.1 - Starter Edition

About TRAX LRS

TRAX LRS is an xAPI conformant Learning Record Store (LRS) built with Laravel.

It focuses on the core features of an LRS, and that's it!

We want to keep it simple and clean, and give you the freedom to build what you want around it.

Fore further information, visit http://traxlrs.com

Sofware License & Copyright

TRAX LRS Starter Edition is distributed under the GNU-GPL3 license.

Copyright 2022-2024 Sébastien Fraysse, http://fraysse.eu, sebastien@fraysse.eu.

Server Requirements

Apache 2.4

• mod_rewrite

PHP 8.1 to 8.3

Check that your PHP version and configuration is valid both for PHP Web & CLI. The following extensions are required:

• Ctype
• cURL
• DOM
• Fileinfo
• Filter
• Hash
• Mbstring
• OpenSSL
• PCRE
• PDO (PDO_MYSQL / PDO_PGSQL)
• Session
• Tokenizer
• XML

Database

• MySQL 5.7.7+
• MariaDB 10.10+
• PostgreSQL 12+

Utilities

• Git
• Composer 2

Upgrade from TRAX LRS 2.0.x

In order to upgrade TRAX LRS from version 2.0.x, we recommend to install the last release of TRAX LRS in a different location and then, to make a copy the .env file from your previous installation.

Fresh install

First Steps

Assuming that you want to install TRAX LRS in a folder named traxlrs:

git clone https://github.com/trax-project/trax2-starter-lrs traxlrs
cd traxlrs
composer install

File Permissions

The folders storage and bootstrap/cache must be writable both by the webserver and the console user. Assuming that the ownership has been properly set, you should be able to assign a 0775 permission to the folders and subfolders and a 644 permission to the files. Check this post for further details: https://laracasts.com/discuss/channels/laravel/proper-folder-permissions

If you are not sure how to configure this, you can use the following commands FOR TESTING PURPOSE ONLY.

chmod -R 777 bootstrap/cache
chmod -R 777 storage

Web Server

For security reasons, only the public folder should be accessible by the web server. Create a virtual host and configure the document root to traxlrs/public.

Database

Create an empty database with the utf8mb4_unicode_ci encoding. Then, at the root of the application folder, make a copy of the .env.example file, rename it .env and enter your database settings.

MySQL/MariaDB example:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=traxlrs
DB_USERNAME=root
DB_PASSWORD=

PostgreSQL example:

DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=traxlrs
DB_USERNAME=postgres
DB_PASSWORD=aaaaaa

App URL

In the .env file, you must set the public URL of your TRAX LRS application :

APP_URL=http://traxlrs.test

Last Steps

php artisan key:generate
php artisan migrate

Admin Account

You can now create an admin account with the following command. This will give your credentials to log into the application.

php artisan admin:create

Additional commands are available to manage the admin accounts:

php artisan admin:list
php artisan admin:update
php artisan admin:delete

Production server

In the .env file, changes settings from:

APP_ENV=local
APP_DEBUG=true

To:

APP_ENV=production
APP_DEBUG=false

To optimize performances, you can run the following commands.

php artisan config:cache
php artisan route:cache

The php artisan config:cache command must be ran again after each config change.

Known issues

SQLSTATE[42000]: Syntax error or access violation: 1071

If you get this error during the php artisan migrate command, check your version of MySQL or MariaDB. Since TRAX LRS 2.0.2, MySQL versions older than 5.7.7 are not supported anymore. MariaDB versions older than 10.3 are not supported.

404 error on the main page

TRAX LRS has a /public/.htaccess file with some Apache directives. When these directives are ignored by Apache, this leads to a 404 error. In this case, check the httpd.conf file of Apache and try to set the AllowOverride option to All:

<Directory "path/to/laravel/project/public">
    Allowoverride All
</Directory>