Read Me File - WAnewsletter 2.2-RC2b


Please take time to read this file carefully, it contains important information.

Sommaire
  1. Required configuration
  2. Installation : Quick start
  3. Installation : Detailed explanations
  4. Updating from version 2.2.x
  5. Updating from versions 2.0.x/2.1.x
  6. Updating from version 1.1
  7. Hosts causing problems
  8. Author's notes

I. Required configuration
WAnewsletter requires php version 4.1.0 and up, as well as either MySQL, Microsoft SQL Server or PostgreSQL database managers.
Certain optional features might not be available depending on your server's configuration and installed libraries.
Example : the statistics module requires that the GD library is installed.
Top

II. Installation : Quick Start
WAnewsletter contains a very simple installation script, so that neophytes can quickly use the script.

  1. Upload all files contained in the archive on your server or hosting account, using your favorite ftp client (retain the directory structure)
  2. Set writing permissions on the includes/ and upload/ directories.
  3. Point your web browser to the install.php file in its proper location and open it (eg: http://www.yourdomain.com/newsletter/setup/install.php if the script is installed in the newsletter folder in the site's root)
  4. Fill out the displayed form and click on the validation button.
  5. Once the script is installed, remove writing permissions on the includes/ directory
  6. After installation, remove the setup/ directory from your server or hosting account in order to prevent from reinstallation.
Top

III. Installation : Detailed explanations

To correctly install WAnewsletter, you first have to upload all of the script's files to your server or hosting account.

All files should be uploaded in ASCII mode, except for graphics used by the script which are located in the images/ and templates/images/ folders. These graphics should be uploaded in binary mode.
With your favorite ftp client, set writing permissions on the upload/, tmp/, stats/ and includes/ directories.

Explanations :

The upload/ folder will contain the files which you might attach to your outgoing messages. In order for the script to correctly put these files in the upload/ folder, it has to have writing permissions.
The script offers the option of having attached files located on a remote ftp server. In this case, you can remove the upload/ folder.
About the tmp/ folder, please read the corresponding section the ths script's FAQ.
The stats/ folder will hold the files used by the statistics module. This folder is useless if the GS library is not available on your server or hosting account.
During the installation, the script creates a configuration file and puts it in the includes/ folder. This folder must also have writing permissions, but only during the installation phase! Once the installation has completed, remove wirting permissions on the folder.

Once all files are on the server, and proper writing permissions are set, using your favorite browser, go to the location where this install.php file is placed.

Example :

You have uploaded the script at your site's root, in a folder named "newsletter". You should then type "http://www.yourdomain.com/newsletter/setup/install.php" in your web browser's address bar.

You have now reached the installation form.
Please take note that if you change the language item before clicking the validation button, the same page will reload, but this time in the chosen language.
Most of the time, the database server's name will be "localhost", but it could be different. If you do not know your database server's name and/or the necessary access parameters, contact your hosting service. (Note: the access password is not necessay for the form validation phase, convenient for local tests).
A tables' prefix is also asked, in order to avoid possible conflicts with other already existing tables that might have the same name as one of WAnewsletter's tables.

You should the enter parameters for the administration of the script, since its access is protected. You can later add other users with personnalized access rights.

The site's url corresponds to your site's address, eg : http://www.yourdomain.com
The script's url corresponds to the path to the script's folder, relative to your site's root, eg : /newsletter/ (Important: please note that the path's name must start and end with a slash (/) )

Once the script is installed, remove writing permissions ont the includes/ folder et remove the setup/ folder from your host.

Top

IV. Updating from version 2.2.x
To update from version 2.2.x, download the new version and replace files from the old version with those from the new one (keep the config.inc.php file, and any content located in the upload/ and stats/ folders).
Point your web browser to the install.php file in its proper location and open it.
Fill in your administrator username and password and let the script finish the installation.
Once the installation is done, remove the setup/ folder.
Top

V. Updating from 2.1.x or 2.0.x
To update from version 2.0.x or 2.1.x, download the new version and replace files from the old version with those from the new one (keep the config.inc.php file, and any content located in the upload/ and stats/ folders).
It is stongly advisable to make a backup of your script's database tables before proceeding with the update !
Set writing permissions to the includes/ folder for the time you proceed with the update.
Point your web browser to the update.php file in its proper location and open it.
Fill in your administrator username and password and let the script finish the update procedure.
Once the update procedure is done remove the setup/ folder, and remove the writing permissions from the includes/ folder.
Top

VI. Updating from version 1.1
There is no update script from version 1.1 supplied with versions 2.2.x and up.
The only way to work around this problem is to first update from version 1.1. to version 2.1.x, and then from 2.1.x to 2.2.x.
Top

VII. Hosts causing problems
Important ! This script will not work on Free hosting, it is therefore useless to try !

On multimania/lycos, outgoing emails (in number of recipients) are limited ot 150 a day.

If safe mode is activated on your server, the script needs a few minor adjustments. Please refer to the script's FAQ
Top

VIII. Author's notes
This script is freely distributed under the GPL license
This means you can use it or modify it as you like, as long as the copyright and author's mention stay as they are. Please, carefully read the GPL license for more details.
This script does not contain any type of publicity (like mentions at the bottom of emails or elsewhere). However, you can, if you wish and are satisfied with this script, put a link to the phpcodeur web site anywhere on your site (at the bottom of the registration form for instance).
A 88x31 WAnewsletter button is also available in the images/ folder for those who wish to use it..
Top


Powered by phpCodeur © 2002-2003 | WAnewsletter 2.2-RC2b
This script is freely distributed under the GPL license