Installation
From ZekrWiki
Contents |
Installation notes
This is the only available installation manual for Zekr. If you are still unable to install it, check out project trouble shooting page. If that wasn't also helpful post your question on project mailing list.
In order to find more add-ons for the software (translations, themes, recitations), check out resources page as well as installation notes for add-ins.
Windows
Windows prerequisites
In order to use Zekr on Windows, you should have:
- Windows 2000, XP or Vista,
- complex language support for your Windows enabled,
- a Java (JRE) 1.4.2 or newer.
- Flash player plugin for your browser (Internet Explorer)
To make sure that you have complex language support on Windows, see this page. There is also a good manual on Wikipedia:
- Enabling complex text support on Windows 2000
- Enabling complex text support on Windows XP and Server 2003
If you don't have Java, get Java , and be careful to enable non-European language support through custom installation.
Windows installation
Zekr is tested and works fine on Windows 2000, XP and Vista. You should simply run executable setup file (zekr-[xyz]-setup.exe, where [xyz] is the version number) to install software on your computer. After installation, you can find Zekr on your programs section in "Start Menu".
Windows trouble shooting
If you had any problem running Zekr, make sure if you have a JRE 1.4.2 (or newer) installed on your system using the following command line (Start > Run > type cmd and click OK):
java -version
This should give you a result like this (note that this is Sun's HotSpot VM, you might have other JVM like IBM's, or BEA's):
java version "1.5.0_02"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_02-b09) Java HotSpot(TM) Client VM (build 1.5.0_02-b09, mixed mode, sharing)
If you are given a result like the following, then you should probably not having Java installed:
'java' is not recognized as an internal or external command, operable program or batch file.
Linux
Ubuntu/Debian
- Add extra Ubuntu/Debian repositories using the Software Sources application, which can be found in the menu: System -> Administration -> Software Sources. Check main, universe, and multiverse repositories (They are necessary for getting sun-java and some additional fonts and flashplugin). Run the following command to update the your package cache:
sudo apt-get update
- To enable Quran recitation feature and install extra fonts run the following commnads:
sudo apt-get install flashplugin-nonfree sudo apt-get install ttf-farsiweb
Install A Compatible Java JRE
Zekr does not work properly with GIJ (GNU Java bytecode interpreter). You have to install one of Sun Java JRE, Icedtea JRE, or OpenJDK JRE.
- Run the following command:
update-java-alternatives -l
If none of java-1.5.0-sun, java-1.6.0-sun, java-7-icedtea, or java-6-openjdk is listed in the result, then you have to install one of sun-java5-jre, sun-java6-jre, icedtea-java7-jre, or java-6-openjdk depending on which one is available to your Ubuntu/Debian distribution.
- To install one of the above JREs like icedtea-java7-jre you can run the following command:
sudo apt-get install icedtea-java7-jre
- Note that if your zekr version >= (0.7.0~beta1) there is no need to set the default JRE to the installed one, otherwise follow the instructions here.
Installing Zekr
There are two ways to install Zekr in Ubuntu/Debian: automatic installation through the #Zekr Repository or #Manual Installation.
Manual Installation
- ttf-me-quran and ttf-sil-scheherazade are two necessary fonts for Zekr. Download them from here. Then install them (Ubuntu example; [xyz] is version and architecture details and should be replaced based on what you have downloaded):
sudo dpkg -i ttf-me-quran_[xyz].deb ttf-sil-scheherazade_[xyz].deb
- Make sure that first you have installed one of the compatible Java JREs discussed in #Install A Compatible Java JRE, if not zekr won't get configured correctly at the installation time.
- Download the latest version of Zekr from here. Get zekr_[version]_i386.deb or zekr_[version]_amd64.deb based on your Machine architecture. Then, Install Zekr with the following command line:
sudo dpkg -i zekr_[xyz].deb
- To install extra Quran translations available for Zekr, download zekr-quran-translation-[ab]-[author]_[version]_all.deb from here ([ab] is the ISO code of the language and [author] is the author of the translation ). Install it by the following command:
sudo dpkg -i zekr-quran-translation-[ab]-[author]_[version]_all.deb
Zekr Repository
- To add the Zekr repository, run the following command in a terminal:
sudo gedit /etc/apt/sources.list
- Add ONLY ONE of the following lines based on your OS (Ubuntu Gutsy 7.10, Ubuntu Feisty 7.04, Ubuntu Edgy 6.10, Ubuntu Dapper 6.06, Debian Etch 4.0, or Debian Sid) at the end of /etc/apt/sources.list
deb http://zekr.org/apt gutsy main deb http://zekr.org/apt feisty main deb http://zekr.org/apt edgy main deb http://zekr.org/apt dapper main deb http://zekr.org/apt etch main deb http://zekr.org/apt sid main
- Add the Zekr repository gpg authentication key
wget -q http://zekr.org/apt/zekr.debian.gpg -O- | sudo apt-key add -
- To install Zekr and the necessary fonts, run the following commands in the terminal:
sudo apt-get update sudo apt-get install zekr ttf-me-quran ttf-sil-scheherazade sudo apt-get install ttf-farsiweb sudo apt-get install flashplugin-nonfree
- Zekr comes with extra Quran translations in English, Russian, Persian, Bahasa Indonesia, Turkish, French, Dutch, Urdu, Bosnian, and Portuguese packaged as zekr-quran-translations-XY where XY is the ISO code of the language. Run
apt-cache search zekr-quran-translations
in a shell to list them all. Then among the result list choose the appropriate package and install it: For example if you want to install English Quran Translations run the following command:
sudo apt-get install zekr-quran-translations-en
Fedora or SUSE
You can simply install .rpm package (if provided) with the following command (having root privilege):
rpm -i zekr-[version]-[xyz].rpm
where [version] is the version of Zekr, and [xyz] is package versioning and architecture info. A full name of an RPM can be: zekr-0.6.6-0.1.i386.rpm.
If you are using base .tar.gz package of the Zekr, you try to put the following code at the beginning of zekr.sh (if your firefox is installed in /usr/lib/firefox):
export MOZILLA_FIVE_HOME=/usr/lib/firefox
It's also probable that the above doesn't work. In that case try to change it to one of the followings until you find one which works:
1. export MOZILLA_FIVE_HOME=/usr/lib/mozilla 2. export MOZILLA_FIVE_HOME=/usr/share/firefox 3. export MOZILLA_FIVE_HOME=/usr/share/mozilla
Other Linux distributions
If you are using other distributions such as Fedora Core or SUSE, simply use our .tar.gz package, but first make sure to set your Mozilla installation directory manually in zekr.sh as MOZILLA_FIVE_HOME variable.
You should first download and install a Mozilla GTK2 (1.4+) browser from mozilla.org (Firefox can also be used on some distributions). You can download Mozilla 1.7.3 GTK2 from Mozilla.org.
Please remember where the Mozilla in installed (examples are /usr/local/mozilla, /usr/share/mozilla, or /usr/lib/mozilla), and check if there is a components folder inside the Mozilla home directory. You should set an environment variable MOZILLA_FIVE_HOME to the Mozilla home directory. If there is no components folder inside Mozilla home, check [mozilla home]/lib, and if there was such a folder, set the environment variable to this location.
To set the variable you can simply run this command at your system startup, or (alternatively) put this line in zekr.sh file:
export MOZILLA_FIVE_HOME=/usr/share/mozilla
or set this variable to whatever location your Mozilla is installed.
Mac
Simple Installation
On many Macs, including Mac OS X Leopard (10.5) and Mac OS X Tiger (10.4.11), you can either unpack .tgz package or simply run .dmp archive. However, if audio doesn't work, try the steps below.
IMPORTANT NOTE: be careful about the path you install Zekr on. If you are installing .tgz package, and path has any white spaces, it fails to run, without any meaningful error message. It is always more safe to put it in the Applications directory.
Enabling Audio Recitation Support If It Is Not Working
The following notes have been compiled on Mac OS X Tiger version 10.4.10. They might work on lower Tiger (10.4.x) versions but no guarantees can be given. The purpose of these instructions is to to get Zekr working with audio recitation support, which on the Mac unfortunately does not work following the regular installation procedure (see above). Also note that the procedure below only works with Zekr 0.6.6 or newer.
IMPORTANT NOTE: After following the procedures below, recitation support is enabled and will work, however there is still a rather annoying cosmetic issue in that the audio controls are not fully rendered on screen initially. However, if you hover your mouse over the area where the controls should be, you'll see that they will (partially) get drawn. This issue is yet to be resolved.
Installation procedure
1. Unpack the archive and I would recommend you install Zekr in the Applications Folder by dragging it there.
2. Ensure you have the latest version of Flash (currently 9,0,47,0) for Firefox (or any Mozilla based browser, such as Flock). You can check this here
3. Ensure you have Java for Mac OS X 10.4, Release 5 or newer. You can check this by opening Terminal and issueing the following command:
java -showversion
This will give you a long listing as shown in picture 1. your version number is right at the top. Alternatively you can also issue this command: java -version, which simply prints the version info.
4. Install XULRunner. You'll require version 1.8.1.2 or newer, which can be found here. If you have an older version currently installed. Please follow the instructions here, to uninstall first.
5. Now in the finder go to the /Library/Internet Plug-Ins folder and select the 'Flash Player.plugin' and the 'flashplayer.xpt' files and copy them (hint; choose Copy from the Edit menu)
6. Now move to the /Library/frameworks/xul.framework/Version/Current folder and open the plugins folder and paste the 'Flash Player.plugin' and the 'flashplayer.xpt' files there.
7. Lastly you'll need to edit the Zekr config.properties file which is in a hidden directory in your home folder. To do this, open the Terminal application and type the following command:
cd .zeker/config
Now issue the following command:
nano config.properties
this will give you the screen shown in picture 2. With your cursor keys move to the line that reads 'options.browser.useMozilla = false' and change 'false' to 'true'. Then exit nano by through the CTRL X key combination and type a 'y' end enter to confirm the changes.
InshAllah that should enable audio recitation for you on the Mac :-)
Picture 1
Picture 2

