###### SVN Revision Info ################### # $Rev: 1509 $ # $Author: patdunlavey $ # $Date: 2007-10-11 11:37:22 -0700 (Thu, 11 Oct 2007) $ ############################################ # ====================================================================== # AdvoKit -- a campaign managment tool # Copyright (C) 2004 OrchidSuites, Inc. (info@orchidsuites.net) # # This program is free software; you can redistribute it and/or # modify it under the terms of the AFFERO GENERAL PUBLIC LICENSE # as published by Affero, Inc.; either version 1 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # AFFERO GENERAL PUBLIC LICENSE for more details. # # You should have received a copy of the AFFERO GENERAL PUBLIC LICENSE # along with this program; if not, write to Affero, Inc. at # 510 Third Street - Suite 225, San Francisco, CA 94107, USA # or visit . # ====================================================================== If you are reading this, then you must have extracted the Advokit 2.0 or later distribution. For detailed installation instructions, see http://www.advokit.net (click the 'Documentation' link and then 'Advokit Installation'. ADVOKIT INSTALLATION REQUIREMENTS: * Apache/IIS Advokit has been tested on the Apache and IIS webservers, but will probably run on any server that supports PHP. * PHP Your webserver must be running PHP 4.2.8 or above. PHP 5 has been tested. You DO NOT need to have register_globals on for Advokit to work. * MySQL MySQL version 4.21 or above must be installed. The installer provides an option to create transaction-safe (InnoDB) tables if your MySQL installation supports such tables. * Smarty The Smarty template engine must be installed. Preferably 2.6.2 or above. Advokit was mostly developed with version 2.0, but 2.3 and 2.6.2 have been used extensively. 2.6.2 is bundled with this release. HOW TO INSTALL ADVOKIT (1) Set up MYSQL database. You will need to work with your hosting service or local system administrator to create a MySQL database that you have access to. To set up AdvoKit, you will need to know: * the web address for the MySQL server * the database name * the port number used to access the database server * a valid user name and password on that MySQL server with privileges to create tables in that database. (2) Extract distribution. Extract the distribution tarball somewhere under your webroot. This will create the directory advokit-installer-2-0 in the directory where you extracted the file. (3) Set permissions. The webserver must be able to read the directories in the distribution you just extracted. The webserver must be able to write to the directory advokit-installer-2-0/install/templates_c. You can be lazy and just make sure the new directory is FULLY readable and writeable by your webserver process, like so: - For unix/linux, just do a chmod -R 777 on advokit-installer-2-0. If you know the user and group for the webserver process, you are better off doing a chown -R user.group advokit-installer-2-0. - For windows, make sure "Everyone" has "Full Control" over advokit-installer-2-0, and that these permissions are propagated to subdirectories. However, if you do this, be aware that your webserver may vulnerable to attack while you install AdvoKit. In any case, make sure you blow away the installer directory immediately after you finish installing. It won't be needed at that point. (4) Browse to the installation page. If your webserver is set up properly, then just browse to the directory advokit-installer-2-0 that you just created. Otherwise, browse directly to advokit-installer-2-0/install/index.html. (5) Follow the directions. There aren't many. There are about 15 pieces of information you must specify, such as database host, user, password, installation directories, and so on. You will be prompted each time such information is required. (6) Delete the installation directory After the installation completes, you can login as user "admin", password "admin". Change the admin password as soon as you login. NOTE: If the installation fails because certain directories don't exist and the webserver can't create them, don't give up. Each time this happens, installer will tell you exactly what directory to create. Just create the directory and set permissions so that the webserver can write to it. Then click the "Go Back" button and try again. Eventually you will be able to continue. This is typically only a problem with either Windows servers, or with Unix servers in a shared hosting environment. If you have problems installing, or you have general comments or questions, join the advokit-dev listserv at http://lists.voter2voter.org/listinfo.cgi/advokit-dev-voter2voter.org or visit http://www.advokit.net. Be sure to check http://www.advokit.net for updates.