Getting Started with ApPHP EasyInstaller (for version 3.0.0 or above)

• 1. Getting Started with ApPHP EasyInstaller.
  • 1.1 Step 1. Setting up parameters.
  • 1.2 Step 2. Preparing SQL dump file.
  • 1.3 Step 3. Blocking unexpected access to application.
  • 1.4 Step 4. Start installation process.

After ApPHP EasyInstaller was installed, you have to perform following steps:

Step 1. Setting up parameters in file settings.php.

---

Open file settings.inc.php in any text editor and change all parameters according to your needs.

There are some important parameters in this file:

1. GLOBAL SETTINGS
--------------------------------
EI_MODE
the mode of installation. There are 3 possible modes: demo, debug and production

EI_VERSION
the current version of EasyInstaller

EI_DEFAULT_LANGUAGE
specifies a default language, ex.: en - English, es - Spanish, de - German

EI_DEFAULT_LANGUAGE_DIRECTION
specifies a default language direction: ltr or rtl

EI_TEMPLATE
specifies template name

2. GENERAL SETTINGS
--------------------------------
EI_CHECK_PHP_MINIMUM_VERSION/EI_PHP_MINIMUM_VERSION
checks if minimum required version of PHP runs on a server

EI_CHECK_CONFIG_DIR_WRITABILITY
specifies whether to check configuration directory for writability or not

EI_CONFIG_FILE_DIRECTORY
the name of directory where the configuration file is placed For ex.: "../common/" or "common/" - according to directory hierarchy and relatively to start.php file

EI_CONFIG_FILE_NAME
the name of the file that will be created after installation. This file will include connection parameters to you database: database host, database name, database user and user password

EI_CONFIG_FILE_PATH
the full path of file that will be created after installation


EI_CHECK_MAGIC_QUOTES
allows collecting info for magic quotes

EI_CHECK_MBSTRING_SUPPORT
allows collecting info for mbstring support

EI_CHECK_MAIL_SETTINGS
allows collecting info for email settings

EI_CHECK_EXTENSIONS
allows collecting info about PHP extensions

EI_CHECK_MODES
allows collecting info about PHP modes

EI_CHECK_DIRECTORIES_AND_FILES
specifies whether to check defined directories and files

EI_USE_ADMIN_ACCOUNT
specifies whether to accept admin username and password


3. DATABASE SETTINGS
--------------------------------
EI_DATABASE_CREATE
specifies whether to force database creation

EI_DATABASE_TYPE
specifies a database type: mysql - MySql, pgsql - PostgreSQL, sqlite/sqlite2 - SQLite etc..

EI_CHECK_DB_MINIMUM_VERSION/EI_DB_MINIMUM_VERSION
checks if a minimum required version of database engine runs on a server

EI_USE_USERNAME_AND_PASWORD
specifies whether to accept admin username and password

EI_USE_PASSWORD_ENCRYPTION
specifies whether to encrypt or not admin password

EI_PASSWORD_ENCRYPTION_TYPE
type of encryption - AES or MD5

EI_PASSWORD_ENCRYPTION_KEY
password encryption key for AES encryption


4. CONFIG PARAMETERS
--------------------------------
EI_ALLOW_NEW_INSTALLATION
specifies whether to allow new installation

EI_ALLOW_UPDATE
specifies whether to allow update

EI_ALLOW_UN_INSTALLATION
specifies whether to allow un-installation

EI_ALLOW_START_ALL_OVER
specifies whether to allow start all over button


EI_SQL_DUMP_FILE_CREATE
file that include SQL statements for instalation. Make sure they don't include commented lines, like: -- ## etc.

EI_SQL_DUMP_FILE_UPDATE
file that include SQL statements for update

EI_SQL_DUMP_FILE_UN_INSTALL
file that include SQL statements for un-instalation


EI_USE_ENCODING/EI_DUMP_FILE_ENCODING/EI_DUMP_FILE_COLLATION
defines using of utf-8 encoding and collation for SQL dump file


EI_ALLOW_MANUAL_INSTALLATION
allow manual installation

EI_MANUAL_INSTALLATION_DIR
manual installation text directoiry and text files


5. CONFIG TEMPLATE PARAMETERS
--------------------------------
EI_CONFIG_FILE_TEMPLATE
template of the configuration file


6. APPLICATION PARAMETERS
--------------------------------
EI_APPLICATION_NAME
the name of your script (program)

EI_APPLICATION_VERSION
version number of your application

EI_APPLICATION_START_FILE
the name of the default starting file of your script (application)

EI_LICENSE_AGREEMENT_PAGE
path to the license agreement page (if exists)

EI_POST_INSTALLATION_TEXT
additional text after successful installation

 

Step 2. Preparing SQL dump file.

---

Using phpMyAdmin or another tool, create SQL dump file and download the entire SQL dump file to you computer. Replace content of this file with the content of sql_dump/create.sql, sql_dump/update.sql and/or sql_dump/un-install.sql files. In admins table replace username and password values with <USER_NAME> and <PASSWORD> and put before all table names <DB_PREFIX> (for example: `<DB_PREFIX>test`).

 

Step 3. Blocking unexpected access to your application.

---

Add these lines of code at the top of the default starting file of your script (application):

require_once("inc/config.inc.php");
if(!file_exists(EI_CONFIG_FILE_PATH)){        
    header('location: install/start.php');
    exit;
}

 

Step 4. Start Installation Process.

---

To start installation process just type in your browser

http://{your_site_address}/(your_script_directory)/install/start.php

NOTE: Remember! For security reasons you need to delete install/ directory after installation is complete.