Update doc

This commit is contained in:
Frederic Guillot
2015-11-15 15:14:26 -05:00
parent a42f1ea2bd
commit 5dc7a242bc

View File

@@ -1,26 +1,33 @@
Update Upgrade Kanboard to a new version
====== =================================
**Always make a backup of your database before upgrading!** Upgrading Kanboard to a newer version is seamless.
The process can be summarized to simply copy your data folder to the new Kanboard folder.
Kanboard will run automatically database migrations for you.
Important things to do before updating
--------------------------------------
- Always make a backup of your data before upgrading
- Always read the [change log](https://github.com/fguillot/kanboard/blob/master/ChangeLog) to check for breaking changes
- Always close all user sessions (flush all sessions on the server)
From the archive (stable version) From the archive (stable version)
--------------------------------- ---------------------------------
1. Close all sessions (logout) 1. Uncompress the new archive
2. Rename your actual Kanboard directory (to keep a backup) 2. Copy the content of your data folder into the newly uncompressed directory
3. Uncompress the new archive and copy your `data` directory to the newly uncompressed directory. 3. Copy your custom `config.php` if you have one
4. Copy your custom `config.php` (if you created one) to the root of the newly uncompressed directory. 4. Copy your plugins if necessary
5. Make the directory `data` writeable by the web server user 5. Make sure the directory `data` is writeable by your web server user
6. Login and check if everything is ok 6. Test
7. Remove the old Kanboard directory 7. Remove your old Kanboard directory
From the repository (development version) From the repository (development version)
----------------------------------------- -----------------------------------------
1. Close all sessions 1. `git pull`
2. `git pull` 2. `composer install`
3. `composer install`
3. Login and check if everything is ok 3. Login and check if everything is ok
Note: This method will install the **current development version**, use at your own risk. Note: This method will install the **current development version**, use at your own risk.