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
backups [2023/09/17 08:58] – [Master Encryption key] wrongechobackups [2023/12/16 10:09] (current) – layout wrongecho
Line 1: Line 1:
 ====== Backups ====== ====== Backups ======
  
-As ITFlow will hold essential data about you and your clients, it is essential that you take (and test) regular backups, in addition to on-demand backups before performing updates.+As ITFlow will hold essential data about you and your clients, it is essential that you take (and test) regular nightly backups, in addition to on-demand backups before & after performing updates.
  
-{{backups.png?400|}}+Summary:
  
-Backups are likely best achieved by creating some sort of image/snapshot of the entire virtual machine running ITFlow. This allows you to easily capture the files & database.+**1. You should regularly back up up the __entire Virtual machine__ running ITFlow.** 
 +  * The terminology for this may differ depending on your virtualization platform, but essentially you want an image/snapshot of the entire VM.  
 +  * This allows you to easily capture & restore the files & database. 
  
-ITFlow is split into three main areas - all of which need backing up:+**2. You should retrieve and securely store your __master encryption key__** 
 + 
 + 
 + 
 +---- 
 + 
 + 
 +ITFlow is split into three main areas. If you are unable to backup the entire VM, you'll need to backup the files & database individually 
  
   * Files   * Files
   * Database   * Database
   * **Master Encryption key**   * **Master Encryption key**
 +
 +{{backups.png?400|}}
  
 ===== Files ===== ===== Files =====
Line 21: Line 32:
   * Your MariaDB database will contain all information entered into ITFlow.    * Your MariaDB database will contain all information entered into ITFlow. 
   * Each database update will change the schema - restoring an older backup may fail or not work as intended as fields will have been added/removed   * Each database update will change the schema - restoring an older backup may fail or not work as intended as fields will have been added/removed
-  * It is essential that you back up the databse regularly, and **perform an on-demand backup before and after performing updates**.+  * It is essential that you back up the database regularly, and **perform an on-demand backup before and after performing updates**.
     * You can take one-off database backups at ''/settings_backup.php'' - note these must be restored via the command line/phpMyAdmin - __currently there is no built-in restore utility__.     * You can take one-off database backups at ''/settings_backup.php'' - note these must be restored via the command line/phpMyAdmin - __currently there is no built-in restore utility__.
  
Line 27: Line 38:
   * ITFlow allows you to store login credentials for assets, websites, etc.    * ITFlow allows you to store login credentials for assets, websites, etc. 
   * Usernames and passwords entered are encrypted in the database using a //**master encryption key**//. This key is never stored in plaintext on the disk or in the database. You'll need this key if you ever need to recover encrypted passwords from the database.   * Usernames and passwords entered are encrypted in the database using a //**master encryption key**//. This key is never stored in plaintext on the disk or in the database. You'll need this key if you ever need to recover encrypted passwords from the database.
-  * You can retrieve your key at ''/settings_backup.php''. It should never change, so only needs to be backed up somewhere safe once.+  * You can retrieve your key at ''/settings_backup.php'' by entering your account password. The key should never change, so only needs to be backed up somewhere safe once.