User Tools

Site Tools


  Main   About   Help   Download
nconf:help:documentation:start:update

Update guide

Make sure you have read and understood the Release Notes before performing any updates!

Interactive update

1. Backup

Make a backup copy of your whole 'nconf/' folder and create a dump of your 'nconf' database.

The update process will not overwrite your configuration, but if you have made changes to any other files, these changes will be lost! This is also true for icons that you might have installed manually ('img/logos/base/').

Commandline example:

cp -rp nconf/ nconf.BAK  
mysqldump -u DBUSER -p DBNAME > nconf-dbdump.sql

2. Download and unpack

Download the NConf archive. If you have console access, upload the uncompressed archive to your server and uncompress it to a temporary location.

Commandline example:

tar -zxf nconf-VERSION.tgz -C /tmp/

Another option is to uncompress the archive on your local PC, then upload all the files with an FTP account to your webserver.

3. Update existing files

Copy the unpacked files to the 'nconf/' folder and overwrite any existing files of your current NConf installation. You may do this using the console or by uploading the new files directly via FTP to the 'nconf/' folder.

Commandline example:

/bin/cp -rv /tmp/nconf/* /path/to/nconf/ (specify the full path to the 'cp' binary!)

This step cannot be undone! Make sure you have made a backup of your 'nconf/' folder.

4. Check permissions

Make sure the following directories are still writable to your webserver user.

You can change permissions on the console or via FTP client (CHMOD)

 ./config  
 ./output  
 ./static_cfg  
 ./temp

5. Begin interactive update

Using your browser, start the update process by navigating to http://www.mydomain.com/nconf/UPDATE.php

The the exact URL will depend on your webserver configuration.

It could also be something like this: http://nconf.mydomain.com/UPDATE.php

Pre-update check

The pre-update check will try to detect some requirements. If all checks are OK, you may safely proceed with the update.

If one or more checks fail, you may still proceed to update NConf, but it might not work properly

Version detection

Check the database information. It should be predefined correctly.

The update process will then detect your NConf version and will perform an update of your database.

Update to 1.3.0

Additional manual tasks might be necessary before the database will be update. You can run the conversion script directly from the GUI.

Convert data
Please read the Release notes for more information.

Be sure you have a DB-backup so if something goes wrong you can go back again…

Please post in the Forum if you have any problems here.

Read release notes
Additional manual tasks might be necessary after an update. Refer to the version-specific README section for update-related instructions. This section contains important instructions about necessary config changes etc.
The release notes for the current release can also be found here: Release notes
Test the new release and try the new features

If everything is fine, try to create your configuration and check the new setup. You could also try to setup the new Deployment possibilty. We hope, everything is fine and you enjoy the new version.

6. Restore icons (optional)

If you were using additional icons prior to the update, you will have to copy these back from your backup folder.

7. Clean up

Finally, remove the following files and directories:

INSTALL
INSTALL.php
UPDATE
UPDATE.php

The update should now be complete.

Refresh browser cache:
If NConf does not look or feel right after the update, press CTRL-F5.
Your browser might have to reload some cached CSS & JavaScript files.

Manual update (commandline)

1. Backup

Make a backup copy of your whole 'nconf/' folder and create a dump of your 'nconf' database.

The update process will not overwrite your configuration, but if you have made changes to any other files, these changes will be lost! This is also true for icons that you might have installed manually ('img/logos/base/').

Example:

cp -rp nconf/ nconf.BAK
mysqldump -u DBUSER -p DBNAME > nconf-dbdump.sql

2. Download and unpack

Download and unpack the NConf archive to a temporary location on your webserver.

Example:

tar -zxf nconf-VERSION.tgz -C /tmp/

3. Update existing files

Copy the unpacked files to the 'nconf/' folder and overwrite any existing files of your current NConf installation.

Example:

/bin/cp -rv /tmp/nconf/* /path/to/nconf/  (specify the full path to the 'cp' binary!)

This step cannot be undone! Make sure you have made a backup of your 'nconf/' folder.

4. Check permissions

Make sure the following directories are still writable to your webserver user:

 ./config  
 ./output  
 ./static_cfg  
 ./temp

5. Update the database

Update 1.2.6 to 1.3.0
Please read first the release notes, before updating your database. Perhaps you need to convert some data before you upgrade NConf!

The 'UPDATE/' folder contains a subfolder for each previous release of NConf. The folders are named like this: x.x.x_to_y.y.y

Make sure you know your current version of NConf. Next, chose the appropriate folder and look for a script named update_database_x.x.x_to_y.y.y.sql.

Update the database like this:

$> mysql -u DBUSER -p DBNAME < UPDATE/x.x.x_to_y.y.y/update_database_x.x.x_to_y.y.y.sql

If you are updating from an older version of NConf, make sure you apply all available updates for all versions between your version and the latest version of NConf. Also, make sure you apply the updates in the right order!

Important:
make sure you don't skip any updates, and that you apply ALL of them in the right order. Failure to do so may result in data corruption and instability of NConf! If you want to use the convert script, you have to apply it to the 1.2.6 release, before going to 1.3!

6. Additional tasks

Check the version-specific 'README' file within the current subfolder for update-related instructions. If you have applied more than one update, make sure you study all README files in all subfolders. These files contain important instructions about necessary config changes etc.

The release notes for the current release can also be found here: Release notes

7. Restore icons (optional)

If you were using additional icons prior to the update, you will have to copy these back from your backup folder.

8. Clean up

Finally, remove the following files and directories:

INSTALL
INSTALL.php
UPDATE
UPDATE.php

The update should now be complete.

Refresh browser cache:
If NConf does not look or feel right after the update, push CTRL-F5.
Your browser might have to reload some cached CSS & JavaScript files.

nconf/help/documentation/start/update.txt · Last modified: 11.12.2011 17:57 by fgander