meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
updates [2023/10/24 16:22] – andrewmalsburyupdates [2025/06/11 08:18] (current) – separate the two update processes: cli & web wrongecho
Line 1: Line 1:
 ====== Updates ====== ====== Updates ======
  
-  * It's important to take regular (e.g. nightly) backups of your ITFlow instance, especially before updating +  * New features, bug fixes and security patches are regularly released - it's important to stay up-to-date 
-  * **Keep your ITFlow instance updated** with the latest features and security patches.  +  * It's important to take regular (e.g. nightly) backups of your ITFlow instance; **you should not attempt to run updates without a current backup** (e.g. VM snapshot) 
-  * Updates will contain changes to both the filesystem and the database schema. +  * Always look over the changelog before running updates to check for breaking changes 
-  * The updater can be accessed via **Settings > Update**. +  * Updates are a two part process: 
 +    * Download the updated files 
 +    * Apply any required database migrations
  
-===== Files =====+===== Web Interface ===== 
 +  - Login to ITFlow as an admin 
 +  - Navigate to Admin Settings > Update 
 +  - Select **Update App** 
 +  - If prompted, also select **Update database** (you may have to do this several times) 
 + 
 +===== CLI ===== 
 +  - Connect to your server via SSH as a user with root privileges 
 +  - Navigiate to the ITFlow scripts directory (usually /var/www/itflow.yourdomain.com/scripts) 
 +  - To update the app files run: ''sudo -u www-data php update_cli.php'' 
 +  - Then apply database updates: ''sudo -u www-data php update_cli.php %%--%%update_db'' (this may have to be run several times) 
 + 
 +---- 
 + 
 +---- 
 + 
 +===== Explanatory notes about updates (to be tidied up) ===== 
 +==== Files ====
  
 The majority of ITFlow updates are just changes to the PHP files. The update tab will show the latest [[https://github.com/itflow-org/itflow/commits/master|git commits]] and offer to download them for you. In the background, this is just running ''git pull''.  The majority of ITFlow updates are just changes to the PHP files. The update tab will show the latest [[https://github.com/itflow-org/itflow/commits/master|git commits]] and offer to download them for you. In the background, this is just running ''git pull''. 
  
-If you've edited any files, the auto-updater will fail - navigate to your web directory and run git pull to review and resolve the issue.+If you've manually edited any files, the updater will fail - navigate to your web directory and run git pull to review and resolve the issue.
  
 {{updates_git_pull.png?direct|}} {{updates_git_pull.png?direct|}}
  
-===== Database =====+==== Database ====
  
 After pulling down the latest files, the update page will then show if the latest database version has increased. If it has, it will offer to run the commands in //database_updates.php// to update the database. After pulling down the latest files, the update page will then show if the latest database version has increased. If it has, it will offer to run the commands in //database_updates.php// to update the database.
Line 28: Line 47:
  
  
-//Additional notes:  +**Additional notes: ** 
-  * If you run into any issues running multiple database updates, it may be worth signing out and back in again between updates. Some updates alter files in your PHP session, which might only be set during login.//+
   * The database update applies one update at a time. If there are multiple updates needed, you will need to manually cycle through each update.   * The database update applies one update at a time. If there are multiple updates needed, you will need to manually cycle through each update.
 +
 +  * If you run into any issues running multiple database updates, it may be worth signing out and back in again between updates. Some updates alter files in your PHP session, which might only be set during login.
  
 {{:updates_database.png?direct|}} {{:updates_database.png?direct|}}