Get Started

This page is related to LIME 2.1, you might be interested in Get Started LIME 2.0 or in Get Started LIME 1.0.

LIME is an Open Source language independent markup editor which has a very simple installation process that will take you less than five minutes to be completed.

If you wish to install LIME editor yourself you have just to check, on your web server, only few system requirements and fill a very tiny installation form.

If you wish to build LIME from the source code or change it you need to read also the development instructions.

Before installing

Before you begin the install, there are a few things you need to have.

Things to have on your server

Access via FTP or SSH
An HTTP Server
The latest release of LIME unzipped on your web server drive
An instance of eXist-db and related admin credentials
An instance of MongoDB (3.0 or later)
Node.js (version 6.0 or later)
Java (needed by Saxon XSLT processor and Scriba, the Ebook generator)
A running installation of Abiword used to import of binary document formats

Optional things to have on your server

PHP 5.3.2 or later, it’s required if you want to run AkomaNtoso automatic markup or AkomaNtoso Diff service.

How to install

Here’s a little list of steps to follow to complete the installation of LIME.

Get LIME

Download and unzip the LIME package if you haven’t already. The package contains the following folders:

LIME folder constains the client and two PHP services: AkomaNtoso automatic markup and AkomaNtoso Diff.
lime-server is the Node.js server of LIME which contains Users and Documents manager and AkomaNtoso related services.

lime-server

Follow these steps in order to setup the server:

Extract the “lime-server” folder from the downloaded zip.
Change the default port in “aknservices/config.json” (default is 9006)
Modify “aknservices/documentsdb/config.json”
- Set the MongoDb url/port in “mongodb.url“
- Set the filesystem path for storing xml files in “filesystem.documents“
- Set the exist host (“exist.host“), port (“exist.port”) and credentials (“exist.auth“)
Run “npm install“
Run the server “node server.js“

For more detailed instructions go here.

Web server

Move the “LIME” folder from the package on the HTTP server working directory (e.g. /var/www)
If you desire to integrate LIME into the root of your domain (e.g. http://example.com/), move all contents of the unzipped directory (excluding the LIME directory itself) into the root directory of your web server.
If you want to have your LIME installation in its own subdirectory on your web site (e.g. http://example.com/whateveryouwant/), rename the LIME directory on your server into whateveryouwant

Optional PHP server

We’re porting the server side of LIME from PHP to Node.js but it’s still work in progress, now PHP is optional because there’re only two services written in PHP: AkomaNtoso automatic markup and AkomaNtoso Diff. If you want to use these services, you have to serve the “LIME/php” folder with a PHP compatible web server e.g. Apache.

LIME client

At this point you need to configure the LIME client by changing the “app.json” file, you can find it in the root of the LIME directory which is inside the web server directory as you move it in the “Web server” section of this page.

Open the “app.json” file with your favorite text editor.
Change the “limeConfig.server.node” value with your lime-server Node.js server url (e.g. http://localhost:9006).
Optional, change “limeConfig.fieldsDefaults” fields with your document defaults. You can specify the following properties “docLocale“, “docLang“, “docType“.
Save the “app.json” file.

…and that’s it!

Your LIME instance should now be installed.