Skip to content

Chapter-Download_Install.adoc

Latest commit

 

History

History
161 lines (126 loc) · 5.72 KB

Chapter-Download_Install.adoc

File metadata and controls

161 lines (126 loc) · 5.72 KB
Raw

Downloading

Installing {this-platform} {this-application} is easy and quick with the binary download. You can either download the binary release or download the source code and set up from source.

Binary Download

The binary release is available for download at the following link: {https://github.com/RestComm/jss7/releases/tag/7.3.1398}

Procedure: Binary Download

  1. Download the zip file {path}.zip to any folder of your choice.

  2. Extract the contents of the zip file.

    Downloads]$ unzip {path}.zip

  3. Verify the contents of the newly created directory.

When you download the binary release, you will notice that the top level directory is named {path} and immediately below this are 7 sub-directories named asn, _docs, oam, sctp, ss7, ss7-jboss and ss7-wildfly encompassing the major services and libraries that make up {this-platform} {this-application} . For details on what is included in the sub-directories, please refer to the {this-platform} {this-application} User Guide.

The major functional modules of the {this-application} are:

  1. SS7 Service [dir: {this-folder}-ss7-service]

  2. Signaling Gateway [dir: {this-folder}-ss7-sgw]

  3. Shell [dir: shell]

  4. SS7 Simulator [dir: {this-folder}-ss7-simulator]

|- {this-folder}-jss7-{project-version}
		|- asn

		|- _docs

		|- oam

		|- sctp

		|- ss7
				|+ protocols
				|+ shell
				|+ {this-folder}-ss7-simulator
				|+ {this-folder}-ss7-trace-parser

		|- ss7-jboss
				|+ {this-folder}-ss7-service
				|+ {this-folder}-ss7-sgw
				|+ template

		|- ss7-wildfly
                |+ {this-folder}-ss7-service
                |+ template

Setup from Source

{this-platform} {this-application} is an open source project and you have the freedom to build from source. Building from source means you can stay on top with the latest features. Whilst aspects of {this-platform} {this-application} are quite complicated, you may find ways to become contributors.

{this-platform} {this-application} works with JDK1.7 or above. In addition you must have the following tools installed.

Pre-Requisites for Building from Source

  • Git Client : Instructions for using GIT, including install, can be found at http://git-scm.com/book

  • Maven 3.2.X : Instructions for using Maven, including install, can be found at http://maven.apache.org/

  • Ant 1.9.X : Instructions for using Ant, including install, can be found at http://ant.apache.org

  • jmxtools:jar : This library is required to build the Simulator source code. The library com.sun.jdmk:jmxtools:jar:1.2.1 must be downloaded manually and placed in your maven repository. Instructions are provided below.

Instructions to Download jmxtools:jar for building Simulator source code are as follows:

Release Source Code Building

  1. Downloading the source code

    Checkout a specific release source using GIT. The base URL to clone from is {this-release-source-code-url}. Then add the specific release version, in the below example we are downloading the version {project-version}.

    [usr]$ git clone {this-release-source-code-url} jss7
[usr]$ cd jss7
[usr]$ git checkout

  2. Building the source code

    Now that we have the source code, the next step is to build and install the source. {this-platform} {this-application} uses Maven 3 to build the system. There are two build profiles namely default and dahdilinux. The Default profile builds only the java source code. The profile "dahdilinux" compile relevant native modules in addition to building the java source.

    Note
    		 At the moment, native modules are supported only for Linux OS.

    • Building using "default" Build profile

      To build {this-platform} {this-application} without building any native libraries use the default profile as shown below.

      [usr]$ cd jss7
[usr]$ mvn install
      Note
      		 If you are using {this-platform} {this-application} without any native dependencies, {this-platform} {this-application} can run on any OS.

    • Building using "dahdilinux" profile

      Use this profile only if the linux server on which this code is built has dahdi module installed. Make sure you pass the "include.zap" system property with a value pointing to the directory where dahdi is installed

      [usr]$ cd jss7
[usr]$ mvn install -Pdahdilinux -Dinclude.zap=/usr/include/dahdi

  3. Use Ant to build the binary.

    [usr]$ cd jss7/release
[usr]$ ant

Development Trunk Source Building

To build from development trunk source, follow the same procedure as above but at the time of checkout do not switch to the specific release tag.

[usr]$ git clone {this-release-source-code-url} jss7
[usr]$ cd jss7
[usr]$ git checkout

The rest of the steps are as outlined in the above section Release Source Code Building