Update 5.3
Contents
Generic information
Starting the upgrade
1) Note shop prices
The shop system has changed and you have to verify the prices for regimail Professional in the updated system. The appliance tries to migrate the prices and VAT from your old shop configuration, but it may fail. So you need to know the prices!
Best to log-in to your web-administration and go to "Provider settings". Open the files "shop_standard.json" and "shop_group.json", scroll close to the bottom and note the "Price" and "Value" fields you find for 1 and 2 years. They look similar to this example (here the 2 years section):
{
"DE": "2 Jahre",
"EN": "2 years",
"FR": "2 Ans",
"Price": "180,- EUR",
"Value": 214.2,
"Length": "2 YEAR"
}
Please note the Value then from "shop_standard.json" and "shop_group.json" for both 1 and 2 years. This should represent the price including VAT.
The update will delete your manually changed footer code as it will no longer work. It replaces it by some default footer with the most used options and links. You can later modify the footer again but a screenshot of the previous footer is very helpful for that.
3) Enable maintenance mode
Please log-in to your web-administration and go to "Provider maintenance". Enable maintenance mode by clicking "Enable maintenance mode" on the upper left.
4) Do the update
To update your regify provider appliance, please log in via SSH (or PuTTY).
In case you log in with root account, you have to enter
providerConfig
to run the appliance menu.
Now select the first menu item "Check for updates". There is a huge list of packages. Use TAB to switch focus to "Yes" and press Enter to start the update. The update process can take 10 to 15 minutes or even more, depending on the amount of data in your system and the speed of your machines.
Notes about Cross-Master-Replication
If you are running a redundant system in cross-master-replication, start with the appliance that is the currently active system (working the traffic). Upgrade the second appliance directly after you upgraded the active system.
Notes about Master-Slave-Replication
If you are running a redundant system in master-slave-replication, start with the master system. Upgrade the slave directly after the master appliance.
5) Disable maintenance mode
Now, upon the update is finished and the system was restarted, please re-login to your web-administration and go to "Provider maintenance". Disable maintenance mode by clicking "Remove maintenance mode" on the upper left.
Finish with a restart
The update also updates the kernel of the system, so you need to make a restart after the update has finished.
The update will ask you for a restart and you should answer with YES.
NOTE: Logged in using SSH (PuTTY), you can restart the appliance using the appliance menu "Appliance..." -> "Other Settings..." -> "Reboot the appliance".
NOTE: In case you log in with root account, you can also enter
shutdown -r now
NOTE: The shutdown can take a minute or even more. Do not power off the machine during restart!
ToDo after upgrading
System in maintenance mode?
If you turned on maintenance mode before upgrade, the system will come up in maintenance mode after update. Please enter web-administration and use "Provider maintenance" dialog to remove maintenance mode and restore operation.
Updating prices
Please log-in to your web-administration and check the prices in "Manage (sub)providers" dialog. Some TODO tries to get the prices from your shop pages and put them to the database. It also creates an entry of type "event" in the log table. But please check the prices and VAT in the "Shop" tab of all (sub)providers. If they differ from what you noted before the upgrade (see above chapter step 1), please update them to the correct prices.
If the automatic price update has failed, you normally also get a TODO warning in web-administration (main provider only).
CSS modifications / Logo
The regify provider 5.3 has a completely reworked user interface. We are now using BULMA CSS framework to style the user area.
Therefore, any previous CSS modifications will not work any more! They even may be bad for the interface.
If you log-in to your main regify provider web-administration (master role), some TODO will automatically uncomment your existing CSS modifications for all (sub)providers. It will also try to automatically identify your current logo and tries to adapt the CSS to the new requirements. It creates an entry of type "event" in the log table, too.
Please read the TODO output carefully to look for which subprovider it maybe failed. If some update failed, the (sub)provider administrator needs to adapt the CSS for that logo manually.
Check Provider customizing page for a quick CSS template for your logo.
Branding and Corporate Identity
We identified the color as the main customization target for most regify providers. Therefore, you can now easily set your corporate color and let the system style the elements for you. Enter your (sub)provider web-administration and go to "Provider settings". In the "Contact" panel you can select the color and save. If you are the main provider administrator, you can do that for your subproviders, too. In web administration "Manage sub-providers". The "Common" tab offers the base colour selection, too.
Please note that you very likely need to refresh your webbrowser page using Ctrl+F5 to see the new generated CSS (otherwise your webbrowser uses a cached version). End users webbrowsers will load the new CSS latest on the next day.
In case you used a customized footer by changing codeFooter.php, the update will delete these customized files and reset them to default. You will see a TODO entry on first login to main provider web administration. It also creates an entry of type "event" in the log table.
Authentication form
In case you modified your authentication form, the affected sub-provider administrator will get a TODO message telling him to reset the authentication form. It also creates an entry of type "event" in the log table. You have to follow this advice in order to get a working authentication form! After you fixed the form, please click on "Done" to mark this as solved.
Links in message templates
Upon the main administrator logs in to his web administration, some TODO tries to find all default templates (regimail and regibox) and replaces any "phpSignUpMember.php" with "signup.php" and any "phpDownloads.php" with "downloads.php" to prevent future issues. It also creates an entry of type "event" in the log table for every updated file. If you added such links manually in other templates, you will need to fix them by yourself.
Check
Please log in to your web administration now and check for any problems or error messages.
