yappa-ng Regular Documentation
UPGRADE
Upgrade Instructions for upgrading yappa-ng
Standard Procedure
Safe Mode Upgrade
Special Upgrade Instructions (release-specific)
ALL to 2.3.1
ALL to 2.3.0
2.2.0 or 2.2.1-r3 to 2.2.2-stable
2.2.0 to 2.2.1-r3
2.1.0stable to 2.2.0
2.0.x to 2.1.0
2.0.0beta to 2.0.1stable
previous < 2.0.0beta to 2.0.1stable
previous to 2.0.0beta
Standard Procedure:
Starting with release "2.2.2-stable" the Upgrade Process gets drastically simplyfied! :-)
After downloading the new release and reading the Upgrade instructions below take a view at the
CHANGELOG to get an idea what is new and changed! :-)
Upgrading a system is always the perfect time to make a backup! Recommended are backups of all your hits.log, captions_xxx.txt and info_xxx.txt files.
(Starting with release "2.2.2-stable" this is only a reminder to do a backup, it is not necessary for the Upgrade process anymore!)
If not stated otherwise for a particular release below you should
copy all files from the new yappa-ng release into the appropriate directories, overwriting all existing files.
Of course you have to be careful with files you changed yourself. This implies themefiles, headers, footers, css, and all the others.
If you changed a value in the "config_private.inc.php" note this change and overwrite this file with the new one nevertheless.
Than change the value back again in the new file. (You do not need to be careful with all the news files, hits.logs, captionfiles or similar.
They are not included in this form in the distribution anymore!. They are copied from the directory /install to the appropriate directories and many files
just get created with the Setup Tool! If they already exist they will not be touched anymore!!)
The Upgrade Process in short:
- Optional: Start the Setup Tool and change yappa-ng into Maintainance Mode.
- Now copy ALL (!!) files from the new release into the yappa-ng directories, overwriting all existing ones!
- Important: Make sure your file/directory-permissions are correct again after this overwriting ;-)
- Run the Upgrade Tool (upgrade_to_23x.php).
- Start the Setup Tool (setup.php, take a look if there are any new items, save the config (!!) and stop the Maintainance Mode.
- Check (logged in as Album Admin) if and which items are new / have changed in the Album Configuration!
Thats all there is to it! :-)
If you want to know IF there have been changes since date XYZ / release ZYX in a specific file
and/or if you want to know WHAT the changes are in a specific file:
Take a look at the yappa-ng CVS repository on sourceforge.net
->Back
to TOP
Safe Mode Upgrade:
Starting with release 2.3.0 there is a special "Safe Mode Upgrade Procedure" in place.
As everything in connection to Safe Mode its a little bit more to do, but it works! :-)
At the moment this Safe Mode Upgrade procedure with the 2 scripts is BETA!!
- Optional: Start the Setup Tool and change yappa-ng into Maintainance Mode.
- Upload (!!!) the script "safe_mode_upgrade.php" into your Main yappa-ng directory [source_root]. FTP it to be sure it has the right permissions.
(You can find this script in the "[source_root]/install" directory!)
- Run the script "safe_mode_upgrade.php". It creates needed new directories and you upload the second script "safe_mode_upgrade2.php" into this directory. (Password for both scripts is the Admin Password you use for Setup Tool and ToolBox).
- Now copy ALL (!!) files from the new release into the yappa-ng directories, overwriting all existing ones! with one exception:
Do NOT overwrite the "safe_mode_upgrade2.php" script you uploaded in the step before!!!!
- Delete the following files manually:
- check_setup.php
- index.php
- setup.php
- show.php
- slideshow.php
- toolbox.php
- toolbox_logview.php
- your used languages in the /languages directory
- Now run the script "safe_mode_upgrade2.php". Upload them again with this script !!!!!
- Run the Upgrade Tool (upgrade_to_23x.php).
- Start the Setup Tool (setup.php, take a look if there are any new items, save the config (!!) and stop the Maintainance Mode.
- Check (logged in as Album Admin) if and which items are new / have changed in the Album Configuration!
Thats the procedure for Safe Mode Upgrade. :-)
Special Upgrade Instructions (release-specific)
ALL to 2.3.1
In addition (!) to the Standard Procedure keep an eye on the following items:
- Because of the UserComments there are changes in the .css-files! If you changed them yourself just copy the last block into your own .css files!!
- It is important that you copy all files and check the permissions before you run the upgrade_to_23x.php!!
- At the end of the upgrade_to_23x.php this Tool deletes old (unused and/or moved and/or renamed) files!
Check if all are listed as "ok". If not please delete them manually _before_ you run the setup.php !!
- If you do run into trouble: the check_setup.php script is much better than before and will help you better to solve your issues!!!
- If you are upgrading from an older version: Be sure to read all the changes which got implemented into previous versions!
enjoy! :-)
->Back
to TOP
ALL to 2.3.0
In addition (!) to the Standard Procedure keep an eye on the following items:
- There are 2 new subdirectories: /src and /exifer (since 2.2.2. There are more new directories since older versions!!!).
Do not forget to copy these too because they did not exist in previous releases.
- There are new files in every directory!!! Make sure you do not miss one. Overwrite all.
- It is important that you copy all files and check the permissions before you run the upgrade_to_23x.php!!
- At the end of the upgrade_to_23x.php this Tool deletes old (unused and/or moved and/or renamed) files!
Check if all are listed as "ok". If not please delete them manually _before_ you run the setup.php !!
- If you do run into trouble: the check_setup.php script is much better than before and will help you better to solve your issues!!!
- After everything is runnning run the toolbox.php and be surprised! :-)
- If you are upgrading from an older version: Be sure to read all the changes which got implemented into 2.3.0!
- If you are familiar with the older releases and set up a new yappa-ng installation: The Album Admin Password
for the home and sample Albums are not "nonono" anymore. They are now the same as the Password you provide with the Setup Tool at installation time!!!
enjoy! :-)
->Back
to TOP
2.2.0 or 2.2.1-r3 to 2.2.2-stable
In addition (!) to the Standard Procedure keep an eye on the following items:
- There are 2 new subdirectories: /toolbox and /install. Do not forget to copy these too because they did not exist in previous releases.
- If you are running in safemode: The files toolbox.php and toolbox_logview.php have to be owned by the webserver too!
- If you do run into trouble: the check_setup.php script is much better than before and will help you better to solve your issues!!!
- After everything is runnning run the toolbox.php and be surprised! :-)
- If you are upgrading from 2.2.0: Be sure to read all the changes which got implemented into 2.2.1-r3!
enjoy! :-)
->Back
to TOP
2.2.0 to 2.2.1-r3
In addition (!) to the Standard Procedure keep an eye on the following items:
- IMPORTANT: After going to Mainainance Mode and copying all new files (especially the setup.php and the new file config_mimetypes.inc.php)
in all the directories where the files belong start the Setup Tool and "Submit All" one time (before you make any changes!!) and
refresh the browser (reload) the Setup Tool! This will write one additional line to your existing config file and load the
config_mimetypes.inc.php. Only after this step you see all preconfigured mimetypes and can select the filetypes you want to
support within your yappa-ng!
- In the Setup Tool there are some new options:
- Part 2: Slogan: Set your own Gallery Slogan!
- Part 3: Permitted Filetypes: You have to select the permitted filetypes! Only the marked ones will get shown!
- Part 5: Size of Header: Select if you want the Standard Header or a Small Header!
- Part 6: Album Description Preview! Enable or disable Album Description Preview!
- Old Part 6: Permit video file upload: obsolete - got deleted. The selection is now more exact on a per filetype basis. Its in Part 3: Permitted Filetypes!
- If you want support of "Non Resizeable Files" (videos, audios, office files,...) be sure to read the
corresponding section of the MANUAL.html!
- Theme headers have been changed. If you changed the old ones yourself be sure to copy your changes into the new headers
to be on the save side (not the other way round)!
- Don't forget to overwrite the old config_private.inc.php with the new one too! :-)
- In the Album config there are some changes:
- Permit video does not exist anymore. Filetypes are enabled/disabled global.
- Album Description Preview! You may permit Album description Preview (even if it is a "locked Album").
- The setting of the "NEW-option" for images sets this option for the Album itself too. If you disable it for images its disabled for the album too.
The same goes for the days.
- Do not forget to copy all the images from the yappa-ng/images directory into your installation!
- ...and don't forget to overwrite all documentation files (like this one) in the /docs directory too - many of them changed - they got better and more up to date! :-)
enjoy! :-)
->Back
to TOP
2.1.0stable to 2.2.0
There have been many changes introduced into the 2.2.0
as you can see in the CHANGELOG. One of the most visual changes for the
setup is the Setup Tool. You will use it from now on - it will make changes and upgrading much easier!
No Panic! :-) The Upgrade Process is not difficult - this description is longer than usual because I describe everything in great detail
and for some parts I describe even more than one way to do it. :-)
The short description: Backup some critical files like your personal hits.log, overwrite everything with the new release, run the setup.php, restore the
backuped critical files and that's it! :-)
The detailed description:
First step in the upgrade process is (as always) to make backups of the following files:
- the config.inc.php file.
- Your hit counters "hits.log"
- Your news_xxx.html (xxx is the short for a language)
- The hits.log, captions_xxx.txt, info_xxx.txt and config_album.inc.php of your Photos Main Directory
if you use the default "yappa-ng/photos". No need for all your subalbums - just the ones in the
"yappa-ng/photos" directory because they are as default-files in the release too!
- Maybe files that you have changed (themes / layout / footer / ...) (Do not restore these themes/layout files again! This backup is only for you to look what you changed and put these
changes into the new files!!).
The images and all files below your Photos Main Directory will not get touched during upgrade.
All other scriptfiles should be unchanged from you and can be obtained via download again! :-)
Now you have 2 options, depending on how frequented your site is! :)
- If your site is not visited really often or you just don't care if one or two users get errors while you change the configs
you can take the easy way:
- Just unzip/untar all files of the new release over all the existing ones.
You will get a "/sample" directory with the sample image in your gallery again - leave it untill everything
runs smooth!
- Copy the "config.inc.php" back (overwrite)
- Run the Setup Tool (point your browser to the "setup.php" file)
- Make all changes you want to make and submit them
- Read the [More Info...] in the Setup Tool on parameters where you are not sure what they mean
and how they influence your Gallery
- OR - Set your Site to "Maintenance Mode" during upgrade.
- Unzip/untar all files of the release into some other directory (not your Gallery directory)
- Make sure your "config.inc.php" is writeable for your webbrowser!
- Copy the "index.php (overwrite) "config_private.inc.php" (overwrite) and the "setup.php (new) into your existing installation
- Run the Setup Tool (point your browser to the "setup.php" file) and set the "Maintenance Mode" to "yes (and Submit)
- Now you have time! :-) Copy (overwrite) all other files into your existing setup.
(Be careful with the special files or copy them back from your backup!)
- For the [More Info...] within the Setup Tool you need the files in the /docs directory !!
- When you are satisfied with the selected settings and you do not get any errors set the "Maintenance Mode" back to "no!
In both cases copy your backuped files (hits.log, news_xxx.html, captions_xxx.txt, info_xxx.txt
and config_album.inc.php) into the same places where you had them befor backup!
As always make sure your file/directory-permissions are correct again after upgrade ;-)
The file permission for the "setup.php" have to be the same as the "index.php" and the "show.php" (Important for "safe_mode" environments!)
Log into every Album as Album-Admin and check the new settings and save them. The "General Album Settings" have been split into 3 Menu items
("General Album Settings", "Thumbnail Display Settings" and "Image Display Settings").
All new parameters are set to default values that your user will not see any difference to the way yappa-ng was before if you have not the time to log into each Album
and set the parameters new.
If you have no other Album-Admins and all Albums have the same setup (and same password!) configure one Album to your preferences
and copy the "config_album.inc.php" into all other Albums!
There have been changes in the Themes Headers too!! If you changed the header to suit your needs please adapt the NEW header again (not try to adapt the old one!)!!
I know its maybe more work for you - but you will not get the desired results if done the other way round. One of the changes is that you can now change / adapt the used icons within the themes
to your liking - and for every theme differently. They are defined in the file "themes/themes_support.inc.php". Now its easy to take your own "keys icon" for example!
->Back
to TOP
2.0.x to 2.1.0
There are MANY changes in this release - especially in the language-handling and new themes!
As always make a backup of your current setup. ;-)
Just replace _ALL_ files (*NOT* config.inc.php, news_xxx.html and your hits.log !!!) with the new ones.
WARNING: be careful to _NOT_ overwrite the config_album.inc.php in your photo_root!
==> (You would have the default admin password for the photo "Home" directory again!!! <==
Be sure to replace the config_private.inc.php!
The language-handling has changed completely - and so has the header of the language files!
Overwrite all language files!
There are 2 new config-parameters:
"source_root" and "lang_intuitive" (descriptions of these parameters are in the config-file itself).
There are 3 new themes - take a look at the "themes_installed" - array in the config.inc.php!
Make sure to delete/rename the check_setup.php script after everything is running
(and delete the check_setup.txt file if you used the check_setup.php script !!)
As always make sure your file/directory-permissions are correct again after upgrade ;-)
->Back
to TOP
2.0.0beta to 2.0.1stable
I did not want to change much - it should be a bugfix-release only.
But I validated yappa-ng to HTML 4.01 and CSS 2.
Because ALL CSS-Tags have been incorrect (NO underscores "_" are allowed in CSS-tags!)
there is really much change from 2.0.0beta to 2.0.1stable within the source code.
"The Good News": no new files, no moves to other directories, no renamed files, no functional changes. :-)
Just replace all files (*NOT* config.inc.php, news_xxx.html and your hits.log !!!) with the new ones.
There are 2 new config-parameters: If your setup is running smoothly just ignore them
(or copy them into your old config.inc.php).
As always make sure your file/directory-permissions are correct again after upgrade ;-)
->Back
to TOP
previous < 2.0.0beta to 2.0.1stable
Please follow the instructions and recommendations for the change as described in:
=> All previous to 2.0.0beta
->Back
to TOP
previous to 2.0.0beta
- The directory-structure has changed completely!
- new directories
- new files
- files moved from one directory to another
- files renamed
- contents moved from one file to another
- The recommended upgrade-procedure is:
- make a backup ;-)
- copy your config.inc.php and your hits.log from the yappa-ng root to a save place
- (maybe printout your config.inc.php)
- copy your news_xxx.html (if you have one / more) to a save place
- delete yappa-ng
- delete NOT the photo_root !!! KEEP your picture/photo/image-directory !!!
- delete NOTHING within your photo-directories!! ONLY the source code-directories!
- install yappa-ng where it has been.
- edit your NEW config.inc.php and write the values from your old one into the new one
( ignore parameters that are missing in the NEW but which you have in the old!! )
Leave the parameter "send_warnings" to "yes"
- overwrite the hits.log with your old one
- copy/overwrite your news_xxx.html back
- make sure the web server can read all files / can write the hits.log
- test
- edit your config.inc.php and turn the "send_warnings" off (optional, not really needed!)
If you do not follow the above procedure (e.g. don't delete the files first)
there could be some freak side effects. Be warned!
->Back
to TOP