FileCloud Server Version 20.2 Upgrading FileCloud FileCloud Server Version 20.2 Upgrading FileCloud
Copyright Notice
© 2020 CodeLathe Technologies, Inc. All rights reserved.
No reproduction without written permission.
While all reasonable care has been taken in the preparation of this document, no liability is accepted by the authors, CodeLathe Technologies, Inc., for any errors, omissions or misstatements it may contain, or for any loss or damage, howsoever occasioned, to any person relying on any statement or omission in this document.
Any questions regarding this document should be forwarded to:
CodeLathe Technologies, Inc. 13785 Research Blvd, Suite 125 Austin TX 78750, USA Phone: U.S: +1 (888) 571-6480 Fax: +1 (866) 824-9584 Email: [email protected]
1. Upgrade FileCloud ...... 4 1.1 Upgrade using Admin Portal ...... 6 1.2 Upgrade using Update Tool (Windows Only) ...... 9 1.3 Release Notifications ...... 13 1.4 Backup FileCloud Before Upgrading ...... 14 1.5 Manually Updating Windows ...... 15 1.6 Run the LINUX Upgrade Script ...... 19 Upgrade FileCloud
The ability for an administrator to be notified by email if a new update or upgrade can be installed is available in FileCloud Server version 18.2 and later.
Administrators must keep FileCloud Server up-to-date with the latest version to take advantage of the new features, enhancements, and fixes for issues found in previous versions.
How do I know if an upgrade is available?
CodeLathe will always inform customers when a new upgrade is available. When you log on to the Admin Portal, the Admin Dashboard will also alert you to the fact that you can install an update.
The Version section is right next to the License section on the Dashboard.
To check for updates on a weekly basis:
1. Open a browser and log in to the Admin Portal. 2. From the left navigation panel, click Settings. 3. On the Manage Settings screen, select the Admin tab. 4. Scroll down to the Check For Updates checkbox. 5. Select the checkbox and then click Save.
To stop receiving the weekly email, just clear this checkbox.
Custom settings in configuration files that are replaced during upgrade are not reset in the new configuration files.
Check If the following files are replaced with newer versions during upgrade, and in the case that they are replaced, reconfigure any custom settings after upgrade:
C:\xampp\apache\conf\httpd.conf C:\xampp\apache\conf\extra\httpd-filecloud.conf
Release Upgrade Scenarios Upgrade Notes Release Notes
4 20.1 Upgrading from ANY VERSION to 20.1 20.1 Upgrade Notes 20.1 Release Notes New Message Queue System is a REQUIRED service that needs to be running for FileCloud to be functional from 19.1 onwards Please ensure the Message Queue Service is running after upgrade before opening up for live access You CANNOT upgrade Windows and Linux using the Admin Portal.
19.3 Upgrading from ANY VERSION to 19.3 19.3 Upgrade Notes 19.3 Release Notes New Message Queue System is a REQUIRED service that needs to be running for FileCloud to be functional from 19.1 onwards Please ensure the Message Queue Service is running after upgrade before opening up for live access You CANNOT upgrade Windows and Linux using the Admin Portal.
19.1 Upgrading from ANY VERSION to 19.1 19.1 Upgrade Notes 19.1 Release Notes New Message Queue System is a REQUIRED service that needs to be running for FileCloud to be functional from 19.1 onwards Please ensure the Message Queue Service is running after upgrade before opening up for live access You CANNOT upgrade Windows and Linux using the Admin Portal.
18.2 Upgrading from 18.1 to 18.2 18.2 Upgrade Notes 18.2 Release Notes There are no operating system or software update requirements You can upgrade Windows and Linux FileCloud instances using the Admin Portal
Upgrading from 17.3 or older to 18.2
A full system upgrade is required for all existing installations
18.1 For all versions before 18.1: 18.1 Upgrade Notes 18.1 Release Notes A full system upgrade is required for all existing installations
Backup FileCloud Before Upgrading
There are various ways you can complete an update:
For releases that DO NOT require a full system upgrade:
Upgrade using Admin Portal
For releases that DO require a full system upgrade:
WINDOWS: Update Tool
LINUX: Upgrade Script
5 Upgrade using Admin Portal
Upgrade Steps Updating Systems That Cannot Connect Outside Updating CentOS Systems
If you are using Linux or if you are upgrading just the FileCloud application, you can upgrade your installation using the steps below.
Upgrade Steps
1. Login into the admin UI. Click Upgrade at the bottom of the navigation panel.
If there are no new updates available, the Manage Upgrade window appears as:
If there is an upgrade available, the Manage Upgrade window appears as:
6 1.
2. If there is an upgrade available, click Start Upgrade. The following window opens:
3. Click OK. The upgrade process begins. When it is complete, messages similar to the following appear on the Manage Upgrade page.
7 3.
4. In the navigation bar, click Installation Checks directly above the Upgrade link and make sure that the installation is free of errors. 5. Refresh the browser UI (Ctrl + F5) to get the latest updated User Interface.
Updating Systems That Cannot Connect Outside
If your FileCloud server cannot connect to our update server to download the packages directly, you can download the file_cloud.zip to a local folder and update your installation using the local path.
Open the WWWROOT\config\cloudconfig.php file and edit the following entry for example, if the zip folder is located in c:\users\administrator\Downloads folder, then simply do the following:
define("TONIDOCLOUD_UPDATE_URL_OVERRIDE","file://C:\\Users\\Administrator\\Downloads\\file_cloud.zip");
Updating CentOS Systems
In CentOS, live admin UI upgrade is not possible due to OS security restrictions. However, the update zip can be downloaded and then upgraded. Before the upgrade, make sure to disable SELinux. Download the upgrade zip file and assign rwx permissions to the file_cloud.zip file and its parent folder. For example, if your zip path is /opt/fcupgrade/file_cloud.zip, then do the following:
CentOS Permissions
cd /opt chmod 777 fcupgrade chmod 777 file_cloud.zip
Then open the WWWROOT\config\cloudconfig.php file and update the value of the following entry with your zip file location.
define("TONIDOCLOUD_UPDATE_URL_OVERRIDE","/opt/fcupgrade/file_cloud.zip");
8 Upgrade using Update Tool (Windows Only)
STEP 1: Backup existing installation
FileCloud installation environment Backup steps
Windows OS and installation without backup tool Windows manual backup
STEP 2: Preparing for update
1. Download the FileCloud Windows Update Tool from http://patch.codelathe.com/tonidocloud/live/installer/cloudupdatetool.zip 2. Unzip the downloaded package.
a. Extract all files from Zip into a folder. 3. Download the FileCloud Windows Update Package . 4. Copy filecloudupdate.zip file into "cloudupdatetool" folder. 5. Now, navigate to "cloudupdatetool" folder and double click on "cloudupdate.exe" binary to launch. The following window opens:
9 STEP 3: Update
1. Open the "FileCloud Control Panel" and click on "Stop" against these running services. ( If you are upgrading a HA system, stop all the nodes (All DB servers of the replica set as well as the apache web servers on each of the nodes).) If running Memcache, make sure it is stopped too.
2. Ensure that the "Install Folder" shows the location of your XAMPP folder. This location is auto-detected, but it may not be able to determine it correctly if there are multiple XAMPP folders. If it is not correct, select the correct XAMPP install folder. 3. Click on "Start" on the CloudUpdate application to begin the upgrade. (Repeat steps 1-3 for each of the nodes for HA system). The tool must be able to connect to the internet in order to download the update package. Please contact our suport ([email protected]) if you see any errors in this step.
10 3.
4. If you are running multi-tenant FileCloud, make sure the database post upgrade script is run correctly.
cd c:\xampp\htdocs\resources\backup c:\xampp\php\php.exe fcpostupgrade.php 5. Once the nodes are updated, start each of the nodes using the cloud control panel.
11 5.
6. Message Queue is an important service and must be started after the upgrade. 7. Open the install URL http://
For Filecloud upgrade on Cluster, Please contact [email protected]
12 Release Notifications
You can learn about new FileCloud Server releases in the following ways:
By subscribing to the FileCloud Mailing List
By seeing the version update in the FileCloud Admin Portal
Mailing List
When you register with CodeLathe, you will automatically be added to the FileCloud Mailing List.
If you are not receiving FileCloud emails, you can Subscribe to the FileCloud Mailing List.
Admin Portal
When you log in to the Admin Portal, the default view on the dashboard includes update information, as shown in Figure 1.
Figure 1. Sample Admin Dashboard
13 Backup FileCloud Before Upgrading
Before any updating current FileCloud installation, it is important to backup your data!
Based on your installation environment, choose one of the following links to perform backup:
Linux tool backup
Linux manual backup
Windows manual backup
14 Manually Updating Windows
New versions of FileCloud might be released from time to time and it might be important to keep your FileCloud installation up to date so that you get all the latest bug fixes, security patches and new features.
Getting Notified of New FileCloud Releases
Generally, new FileCloud release availability will be notified in two ways:
1. By subscribing to the FileCloud Mailing List 2. By seeing the version update available in the FileCloud Admin interface
Updating FileCloud
IMPORTANT NOTE
Before any installation occurs, it is important to backup your data
STEP 1: Backup existing installation
FileCloud installation environment Backup steps
Windows OS and installation without backup tool Windows manual backup
STEP 2: Preparing for update
1. Download the FileCloud update from the supplied URL and unzip it into a temporary location (say C:\cloud_update).
2. This step is important because you don't want to overwrite any local changes made with the previous FileCloud installation. Remove the following list of files from the unzip location(C:\cloud_update).
Cleanup downloaded FileCloud update
1) [config] 2) [scratch] 3) localconfig.php 4) .htaccess 5) [resources/customization] 6) [resources/docs] 7) [resources/images] 8) [resources/templates]
3. Beginning in FileCloud 20.1, to sign into the admin portal for multi-tenancy, enter the username for the superadmin user and encrypt your password in the multi.php file. See Password encryption and logging in to a multi-tenant admin portal for instructions on encrypting your password.
STEP 3: Update
1. Open the "FileCloud Control Panel" and click on "Stop" against these running service
15 1.
2. Copy over the cleaned update onto your web server's document root. Here we assume [C:\xampp\htdocs] as the document root. Check your installation for correct values. 3. Start Webserver and Database service first, then you can start the other services based on the requirement.
16 3.
4. Open the install URL http://
8. If there was a Database Schema change, you will have to click on "Update" and the database will be upgraded.
17 9. If new configuration items were added, you will have to add them to the appropriate configuration files as specified in the Config Files and re-run the check till the checks pass. 10. Optional: After install checks are all OK, you can delete the "install" folder from the document root. 11. Your upgrade is now complete.
18 Run the LINUX Upgrade Script
The upgrade script for full upgrades of FileCloud Server is available in version 18.1 and later.
The script method is fully compatible with the following versions of Linux:
Ubuntu 16.04.x LTS Ubuntu 18.04 CentOS 7.x RHEL 7.x Debian 9 stretch
The script method is not compatible with:
Ubuntu 20.04 CentOS 8.x RHEL 8.x
Upgrading your Linux operating system causes FileCloud to be uninstalled. Make sure you have backed up FileCloud before upgrade, and re-install FileCloud afterwards.
As an administrator, you can use filecloudcp (FileCloud control panel) to perform a full upgrade of a FileCloud instance regardless of the version (Debian, Fedora, etc).
The control panel runs a script that opens a basic interface to step you through the installation or upgrade process.
To navigate the interface, use the following keyboard keys:
Key Action
Arrow UP scroll through the previous options in a field
Arrow Down scroll through the next options in a field
Spacebar move to the next field
Tab selects the highlighted option
Show me the commands for filecloudcp
Full Upgrade for LINUX
Requirements:
The FileCloud instance must be accessible to the external network (Internet) The script commands must be executed with root permissions
If the FileCloud Instance doesn't have access to Internet, please contact our support team for assistance.
Step 1. To use filcloudcp to run the upgrade script, type the following command:
~# filecloudcp -u
filecloudcp CLI is only available from v18.1
19 Step 1(Alternative). After logging in, review the packages to be updated, and then to run the upgrade script, type the following command:
~# wget http://patch.codelathe.com/tonidocloud/live /installer/filecloud-liu.sh && bash filecloud-liu.sh
Step 2. On the Installer and Upgrade screen, to start the process and select Proceed, press Tab.
If you are having problems, to click Cancel, use the spacebar to highlight Cancel, and then press the Tab key.
Step 3. On the Welcome screen, to click OK, press the Tab key.
To review the policies you are agreeing to:
The terms of service can be found here: https://www.getfilecloud.com/tos/
The privacy policy can be found here: https://www.getfilecloud.com/privacy/
Step 4. The Installer and Upgrader with inform you that FileCloud is already installed.
a. To click OK, press the Tab key.
Step 5. The Installer and Upgrader with inform you that a new version of FileCloud is available. a. To click OK, press the Tab key.
Step 6. On the Upgrader screen, to start the upgrade and select Proceed, press Tab.
If you are having problems, to click Cancel, use the spacebar to highlight Cancel, and then press the Tab key.
Step 7. On the Upgrader screen, to click OK, press the Tab key.
To review the policies you are agreeing to:
The terms of service can be found here: https://www.getfilecloud.com/tos/
The privacy policy can be found here: https://www.getfilecloud.com/privacy/
Step 8. On the Upgrader screen, to start the database backup and select Proceed, press Tab.
If you do not want to do a backup, to click Skip, use the spacebar to highlight Skip, and then press the Tab key.
20 It is recommended that you complete a backup manually or through this upgrade script before upgrading FileCloud Server.
Step 9. On the Upgrader screen, to start the webroot backup and select Pr oceed, press Tab.
If you do not want to do a backup, to click Skip, use the spacebar to highlight Skip, and then press the Tab key.
It is recommended that you complete a backup manually or through this upgrade script before upgrading FileCloud Server.
Step 10. If Solr is detected, it will be upgraded.
Notes
What is Solr?
Solr is an open source enterprise search platform. It provides users with the following features:
Content search for file types such as txt, pdf, doc, docx, xls, xlsx, ppt, pptx Regex support for file/folder name searches
Step 11. You will be advised that FileCloud Server has been upgraded. This completes the upgrade process.
a. To click OK, press the Tab key.
Step 12. For users running multi-tenant FileCloud: Beginning in FileCloud 20.1, to sign into the admin portal for multi-tenancy, enter the username for the superadmin user and encrypt your password in the multi.php file. See Password encryption and logging in to a multi-tenant admin portal for instructions on encrypting your password.
21