From 931044cd62b3c0e280b6e94faf923e1cfe25a6e8 Mon Sep 17 00:00:00 2001 From: Alex Tselegidis Date: Tue, 1 Dec 2020 09:39:25 +0200 Subject: [PATCH] Updated the update-guide.md for v1.4.0 --- docs/update-guide.md | 108 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 101 insertions(+), 7 deletions(-) diff --git a/docs/update-guide.md b/docs/update-guide.md index ddfa896d..009dfcdd 100644 --- a/docs/update-guide.md +++ b/docs/update-guide.md @@ -2,19 +2,113 @@ This page will guide you through the update procedure of your Easy!Appointments installation. You will need to follow the steps below in order to have successful results. - 1. **Backup** your files and database! This number one rule is very important for all computer systems and tools. If something breaks in your installation you might have a hard time to restore it without a backup. - 2. **Copy** and replace the new Easy!Appointment version files in your installation directory WITHOUT REPLACING THE `config.php` FILE. This is the only file that does not need to be replaced in all versions. - 3. **Open** your browser and head to the following URL `http://url-to-ea-installation/index.php/backend/update` (needs admin authorization). You should then see a "SUCCESS" message which means that your database has been successfully patched and you can now use the new version! +If you get a `500 Internal Server Error` message then you must check the error log files, located in the storage/logs directory. -If by chance you get a 500 Internal Server Error message then you must check the error log files of your server. These kind of errors comes mostly due to problematic server configuration (permissions, credentials etc). +Before you start following the steps below, make sure you **backup** your database and files. + +### Updating from v1.3.x to v1.4.x + +###### Step 1: Update your Easy!Appointments files + +Replace all files and directories in your installation directory. + +> Note: If you have any custom developed files in these directories, please make copies of them first. + +###### Step 2: Run the database migrations + +Database migrations will bring your database structure to the latest state. + +**Browser** + +Open your browser to the Easy!Appointments installation URL, login to the backend and type in the browser address the following URL to complete the database upgrade: `https://url/to/easyappointments/folder/index.php/backend/update` + +**Console** + +If you have console access to your server then head to the installation directory and run `php index.php console migrate`. + +###### Step 3: Remove unnecessary files + +The following directories are not needed: + +* /system + +The following files are not needed: + +* /autoload.php + + +### Updating from v1.2.x to v1.3.x + +###### Step 1: Update your Easy!Appointments files + +Replace all files and directories in your installation directory. + +> Note: If you have any custom developed files in these directories, please make copies of them first. + +###### Step 2: Run the database migrations + +Database migrations will bring your database structure to the latest state. + +**Browser** + +Open your browser to the Easy!Appointments installation URL, login to the backend and type in the browser address the following URL to complete the database upgrade: `https://url/to/easyappointments/folder/index.php/backend/update` + + +### Updating from v1.2.x to v1.3.x + +###### Step 1: Update your Easy!Appointments files + +Replace all files and directories in your installation directory. + +> Note: If you have any custom developed files in these directories, please make copies of them first. + +###### Step 2: Run the database migrations + +Database migrations will bring your database structure to the latest state. + +**Browser** + +Open your browser to the Easy!Appointments installation URL, login to the backend and type in the browser address the following URL to complete the database upgrade: `https://url/to/easyappointments/folder/index.php/backend/update` ### Updating from v1.1.x to v1.2.x -Version v1.2 introduces two new folders in the root directory of the project, the "engine" and the "storage" directory. Ensure that the storage directory is writable and has the correct permissions. +###### Step 1: Update your Easy!Appointments files -### Updating from v1.0 to v1.1.x +Replace all files and directories in your installation directory. -Many core files were changed in v1.1 and it would be better if you replace all the Easy!Appointments files of version 1.0 with the new ones. Use the data of the old `configuration.php` file in the new `config.php` and open the `http://url-to-ea-installation/index.php/backend/update` as already mentioned. Your new version should work just fine! +> Note: If you have any custom developed files in these directories, please make copies of them first. + +###### Step 2: Run the database migrations + +Database migrations will bring your database structure to the latest state. + +**Browser** + +Open your browser to the Easy!Appointments installation URL, login to the backend and type in the browser address the following URL to complete the database upgrade: `https://url/to/easyappointments/folder/index.php/backend/update` + +###### Step 3: Make storage writable + +Version v1.2.x introduces two new folders in the root directory of the project, the "engine" and the "storage" directory. **Ensure that the storage directory is writable and has the correct permissions.** + +### Updating from v1.0.x to v1.1.x + +###### Step 1: Update your Easy!Appointments files + +Replace all files and directories in your installation directory. + +> Note: If you have any custom developed files in these directories, please make copies of them first. + +###### Step 2: Run the database migrations + +Database migrations will bring your database structure to the latest state. + +**Browser** + +Open your browser to the Easy!Appointments installation URL, login to the backend and type in the browser address the following URL to complete the database upgrade: `https://url/to/easyappointments/folder/index.php/backend/update` + +###### Step 3: Migrate the configuration.php values + +Use the data of the old `configuration.php` file in the new `config.php`. *This document applies to Easy!Appointments v1.4.0.*