Menu
▾
▴
[573437]: / INSTALL Maximize Restore History
147 lines (112 with data), 6.3 kB
Installing Mifos
This file describes how to install Mifos for use in a production environment.
1. Software Requirements
Before you can run Mifos, you will need to download and install
the software packages below. Please see their respective web
sites for details on how to install each package.
* Sun Microsystems Java - JDK/JRE 1.6 (see Note)
* MySQL - Community Edition 5.1.31
* Apache Tomcat - 6.0.18
Note: While most Mifos testing has been done using the JDK,
only the JRE is needed to run Mifos.
2. Upgrading Mifos
If you are upgrading Mifos from a previous release please refer to the pages
referenced below. For general upgrade procedures see:
http://www.mifos.org/knowledge/support/deploying-mifos/upgrading-mifos
For upgrade instructions for this release see:
http://www.mifos.org/knowledge/support/deploying-mifos/upgradeto15
3. Configuring MySQL
3.1. Setting Database Parameters
Use the following configuration settings for MySQL. You can configure
these settings using MySQL Administrator or by editing the my.ini file
in your MySQL home directory.
max_connections=300
innodb_buffer_pool_size=1024M
innodb_file_per_table
log-error=mysql_error.log
log-slow-queries=mysql_slow_query.log
long_query_time=1
3.2. Initializing the Mifos Database
To initialize the Mifos database, run the four commands below from the
directory that contains this INSTALL file. These commands assume a
schema named "mifos", a username of "mifos" and a password of "mifos".
Adjust them if your database login is different. See sections 6.1.4
and 7.1 for more information.
mysql -u mifos -pmifos < sql/create_mifos_db.sql
mysql -D mifos -u mifos -pmifos < sql/latest-schema.sql
mysql -D mifos -u mifos -pmifos < sql/latest-data.sql
mysql -D mifos -u mifos -pmifos < sql/init_mifos_password.sql
If your database instance already has a "mifos" database, then
you will need to drop the database before running the above commands.
4. Setting Java and Apache Tomcat Parameters
Set the following environment variables:
JAVA_HOME ... directory where the JDK is installed (if using the JDK)
JRE_HOME ... directory where the JRE is installed (if using the JRE)
CATALINA_HOME ... directory where Tomcat is installed
CATALINA_OPTS ... -Xms1024M -Xmx1024M -XX:MaxPermSize=256m
5. Installing the Mifos WAR
Copy the mifos.war you downloaded to CATALINA_HOME/webapps. If the
following temporary directories exist, delete them:
CATALINA_HOME/webapps/mifos
CATALINA_HOME/work/Catalina/<hostname>/mifos
(Where <hostname> is the name of your server.)
6. Configuring and Running Mifos
6.1. Configuring Mifos
Because some settings in Mifos can only be changed from their default
values once, before Mifos is run for the first time, you should review
the default Mifos configuration. See section 7.1 for more information.
6.1.1. Using the Default Configuration
A default configuration is provided. If you want to quickly get
Mifos up and running to try it out, then no configuration is
needed.
6.1.2. Using a Custom Configuration
Create and set a new environment variable:
MIFOS_CONF ... directory for Mifos custom configuration files
(see http://www.mifos.org/knowledge/support/deploying-mifos/configuration/guide
for further details and options).
6.1.3. Changing the Default Mifos Configuration
To make changes to the default configuration, copy the file
config/applicationConfiguration.custom.properties to the
MIFOS_CONF directory defined in 6.1.2.
6.1.4. Changing the Default Database Connection Settings
To use non-default settings for your database connection --
such as a different port number, user name, or password -- copy
the file config/local.properties to the MIFOS_CONF directory
defined in 6.1.2.
6.2. Running Mifos
Execute the Tomcat startup script in CATALINA_HOME/bin, or if Tomcat
was installed as a service on Windows, navigate to Control Panel >
Administrative Tools > Services to verify that the service's status
is "Started".
Next, visit the base URL in a browser:
http://localhost:8080/mifos
username: mifos
password: testmifos
7. Mifos Documentation Links
Use the following links for more information about Mifos.
7.1. Configuring Mifos -
http://www.mifos.org/knowledge/support/deploying-mifos/configuration/guide
Pay particular attention to "trapdoor" settings (settings that can
only be changed to a non-default value once) in the application
configuration file. Chart of Accounts configuration is one such
"trapdoor".
7.2. Release Notes -
http://www.mifos.org/developers/wiki/ReleaseNotes/V15
7.3. System Recommendations (hardware, networking) -
http://www.mifos.org/developers/wiki/MifosSystemRecommendations
7.4. Ubuntu Install Guide -
http://www.mifos.org/developers/wiki/MifosUbuntuInstall
This is an installation guide describing how to install Mifos by
building it from the source code.
7.5. Ubuntu Quick Install Guide -
http://www.mifos.org/developers/wiki/UbuntuWARInstall
This is an installation guide describing how to install Mifos from the
WAR file, similar to this INSTALL file.
7.6. Windows Install Guide -
http://www.mifos.org/developers/install-mifos/install-windows
This is an installation guide describing how to install Mifos by
building it from the source code.
8. Third Party Licenses
All software libraries used by Mifos are compatible with the Apache License
2.0. To obtain a report detailing these licenses, execute "mvn site" in a
local copy of the Mifos source code.