================================================================================

====================
HOW TO INSTALL / UPDATE - read below for update instructions
================================================================================
====================
Joomla 1.5 users please read "INSTALLATION (JOOMLA 1.5+)" in the FAQ before inst
alling uddeIM.
================================================================================
====================
Joomla 1.6 users please read "INSTALLATION (JOOMLA 1.6+)" in the FAQ before inst
alling uddeIM.
================================================================================
====================
IMPORTANT: There is a comprehensive FAQ in the README folder which gives lots of
more
information about the first installation and the upgrade of uddeIM.
CONTENT
* HOW TO UPGRADE FROM UDDEIM 1.7-2.2 TO UDDEIM 2.3
- How to upgrade
- Optional steps
* HOW TO UPGRADE FROM UDDEIM 1.6 OR EARLIER TO UDDEIM 2.3
* FIRST INSTALL OF UDDEIM
- Installation
- Optional steps
* HOW TO CREATE FOLDER "/uddeimfiles"
* NOTES FOR DONATORS
* APPENDIX A - Folder structure

================================================================================
====================
HOW TO UPGRADE FROM UDDEIM 1.7-2.2 TO UDDEIM 2.3
================================================================================
====================
How to upgrade:
---------------
1. a) Backup your uddeIM template (if you do not use uddeIM's default templates
)
b) Backup your database (at least all tables prefixed "uddeim", when using p
hpMyAdmin you can
copy the tables given the copy a new name, e.g. jos_uddeim_backup).

2. Backup your configuration using the internal backup function and/or backup t
he config file:
/administrator/components/com_uddeim/config.class.php
I recommend to uninstall the previous version of uddeIM and then upgrade to
the new version
using the component installer, so you might need this file to restore your s
ettings.
When you are an experienced user you can also overwrite the existing files w
ith the new
files from the archive. Please check Appendix A for the correct folder struc
ture
(please check if there are new files which have to be uploaded).

3. Update your database tables (go to phpMyAdmin and enter following SQL statem
ents in the SQL box,
this will create the missing fields).
You will find a small tutorial in the FAQ (chapter 1.3.x "How can I upgrade
uddeIM s tables?").

When you upgrade 2.2 to 2.3:

============================
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;

When you upgrade 2.1 to 2.3:

============================
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;

When you upgrade 2.0 to 2.3:

============================
ALTER TABLE `jos_uddeim` ADD `systemflag` INT( 1 ) NOT NULL DEFAULT '0'
;
ALTER TABLE `jos_uddeim` ADD INDEX ( `systemflag` ) ;
UPDATE `jos_uddeim` SET `systemflag` = 1 WHERE `systemmessage` != '' OR
`systemmessage` IS NOT NULL ;
UPDATE `jos_uddeim` SET `systemflag` = 2 WHERE `fromid` = `toid` ;
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;

When you upgrade 1.9 to 2.3:

============================
ALTER TABLE `jos_uddeim` ADD `systemflag` INT( 1 ) NOT NULL DEFAULT '0'
;
ALTER TABLE `jos_uddeim` ADD INDEX ( `systemflag` ) ;
UPDATE `jos_uddeim` SET `systemflag` = 1 WHERE `systemmessage` != '' OR
`systemmessage` IS NOT NULL ;
UPDATE `jos_uddeim` SET `systemflag` = 2 WHERE `fromid` = `toid` ;
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;
 When you upgrade 1.8 to 2.3:
============================
CREATE TABLE IF NOT EXISTS `jos_uddeim_attachments` (
`id` int(10) unsigned NOT NULL auto_increment,
`mid` int(1) NOT NULL default '0',
`tempname` TEXT NOT NULL,
`filename` TEXT NOT NULL,
`fileid` varchar(32) NOT NULL,
`size` int(1) NOT NULL default '0',
`datum` int(11) default NULL,
PRIMARY KEY (`id`),
KEY `mid` (`mid`),
KEY `fileid` (`fileid`),
KEY `datum` (`datum`)
) ENGINE=MyISAM;
ALTER TABLE `jos_uddeim` ADD `systemflag` INT( 1 ) NOT NULL DEFAULT '0'
;
ALTER TABLE `jos_uddeim` ADD INDEX ( `systemflag` ) ;
UPDATE `jos_uddeim` SET `systemflag` = 1 WHERE `systemmessage` != '' OR
`systemmessage` IS NOT NULL ;
UPDATE `jos_uddeim` SET `systemflag` = 2 WHERE `fromid` = `toid` ;
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;

When you upgrade 1.7 to 2.3:

============================
CREATE TABLE IF NOT EXISTS `jos_uddeim_attachments` (
`id` int(10) unsigned NOT NULL auto_increment,
`mid` int(1) NOT NULL default '0',
`tempname` TEXT NOT NULL,
`filename` TEXT NOT NULL,
`fileid` varchar(32) NOT NULL,
`size` int(1) NOT NULL default '0',
`datum` int(11) default NULL,
PRIMARY KEY (`id`),
KEY `mid` (`mid`),
KEY `fileid` (`fileid`),
KEY `datum` (`datum`)
) ENGINE=MyISAM;
ALTER TABLE `jos_uddeim` ADD `systemflag` INT( 1 ) NOT NULL DEFAULT '0'
;
ALTER TABLE `jos_uddeim` ADD INDEX ( `systemflag` ) ;
UPDATE `jos_uddeim` SET `systemflag` = 1 WHERE `systemmessage` != '' OR
`systemmessage` IS NOT NULL ;
UPDATE `jos_uddeim` SET `systemflag` = 2 WHERE `fromid` = `toid` ;
ALTER TABLE `jos_uddeim` ADD `delayed` INT( 1 ) NOT NULL DEFAULT '0' ;
ALTER TABLE `jos_uddeim` ADD INDEX ( `delayed` ) ;
ALTER TABLE `jos_uddeim_emn` ADD `moderated` INT( 1 ) NOT NULL DEFAULT '
0' ;

4. Install uddeIM. When you have installed uddeIM using the Joomla installer it
should have created
a folder "/images/uddeimfiles" containing two files (".htaccess" and ".index
.html").
If this folder is not present uddeIM has no write access to the Joomla root
folder.
In that case you should create this folder manually, see chapter
"HOW TO CREATE FOLDER '/images/uddeimfiles'"
IMPORTANT:
==========
uddeIM 1.9 has created "uddeimfiles" in Joomla root. You have to move th
e content of
"/uddeimfiles" to "/images/uddeimfiles" in order to keep your data.

5. Restore your uddeIM template (from step 1, when you do not use uddeIM's defa
ult templates).
ATTENTION:
There might be new icons (depending on the version of uddeIM you are updatin
g from):
\components\com_uddeim\templates\default\images\disk.gif
\components\com_uddeim\templates\default\images\envelope.gif
\components\com_uddeim\templates\default\images\envelope_deleted.gif
\components\com_uddeim\templates\default\images\staron.gif
\components\com_uddeim\templates\default\images\staroff.gif
\components\com_uddeim\templates\default\images\icon_spam.gif
\components\com_uddeim\templates\default\images\icon_updown.gif
\components\com_uddeim\templates\default\images\icon_up.gif
\components\com_uddeim\templates\default\images\icon_down.gif
\components\com_uddeim\templates\images\rss_logo.png
New in uddeIM 2.3:
\components\com_uddeim\templates\images\uddeim-favicon.png
\components\com_uddeim\templates\images\delayed_im.gif
When updating manually don't forget to upload these files!

6. Restore your configuration. When you have used the internal backup feature i
ts just one click
(Tab "System"->RESTORE), otherwiese restore config.class.php from step 2. Af
ter doing that it
is important that you review the new added settings and save the new con
figuration!

7. Check Community Builder settings (it is not required to use CB with uddeIM b
ut it is
highly recommended for a community platform). There are uddeIM settings for
the
"cblogin" module and "mypms" plugin of the Community Builder. When possible
choose
"uddeIM 2.0" otherwise the next lower version e.g. "uddeIM 1.3". It is recom
mended
to install the uddeIM specific modules (see the important note below).
8. Check the menu link to uddeIM. Usually you have to update the link (Joomla 1
.5) or you
have to re-create the link (Joomla 1.0) so the Itemid to uddeIM is valid.
 On existing Joomla 1.0 sites use "Database maintanance->Repair" to add a mis
sing menu
icon without reinstalling the component.

Optional: When you want to use message obfuscating check the "key" which can be
set in uddeIM
administration. Default is "uddeIMcryptkey" but it can be changed to
whatever you
like. This "key" is used to obfuscate all new messages.
You cannot change this value later. You have to set it before the fir
st new message
has been written and obfuscating of messages is enabled in the prefer
ences.

================================================================================
====================
HOW TO UPGRADE FROM UDDEIM 1.6 OR EARLIER TO UDDEIM 2.3
================================================================================
====================
Upgrades from uddeIM 1.6 and below are not longer supported.
Please upgrade to uddeIM 1.7 using the instructions found in uddeIM 1.7 package
first before
upgrading to uddeIM 2.3.

================================================================================
====================
FIRST INSTALL OF UDDEIM
================================================================================
====================
Installation:
-------------
1. Use the Joomla installer to install this component.

2. Check the configuration in the backend before starting to use uddeIM.

Configuration setting printed in red are not available since a component is
not
installed on your system (e.g. Community Builder).

3. Check Community Builder settings (it is not required to use CB with uddeIM b
ut it is
highly recommended for a community platform). There are uddeIM settings for
the
"cblogin" module and "mypms" plugin of the Community Builder. When possible
choose
"uddeIM 2.3" otherwise the next lower version e.g. "uddeIM 1.3". It is recom
mended
to install the uddeIM specific modules (see the important note below).
 4. Check if uddeIM has created a folder "/images/uddeimfiles" containing two fi
les
(".htaccess" and ".index.html").
If this folder is not present uddeIM has no write access to "/images". In th
at case
you should create this folder manually, see chapter
"HOW TO CREATE FOLDER '/images/uddeimfiles'"

5. Create a menu link to uddeIM. This is important because uddeIM requires a un

ique Itemid.
When you want to use the public front end feature set public access for the
menu link
otherwise set registered access.

Optional: When you want to use message obfuscating check the "key" which can be
set in uddeIM
administration. Default is "uddeIMcryptkey" but it can be changed to
whatever you
like. This "key" is used to obfuscate all new messages.
You cannot change this value later. You have to set it before the fir
st new message
has been written and obfuscating of messages is enabled in the prefer
ences.

================================================================================
====================
HOW TO CREATE FOLDER "/images/uddeimfiles"
================================================================================
====================
Create a folder "uddeimfiles" in "/images" and set the access rights that Joomla
can access it.
When you are unsure use "0777" (usually 0766 should be fine).
To ensure that people do not access this directory directly, you should create
following files (you will also find these files in the "SUPPORT" folder in the
premium plugin package):
index.html
----------
<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">
<html><head></head><body></body></html>
.htaccess
---------
# Having a .htaccess prevents users from directly
# accessing the files in your /images/uddeimfiles folder
#
deny from all
Since uddeIM uses temporary names for file attachments stored in the file system
,
both files are not explicitely required when the directory is not displayed by d
efault
(Options +Indexes).
To improve security you can add "Options -Indexes" to the ".htaccess" file
(when your server allows doing this).

================================================================================
====================
NOTES FOR DONATORS
================================================================================
====================
When upgrading uddeIM you have to reinstall the premium plugins. If you forget h
ow to do that,
check the FAQ or the README provided with the premium plugin package.
You don't have to install the premium plugins again:
- if you install a "hotfix" for uddeIM
- you are an experienced user and overwrite the existing files with the new file
s from the archive
when upgrading (e.g. upgrading from 1.7 to 2.3).

================================================================================
====================
APPENDIX A - Folder structure
================================================================================
====================
In /components/com_uddeim/
uddeim.php
inbox.php
outbox.php
archive.php
trashcan.php
userlists.php
includes.php
includes.db.php
bbparser.php
crypt.class.php
getpiclink.php
cb_extra.php
json.php
index.html
uddeim_igoogle.xml
recaptchalib.php
captcha.php
captcha15.php
uddeimlib10.php
uddeimlib15.php
uddeimlib16.php
uddeim.api.php
uddeim.xml
monofont.ttf
js/*
templates/*
Optional:
 pfrontend.php
rss.php
attachment.php

In /administrator/components/com_uddeim/
admin.uddeim.php
admin.shared.php
admin.includes.php
admin.usersettings.php
admin.uddeimlib10.php
admin.uddeimlib15.php
admin.uddeimlib16.php
toolbar.uddeim.php
install.uddeim.php
uninstall.uddeim.php
config.class.php
uddeim.xml (Joomla 1.0)
uddeim.j15.xml (Joomla 1.5)
index.html
language/*
language.utf8/*
Optional:
admin.spamcontrol.php
admin.mcp.php