How to get Jorani?

You can get the full source code on Github. You can use it freely provided that you respect the GNU GPL v3 license.

Download the latest version

Follow these links to download Jorani:

The default user and password are bbalet.

Install Jorani

Once you have downloaded Jorani, you can install it on any operating system with a web server, PHP 5.3 (or higher) and a MySQL or MariaDB database.

Starting to use Jorani

Once installed, we recommend the reading the following articles:

  • Follow the Getting Started Guide. This is the complete list of things to do and check before using Jorani. It will explain the most important concepts.
  • Read the tutorial. (coming soon).

What is the difference between the zip files

From Github, you can download various files, but they don't have the same content. In the following paragraphs, we will try to explain the diferences between them. From the Github repository of the project, open the Releases tab:

  • Release tab is accessed by the code tab on the frontpage

    How to access to the Release tab

With the example of the release v0.6.5 Stable release (NO DB patch), we can see three files:

  • Github automatically generates developer files when releasing a new version

    Each release contains three different files

These files are not for the same people:

  • jorani-0.6.5.zip This is the file you should download if you want to install Jorani.
  • Source code (zip) This file is for developers.
  • Source code (tar.gz) This file is for developers.

Many people who doesn't know how Github works try to download the archive file from the front page of the project. The name of the archive is master.zip. It contains a working copy of the code of Jorani but for developers. So please don't download this file unless you know what you are doing.

  • Github's master file is used by developers

    You should not download the master file

Should I patch the database?

If you are installing Jorani for the first time, you don't need to patch the database. In this case, you'd just follow the installation procedure. The name of a release of Jorani tells you if you need to patch or not. Below are two examples.

  • v0.6.5 Stable release (NO DB patch). If you are using a version 0.6.x, you don't need to patch your database. However, if you use an older version such as 0.4.x or older, you must patch the database.
  • v0.6.0 Stable (needs a DB Patch). You must patch the database whatever the version you are using.

Please note that the database patches are not cumulative.

If you are a developer

If you have downloaded the master file of Jorani or if you clone it, please note that the vendor directory is not contained into the archive. We don't track the changes into Github neither. So you need to download or install the dependencies by using composer. Composer is a dependency manager and Jorani requires a lot of dependencies to work.

Once you have installed composer and added it to your system's path, open a terminal and go into the folder where you've installed Jorani. Into the terminal run the following command:

composer install

It will download all the external libraries needed by Jorani. As of today, Jorani uses the following libraries:

  • RSA Encryption in pure PHP: https://github.com/phpseclib/phpseclib
  • Excel import/export https://github.com/PHPOffice/PHPExcel
  • OAuth2 Server https://github.com/bshaffer/oauth2-server-php
  • OAuth2 Client https://github.com/thephpleague/oauth2-client
  • OAuth2 Google Provider https://github.com/thephpleague/oauth2-google
  • Sabre/VObject https://github.com/fruux/sabre-vobject
  • PHPMailer https://github.com/PHPMailer/PHPMailer
  • PHPMailer CI wrapper https://github.com/ivantcholakov/codeigniter-phpmailer


Fatal error: require_once

The symptom is a PHP fatal error that prevents you from using the system:

 Fatal error: require_once(): Failed opening required '......./autoload.php'

This error occurs if you have downloaded the wrong file from Github (master.zip). It may also occur with developers cloning the repository and not familiar with composer. Applying the procedure described into the paragraph If you are a developer will solve the issue.

Backup, restore and migration

If you want to migrate Jorani on a new server or wondering about backup and restore, you should read the backup and restore guide.

Tags :    configure 

You may also like

comments powered by Disqus