Migration Guide

From Easyrec Wiki
Jump to: navigation, search

If you are already running easyrec and you want to upgrade to a newer version, download and deploy the latest version of easyrec to your webserver. You can find all easyrec versions here [1].

!!!Always make sure to backup your database before updating to a newer version of easyrec!!!


Configuring MySQL

Since version 0.95 easyrec uses InnoDB as the default database storage engine. Unfortunately as configured out of the box InnoDB performs very poorly so we strongly advise you to properly configure MySQL according to our recommended InnoDB settings.

This is a crucial step to ensure good performance of easyrec!

When accessing the URL where the latest version of easyrec was deployed e.g.http://myserver.com/easyrec-web for the first time, you will be guided through the migration:

Database connection setup

As a first step you will have to setup the database connection before you can start to migrate.

Easyrec installer page1 095.PNG

Simply enter the details about your database connection and the username/password created when installing easyrec for the first time.

Field Explanation
Database Host The host the database is located on. If the database is located on the same host as the web server use "localhost".
Database Name The name of the MySQL database you created.Note: If the MySQL server is configured to listen an a port other than the MySQL default port (3306), add the port to the hostname, separated by a colon (e.g. 'myserver:4711').
Username The username used to access the easyrec database.Ensure that the user has SELECT, INSERT, UPDATE, DROP and DELETE permissions on the easyrec database. For security reasons it is strongly suggested that you do not use a database superuser account.
Password The user password for accessing the easyrec database.

Once you have entered appropriate values in each field click the 'continue' button. easyrec will try to establish a connection to the database server using the information you provided in the form. If any problems should arise, an error message hinting at the cause of the problem will be displayed. If the connection attempt was successful you will progress to the next step.

Database migration

The next step allows you to migrate the easyrec database to the latest version. You can also rebuild the database from scratch. Since easyrec switched to the MySQL InnoDB database engine with version 0.95 you will see an alert message to remind you of properly configuring your MySQL database settings. This is a crucial step since unfortunately InnoDB as configured out of the box performs very poorly.

Easyrec installer page2 migrate innodDBalert 095.PNG

Additionally the alert message points out that depending on the size of your database, the migration process may take a long time in case you choose to keep your existing data - especially if you did not configure MySQL correctly (see InnoDB settings). If you are sure that your database configuration is correct click ‘OK’ to proceed.

Easyrec installer page2 migrate 095.PNG

WARNING: Be aware that all easyrec tables will be deleted from the database specified in case you click on 'clear database'

easyrec feature selection

If database initialization was successful you will be directed to the easyrec feature selection page.

Easyrec installer page3 095.PNG

Field Explanation
Use REST enable easyrec REST API. This is the default way to communicate with easyrec.
Use SOAP enable easyrec SOAP API if you want to access the easyrec API using the SOAP protocol.
Developer Mode This mode enables detailed debug output and enhanced monitoring at the cost of performance. Activate this option only on easyrec instances intended for development use. The use of this feature in production environments is strongly discouraged!

The default way to communicate with easyrec is a REST-like API. If this is not a viable option for your usage scenario you can also choose to integrate easyrec into your application environment using the SOAP protocol. Parallel operation of both interface technologies at the same time is possible.

Developer mode just enables detailed log output about internal method calls and response values as well as more detailed performance profiling information. Unless you are a developer without direct debug access to the machine running easyrec you will want to leave this feature OFF.

By clicking the 'continue' button, easyrec will proceed to load and initialize all the services necessary for providing the selected features. This operation may take some time (usually several seconds up to 1 minute) to complete. If everything loaded according to plan you will be forwarded to the final step of the easyrec installation process.

Ready to go

Congratulations! You have migrated easyrec successfully. You are now ready to start using the latest version of easyrec.

Easyrec installer page5 migrate 095.PNG

The final screen informs you of the successful completion of the easyrec setup process. By clicking the 'login page' link you will be forwarded to the login page.

Easyrec installer page6 095.PNG

Personal tools

easyrec documentation