Skip To Content

INTEGRAL

Getting Started

This page describes the steps necessary to get INTEGRAL running on your own Windows, macOS or Linux machine.

INTEGRAL Desktop

  1. Download INTEGRAL Desktop for your platform, then extract integral-desktop-<platform>-<version>.zip to a suitable directory on your computer. We'll refer to this directory as <integral_extract_dir>.

  2. Open Terminal (Command Prompt on Windows) and set your INTEGRAL working directory:

    Windows

    cd <integral_extract_dir>\exec\

    macOS and Linux

    cd <integral_extract_dir>/exec/

  3. Now run the integral-interp program from the INTEGRAL working directory to interpret one of the example INTEGRAL documents located in the <integral_extract_dir>/integral/docs-basic/demos/ directory. For example, the job recommendation letter:

    Windows

    integral-interp-win.bat ..\integral\docs-basic\demos\letter-job.i

    macOS

    ./integral-interp-osx ../integral/docs-basic/demos/letter-job.i

    Linux

    ./integral-interp-linux ../integral/docs-basic/demos/letter-job.i

  4. Your sample letter will open in INTEGRAL Document Editor. It should look like thisPDF. If not, it's probably a permission related problem.

  5. NOTE: If you wish to modify one of the sample INTEGRAL documents, simply open them using your favourite text editor. INTEGRAL files are standard UTF-8 text files that have a .i extension. You can set your text editor to use Squirrel, C++, C or Java syntax highlighting in order to display INTEGRAL files.

Next Steps...

INTEGRAL Server

  1. Download INTEGRAL Server for your platform, then extract integral-server-<platform>-<version>.zip to a suitable directory on your computer. We'll refer to this directory as <integral_extract_dir>.

  2. Open Terminal (Command Prompt on Windows) and set your INTEGRAL working directory:

    Windows

    cd <integral_extract_dir>\exec\

    macOS and Linux

    cd <integral_extract_dir>/exec/

  3. Now start the web server from the INTEGRAL working directory:

    Windows

    integral-signal-win.bat start

    macOS

    ./integral-signal-osx start

    Linux

    sudo su
    ./integral-signal-linux start

    Note: The server will start in the background, so you can continue to use the shell.

  4. The web server will automatically connect the application server, then display some initialization messages, and start listening to incoming connections. If not, it's probably a permission related problem.

  5. Launch your favourite web browser and open the default INTEGRAL website from the following URL:

    http://localhost:9880

    Your default INTEGRAL website should look like this (external page).

  6. NOTE: The web server's configuration files are located in the following directory:

    <integral_extract_dir>/exec/config/websrv/

    If you wish to modify the port number(s) on which the web server listens, add additional sites, or change any other server and/or site settings, see the Configuration Guide section for additional information.

Next Steps...