Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 5.25 KB

update.md

File metadata and controls

101 lines (62 loc) · 5.25 KB
Raw

Keeping your Ilios up to Date

These instructions pertain to upgrades within the "Version 3"-branch of Ilios.

For upgrade instructions from Ilios 2 see Upgrading From Ilios 2.x.

Frontend

The Ilios Frontend is always up-to-date on our content-delivery servers at Amazon S3, but you will need to regularly run a console command on your backend instance in order ensure that your users are seeing the latest version and that they are getting all the latest features and bugfixes. To make sure you users are receiving the latest frontend code at all times, just follow these steps:

# Log in to your Ilios API (backend) server and go to the root folder of your Ilios application ('/web/ilios3' for this example)
$ cd /web/ilios3

# Then run the 'ilios:maintenance:update-frontend' console command, in the context of your the user that runs your webservices (eg. 'apache')
$ sudo -u apache bin/console ilios:maintenance:update-frontend --env=prod
Frontend updated successfully!

# and that's it!

It is a good idea to run this command often (we run it in a cron job every minute).

Though you will probably never need to deploy the Ilios 3 Frontend on your own servers, the source for the frontend code can always be found at https://github.com/ilios/frontend.

General steps

NOTE: The steps below assume that file ownership of the deployed codebase belongs to the user account that runs your web server. Therefore, commands that affect the file system should also be performed as this user. In this example, this account is apache, but it could also be www, www-data, or something else - depending on the flavour of Linux (or alternate operating system) running on your server.

  1. Back up your database. Always.

  2. Update your code to the latest desired version.

    See https://github.com/ilios/ilios/releases for the most up-to-date list of releases. There are zipped and tarball downloads included in the release notes for each version. After making sure you've moved or backed-up your learning materials directory and have a copy of all the settings in you parameters.yml file, you can replace your current code entirely with the code from one of the release distributions and run the steps below.

    If you use git to manage your Ilios you can update the code by checking it out using the respective tag name e.g., git checkout tags/v3.36.0.

  3. Rebuild the application code via composer.

    cd YOUR_ILIOS_APPLICATION_ROOT
sudo -u apache bin/setup

  4. Execute any pending database migrations.

    cd YOUR_ILIOS_APPLICATION_ROOT
sudo -u apache bin/console doctrine:migrations:migrate --env=prod --no-interaction

Version-specific steps

Upgrading to Ilios 3.105.0

The ILIOS_ELASTICSEARCH_HOSTS and ILIOS_ELASTICSEARCH_UPLOAD_LIMIT parameters have been renamed to ILIOS_SEARCH_HOSTS and ILIOS_SEARCH_UPLOAD_LIMIT to be more vendor neutral. They will need to be replaced in your configuration if you have search and indexing enabled.

Upgrading to Ilios 3.100.0

The enable_tracking and tracking_code parameters have been removed as google analytics is no longer supported. You should remove these parameters from your configuration by running:

cd YOUR_ILIOS_APPLICATION_ROOT
bin/console ilios:set-config-value --remove enable_tracking
bin/console ilios:set-config-value --remove tracking_code

Upgrading to Ilios 3.71.0

The ILIOS_DATABASE_MYSQL_VERSION parameter has been removed, instead the MySQL version should be specified in the ILIOS_DATABASE_URL as ?serverVersion=8.0. For example: ILIOS_DATABASE_URL=mysql://db_user:[email protected]:3306/db_name?serverVersion=8.0.

Upgrading to Ilios 3.69.1

A new asynchronous queue service has been added. You must run bin/console messenger:setup-transports to set it up.

Upgrading to Ilios 3.56.0

  1. parameters.yml has been replaced with ENV configuration. See env_vars_and_config for details.

  2. Individual database configuration options have been replaced with a single database URL setting (ILIOS_DATABASE_URL). See https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url for details.

Upgrading to Ilios 3.36.1

A command was added in this version to fix an issue with Learning Material metadata. After upgrading to this version you need to run the command to scan and fix your learning materials.

cd YOUR_ILIOS_APPLICATION_ROOT
sudo -u apache bin/console ilios:maintenance:fix-mime-types --env=prod

Upgrading to Ilios 3.12.0

This version adds the "AAMC Resource Type" as a new entity to the application.

Please execute the following console command after running migrations in order to load the default resource-types data set:

cd YOUR_ILIOS_APPLICATION_ROOT
mysql -u YOUR_ILIOS_DATABASE_USER -p YOUR_ILIOS_DATABASE_NAME -e "LOAD DATA LOCAL INFILE './config/dataimport/aamc_resource_type.csv' INTO TABLE aamc_resource_type FIELDS TERMINATED BY ',' ENCLOSED BY '\"' LINES TERMINATED BY '\n' IGNORE 1 ROWS"