11# 5. Updating phpMyFAQ
22
3- First, please download the latest package of phpMyFAQ. Upgrading to phpMyFAQ 4.1 is possible from the following
3+ First, please download the latest package of phpMyFAQ. Upgrading to phpMyFAQ 4.2 is possible from the following
44versions:
55
6- - phpMyFAQ 3.0.x
76- phpMyFAQ 3.1.x
87- phpMyFAQ 3.2.x
98- phpMyFAQ 4.0.x
109- phpMyFAQ 4.1.x
1110
1211If you're running an older version of phpMyFAQ than listed above, we recommend a new and fresh installation. If you need
13- support for updating an old FAQ from the 1.x or 2.x series, [ please email us] ( mailto:thorsten_AT_phpmyfaq_DOT_de ) .
12+ support for updating an old FAQ from the 1.x, 2.x, or 3.0 series, [ please email us] ( mailto:thorsten_AT_phpmyfaq_DOT_de ) .
1413
1514Please note that the requirements of phpMyFAQ have to be fulfilled.
1615
1716## Before you upgrade
1817
1918Please make sure that you're running at least PHP 8.3, otherwise the upgrade won't work.
2019
21- ## Upgrading from phpMyFAQ 3.0 .x
20+ ## Upgrading from phpMyFAQ 3.1 .x
2221
23- Upgrading from 3.0 .x is a major upgrade.
24- Your existing templates will not work with phpMyFAQ 4.1 .
22+ Upgrading from 3.1 .x is a major upgrade.
23+ Your existing templates will not work with phpMyFAQ 4.2 .
2524Please make a full backup before you run the upgrade!
2625First, log in as admin into the admin section and enable the maintenance mode.
26+ (Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
2727Second, you have to delete all files ** except** :
2828
2929- in the directory ** config/**
@@ -40,10 +40,10 @@ URL in your browser:
4040
4141Click the button of the update script, your version will automatically be updated.
4242
43- ## Upgrading from phpMyFAQ 3.1 .x
43+ ## Upgrading from phpMyFAQ 3.2 .x
4444
45- Upgrading from 3.1 .x is a major upgrade.
46- Your existing templates will not work with phpMyFAQ 4.1 .
45+ Upgrading from 3.2 .x is a major upgrade.
46+ Your existing templates will not work with phpMyFAQ 4.2 .
4747Please make a full backup before you run the upgrade!
4848First, log in as admin into the admin section and enable the maintenance mode.
4949(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
@@ -52,6 +52,7 @@ Second, you have to delete all files **except**:
5252- in the directory ** config/**
5353 - keep the file ** database.php**
5454 - only if using LDAP/ActiveDirectory support also keep the file ** ldap.php**
55+ - only if using EntraID support also keep the file ** azure.php**
5556- the directory ** attachments/**
5657- the directory ** data/**
5758- the directory ** images/**
@@ -63,31 +64,25 @@ URL in your browser:
6364
6465Click the button of the update script, your version will automatically be updated.
6566
66- ## Upgrading from phpMyFAQ 3.2.x
67+ ## Upgrading from phpMyFAQ 4.0.x
68+
69+ ### Manual upgrade
6770
68- Upgrading from 3.2.x is a major upgrade.
69- Your existing templates will not work with phpMyFAQ 4.1.
7071Please make a full backup before you run the upgrade!
7172First, log in as admin into the admin section and enable the maintenance mode.
7273(Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
7374Second, you have to delete all files ** except** :
7475
75- - in the directory ** config/**
76- - keep the file ** database.php**
77- - only if using LDAP/ActiveDirectory support also keep the file ** ldap.php**
78- - only if using EntraID support also keep the file ** azure.php**
79- - the directory ** attachments/**
80- - the directory ** data/**
81- - the directory ** images/**
76+ - all files in the directory ** content/**
8277
83- Download the latest phpMyFAQ package and copy the contents into your existing FAQ directory, then open the following
78+ Download the latest phpMyFAQ package and copy the contents into your existing FAQ directory, the open the following
8479URL in your browser:
8580
8681` http://www.example.com/faq/update `
8782
8883Click the button of the update script, your version will automatically be updated.
8984
90- ## Upgrading from phpMyFAQ 4.0 .x
85+ ## Upgrading from phpMyFAQ 4.1 .x
9186
9287### Manual upgrade
9388
@@ -105,7 +100,24 @@ URL in your browser:
105100
106101Click the button of the update script, your version will automatically be updated.
107102
108- ## Upgrading from phpMyFAQ 4.1.x
103+ ### Online update (Experimental feature)
104+
105+ If you're running phpMyFAQ 4.0.0 or later, you can use the built-in online update feature.
106+ Log in as admin into the admin section and enable the maintenance mode.
107+ (Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
108+ Then go to the "phpMyFAQ Update" page in the configuration section and click through the update wizard:
109+
110+ 1 . Check for System Health: this checks if your system is ready for the upgrade
111+ 2 . Check for Updates: this checks if there is a new version of phpMyFAQ available
112+ 3 . Download of phpMyFAQ: this downloads the latest version of phpMyFAQ in the background, this can take some seconds
113+ 4 . Extracting phpMyFAQ: this extracts the downloaded archive, this can take a while
114+ 5 . Install downloaded package: first, it creates a backup of your current installation, then it copies the downloaded
115+ files into your installation, and in the end, the database is updated
116+
117+ Note:
118+ The online update feature is experimental and might not work in all environments.
119+
120+ ## Upgrading from phpMyFAQ 4.2.x
109121
110122### Manual upgrade
111123
@@ -140,7 +152,7 @@ Then go to the "phpMyFAQ Update" page in the configuration section and click thr
140152Note:
141153The online update feature is experimental and might not work in all environments.
142154
143- ## Modifying templates for phpMyFAQ 4.1
155+ ## Modifying templates for phpMyFAQ 4.2
144156
145157We recommend you take a look at the main [ Bootstrap documentation] ( https://getbootstrap.com/ ) .
146158Please remember that the style sheets are written with [ SCSS] ( https://sass-lang.com/ ) .
0 commit comments