User Tools

Site Tools


plugin:addons

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
plugin:addons [2019/03/19 17:30]
duncanc [phpList updater]
plugin:addons [2019/03/19 17:52]
duncanc [phpList Updater]
Line 26: Line 26:
 When you have enabled the plugin there will be an Addons group on the Settings page where you can configure the plugin. When you have enabled the plugin there will be an Addons group on the Settings page where you can configure the plugin.
  
-==== phpList ​updater ​====+==== phpList ​Updater ​====
  
 The plugin provides a page that updates the phplist code to the latest release. The main differences to the core phplist updater are The plugin provides a page that updates the phplist code to the latest release. The main differences to the core phplist updater are
Line 35: Line 35:
  
 There are some important requirements:​ There are some important requirements:​
 +  * need to create a work directory that is writeable by the web server process. This should be outside the '​lists'​ directory and need not be within the web root at all, although it can be.
   * the phplist installation directory (usually '​lists'​ but could have been renamed) must be writeable by the web server process   * the phplist installation directory (usually '​lists'​ but could have been renamed) must be writeable by the web server process
-  * need to create a work directory ​that also is writeable ​by the web server process. This should ​be outside ​the '​lists' ​directory ​and need not be within the web root at all, although it can be.+  * the files in the phplist installation ​directory ​must be owned by the web server process, because they will be moved to the work directory 
  
 The plugin uses the work directory to download and expand the phplist distribution zip file, and stores a backup of the current phplist files and directories. The plugin uses the work directory to download and expand the phplist distribution zip file, and stores a backup of the current phplist files and directories.
Line 44: Line 46:
 $addonsUpdater = [ $addonsUpdater = [
     '​work'​ => '/​path/​to/​work/​directory',​     '​work'​ => '/​path/​to/​work/​directory',​
 +];
 +</​code>​
 +
 +After upgrading the phplist code to the new release, the updater can then copy specific files from the backup. This can be useful if you have made changes to phplist files that you want to keep.
 +
 +You should first verify that the new phplist release has not modified the files in question. If they have been modified then you will need to reapply manually the changes to the files in the new release.
 +
 +To have the updater restore specific files, add a list of the files to the config.php variable. The path of each file should be relative to the "​lists"​ directory.
 +
 +For example to restore the English front-end translation file
 +<​code>​
 +$addonsUpdater = [
 +    '​work'​ => '/​path/​to/​work/​directory',​
 +    '​files'​ => [
 +        '​texts/​english.inc',​
 +    ],
 ]; ];
 </​code>​ </​code>​
plugin/addons.txt · Last modified: 2019/07/04 11:21 by duncanc

Resources
Contact Us

e: info@phplist.com

Boring Bit

phpList is a registered limited company

UK Company No. 07582966

VAT Registration 122 0788 37

© phpList 2016