Updating the Portal (Windows)

Prerequisite for this tutorial:

OS: Windows

Before you begin

Read these instructions carefully from start to finish. Make sure that you understand each step before starting the upgrade. 

Download following installation and update files from https://download.newired.com/ into the server, where is Newired installed:
- installation file (newired-portal-X_Y_Z-x64.exe)
- update files (newired-sql-updates-X_Y_X.zip)

Setup and configuration:

PostgreSQL host: localhost
PostgreSQL port: 5432
PostgreSQL user: postgres
PostgreSQL password: __YOUR_INTERNAL_PASSWORD__
Newired Portal path: C:\Newired
Newired license file: C:\Newired\tomcat\conf\newired.license
HTTP port (tomcat internal service): 8090 (default)
Newired default language: en_US
Newired Portal URL address: http://__YOUR_SERVER__

Steps:

Run PowerShell as Administrator Using the Run Window (WIN+R)

Windows PowerShell will launch with the rights of the current user.

If you want to switch from normal mode to administrator mode, type the following PowerShell command and press Enter.

Start-Process powershell -Verb runAs

Stop the Newired service:

net stop "Newired Portal"

Stop the Newired PostgreSQL service:

net stop "Newired PostgreSQL"

Backup all application files inc. PostgreSQL :

robocopy "C:\Newired\" "C:\Newired_backup\Newired\" /e /zb /copyall

To see if backup was really made:

dir C:\

Terminal output:

Start the Newired PostgreSQL service for individually backup dump database:

net start "Newired PostgreSQL"

C:\Newired\postgresql\bin\pg_dump.exe -C -h localhost -p 5432 -U postgres -W -d newired -f C:\Newired_backup\newired.sql

C:\Newired\postgresql\bin\pg_dump.exe -C -h localhost -p 5432 -U postgres -W -d collector -f C:\Newired_backup\collector.sql

C:\Newired\postgresql\bin\pg_dump.exe -C -h localhost -p 5432 -U postgres -W -d report -f C:\Newired_backup\report.sql

Again, check if files has been created. You should see collector.sql, newired.sql and report.sql files:

dir C:\Newired_backup\

Terminal output:

Uninstall your current version of Newired portal (pictures might differ in each version of Newired):

C:\Newired\uninstall.exe

Uninstall the current version of Newired Editor:

C:\Newired\editor\uninstall.exe

Remove its installation folder:

Remove-Item C:\Newired -Recurse

Download version of Newired Portal you want to upgrade to and SQL update scripts from https://download.newired.com and save files listed below to your drive (C:\ by default is recommended) on your server (extract db update sql scripts from archive into the drive):

Since version 23.2.0 and later there is no SQL script for database update (database_updateX.X.X_to_Y.Y.Y_newired.sql).

Newired-Portal-XY_X_X-x64.exe
database_updateX.X.X_to_Y.Y.Y_newired.sql

dir C:\

You should see this files in terminal output (in case of upgrade trough more than one version, you need all sql update scripts from your current version to your desired one):

Start the installation of desired portal version:

C:\Newired-Portal-XX_X_X-x64.exe

You must agree to the license:

You set the path where you want to install the portal. It is important to remember this because we will copy the data from the previous installation here:

Select Postgres SQL and Reporting components. If you used the Editor on the server, then it was chosen too.

You leave the default settings:

Enter your original license that we backed up at the beginning of the update process.

And here you have to set up your domain where you want the portal to run. You have created a certificate for this domain. It is important to fill this correctly, otherwise the update process will fail.

Select the language you had set in the previous installation:

The portal with your specified address and your certificate will not run correctly. It's alright.

Now we move your previous configuration and certificate to a new installation.

Stop the Newired service:

net stop "Newired Portal"

Remove production databases of just installed Newired version:

C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -c "Drop DATABASE newired;" -c "DROP DATABASE collector;" -c "DROP DATABASE report;"

Import procedure our databases that we backed up at the beginning of the upgrade process (SQL files includes creating Newired, collector and report databases):

C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -f C:\Newired_backup\newired.sql

C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -f C:\Newired_backup\collector.sql

C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -f C:\Newired_backup\report.sql

You can skip next 3 steps if you are upgrading to 23.2.0 or later version:
Run gradually all the SQL scripts to update the database from previous version to installed one:

1. Newired database: C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -d newired -f C:\database_updateX_to_Y_newired.sql

2. Report database C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -d report -f C:\database_updateX_to_Y_report.sql

3. Collector database C:\Newired\postgresql\bin\psql.exe -h localhost -p 5432 -U postgres -W -d collector -f C:\database_updateX_to_Y_collector.sql

Note: It is necessary to run all SQL scripts in order from oldest to newest version . SQL files of previous versions can be found at https://download.newired.com

Copy the tomcat configuration from the previous installation (from version 20.1 and upwards):

Copy-Item -Path C:\Newired_backup\Newired\tomcat\conf\ -Destination C:\Newired\tomcat\ -Recurse -Force

Copy the uploaded media files from previous installation

robocopy "C:\Newired_backup\Newired\data\minio\media\uploaded\" "C:\Newired\data\minio\media\uploaded\" /e /zb /copyall /MIR

Copy the screenshot's data from the previous installation, exclude folder with name "175" (from version 21.1.0 and upwards): 

mkdir -p C:\Newired_backup\175-backup
robocopy "C:\Newired\data\minio\screenshot\175\" "C:\Newired_backup\175-backup\" /e /zb /copyall
robocopy "C:\Newired_backup\Newired\data\minio\screenshot\" "C:\Newired\data\minio\screenshot\" /e /zb /copyall
rm -r 'C:\Newired\data\minio\screenshot\175\'
Move-Item -Path C:\Newired_backup\175-backup\ -Destination C:\Newired\data\minio\screenshot\175

robocopy "C:\Newired_backup\Newired\content\" "C:\Newired\content\" /e /zb /copyall

Check folders (if they exist in version from which have you upgraded)  C:\Newired_backup\Newired\plugins and C:\Newired_backup\Newired\themes
Copy if there are other plugins and themes than default to C:\Newired\plugins and C:\Newired\themes
Default Plugins and Themes must be new from your currently installed new version.

If you are updating from previous versions to version 22.2.0 and above (only if you are updating from version below 22.2.0), your currently published content will not work, since there has been added protection of content delivery and object storage. Now you have 2 options:

1. Publish new version
2. Disable protection via properties

newired.contentDelivery.protection.enabled=false

newired.objectStorage.protection.enabled=false

Eventually, in some versions, there are changes in configuration of application (properties). Those changes depend on version of installed Portal. Those changes are not automatically updated and must be updated manually. Following table will show what changes are made in each version and how to proceed to apply those changes.

newired.appsPath=c\:\\Newired\\apps

newired.objectStorageUrl=http://localhost:8090/newired/storage

newired.versionExportTemplatesPath=c\:\\Newired\\templates

newired.storage.access.key=objectstorageadmin
newired.storage.access.secret=objectstorageadmin
newired.storage.url=http://localhost:9000

newired.screenshots.enabled=true

newired.defaultRuntimeOverlayLanguage=en_US 

spring.mail.host=<insert value here>

spring.mail.port=<insert value here>

spring.mail.username=<insert value here>

spring.mail.password=<insert value here>

spring.mail.properties.mail.smtp.auth=false

spring.mail.properties.mail.smtp.starttls.enable=false

Note: If you are upgrading trough more versions, each of version changes must be applied.

Start the Newired service

net start "Newired Portal"

If you have problems installing older versions than is the latest one, try to look into older articles for upgrade between each version.