Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

Installation

The Installation section is intended to get you up and running quickly with a simple SMS sending scenario through :doc:`/apis/http/index` or :doc:`/apis/smpp-server/index`.

Jasmin installation is provided as rpm & deb Linux packages, docker image and pypi package.

Important

Jasmin needs a working RabbitMQ and Redis servers, more info in :ref:`installation_prerequisites` below.

Prerequisites & Dependencies

Jasmin requires Python 3 (Python 2 is no more supported) with a functioning pip module.

Hint

Latest pip module installation: # curl https://bootstrap.pypa.io/get-pip.py | python

Depending on the Linux distribution you are using, you may need to install the following dependencies:

  • RabbitMQ Server, Ubuntu package name: rabbitmq-server. RabbitMQ is used heavily by Jasmin as its core AMQP.
  • Redis Server, Ubuntu package name: redis-server. Redis is used mainly for mapping message ID's when receiving delivery receipts.
  • header files and a static library for Python, Ubuntu package name: python-dev
  • Foreign Function Interface library (development files), Ubuntu package name: libffi-dev
  • Secure Sockets Layer toolkit - development files, Ubuntu package name: libssl-dev
  • Twisted Matrix, Python Event-driven networking engine, Ubuntu package name: python-twisted

Ubuntu

Jasmin can be installed through DEB packages hosted on Packagecloud:

curl -s https://setup.jasminsms.com/deb | sudo bash
sudo apt-get install jasmin-sms-gateway

Note

Ubuntu 20.04 and newer versions are supported.

You have to install and setup RabbitMQ or Redis servers on same machine (Default configuration) or on separate ones (Requires Jasmin configuration: /etc/jasmin/jasmin.cfg).

Note

redis and rabbitmq must be installed and already running.

Once Jasmin installed, you may simply start the jasmind service:

sudo systemctl enable jasmind
sudo systemctl start jasmind

Note

redis and rabbitmq must be installed and already running.

RHEL & CentOS

Jasmin can be installed through RPM packages hosted on Packagecloud:

curl -s https://setup.jasminsms.com/rpm | sudo bash
sudo yum install epel-release
sudo yum install jasmin-sms-gateway

Note

Many dependencies are installed from the Epel repository, please pay attention to activating this repository before installing jasmin-sms-gateway package.

Note

Red Hat Enterprise Linux 8 & CentOS 8 and newer versions are supported.

You have to install and setup RabbitMQ or Redis servers on same machine (Default configuration) or on separate ones (Requires Jasmin configuration: /etc/jasmin/jasmin.cfg).

Note

redis and rabbitmq must be installed and already running.

Once Jasmin installed, you may simply start the jasmind service:

sudo systemctl enable jasmind
sudo systemctl start jasmind

Pypi

Having another OS not covered by package installations described above ? using the Python package installer will be possible, you may have to follow these instructions:

System user

Jasmin system service is running under the jasmin system user, you will have to create this user under jasmin group:

sudo useradd jasmin

System folders

In order to run as a POSIX system service, Jasmin requires the creation of the following folders before installation:

/etc/jasmin
/etc/jasmin/resource
/etc/jasmin/store       #> Must be owned by jasmin user
/var/log/jasmin         #> Must be owned by jasmin user

Installation

The last step is to install jasmin through pip:

sudo pip install jasmin

systemd scripts must be downloaded from here <https://github.com/jookies/jasmin/tree/master/misc/config/systemd> and manually installed into your system, once placed in /lib/systemd/system jasmind shall be enabled and started:

sudo systemctl enable jasmind
sudo systemctl start jasmind

Note

redis and rabbitmq must be started with jasmin.

Docker

Containers are ideal for microservice architectures and for environments that scale rapidly or release often, Here's more from Docker's website.

Installing Docker

Before we get into containers, we'll need to get Docker running locally. You can do this by installing the package for your system (tip: you can find yours here).

Once that's set up, you're ready to start using Jasmin container !

Using docker-compose

Create a file named "docker-compose.yml" and paste the following:

.. literalinclude:: /installation/docker-compose.yml
   :language: yaml

Then spin it:

docker-compose up -d

This command will pull latest jasmin v0.10, latest redis and latest rabbitmq images to your computer:

# docker images
REPOSITORY          TAG                 IMAGE ID            CREATED             VIRTUAL SIZE
jasmin              latest              0e4cf8879899        36 minutes ago      478.6 MB

Jasmin is now up and running:

# docker ps
CONTAINER ID   IMAGE                 COMMAND                  CREATED         STATUS         PORTS                                                                    NAMES
1a9016d298bf   jookies/jasmin:0.10   "/docker-entrypoint.…"   3 seconds ago   Up 2 seconds   0.0.0.0:1401->1401/tcp, 0.0.0.0:2775->2775/tcp, 0.0.0.0:8990->8990/tcp   jasmin
af450de4fb95   rabbitmq:alpine       "docker-entrypoint.s…"   5 seconds ago   Up 3 seconds   4369/tcp, 5671-5672/tcp, 15691-15692/tcp, 25672/tcp                      rabbitmq
c8feb6c07d94   redis:alpine          "docker-entrypoint.s…"   5 seconds ago   Up 3 seconds   6379/tcp                                                                 redis

Note

You can play around with the docker-compose.yml to choose different versions, mounting the configs outside the container, etc ...

Monitoring using Grafana

Through its native exporter for Prometheus you can collect and analyze detailed metrics within a production environment, we will be using the /metrics API (:ref:`get_metrics`) with Prometheus and Grafana in this guide.

Spin the docker-compose including prometheus and grafana file:

docker-compose -f docker-compose.grafana.yml up -d

You should have the following containers up and running:

CONTAINER ID   IMAGE                    COMMAND                  CREATED       STATUS              PORTS                                                                     NAMES
cd7597137e9a   grafana/grafana          "/run.sh"                2 days ago    Up About a minute   0.0.0.0:3000->3000/tcp                                                    jasmin-grafana-1
bd3be30a5cd5   prom/prometheus:latest   "/bin/prometheus --c…"   2 days ago    Up About a minute   9090/tcp                                                                  jasmin-prometheus-1
8209435c2f8d   jasmin-jasmin            "/docker-entrypoint.…"   2 days ago    Up About a minute   0.0.0.0:1401->1401/tcp, 0.0.0.0:2775->2775/tcp, 0.0.0.0:8990->8990/tcp    jasmin
6c88fa5e47db   rabbitmq:alpine          "docker-entrypoint.s…"   2 days ago    Up About a minute   4369/tcp, 5671-5672/tcp, 15691-15692/tcp, 25672/tcp                       jasmin-rabbit-mq-1
a649abd164c8   redis:alpine             "docker-entrypoint.s…"   2 days ago    Up About a minute   6379/tcp                                                                  jasmin-redis-1

Now open Grafana using default username (admin) and password (admin):

http://127.0.0.1:3000

First you'll need to add Prometheus metrics as a Data Source, go to Configuration > Data sources and click on Add data source:

  • Name: Prometheus
  • URL: http://prometheus:9090

Keep defaults the Save & test.

Now you can start playing around with the collected metrics, go to Explore and play with the autocomplete feature in Metrics browser by typing httapi, smpps or smppc.

You can also explore metrics of a defined SMPP client connector by setting the cid tag, example of getting number of bound session of a specific connector:

smppc_bound_count{cid="foo"}

Note

The complete set of metrics exposed by Jasmin can be checked through the /metrics http api, these metrics are also exposed through jcli's :ref:`stats_manager` module.

Kubernetes cluster

@TODO: add link to documented stresstests

This part of the documentation covers clustering Jasmin SMS Gateway using Kubernetes, it is also made as a reference setup for anyone looking to deploy Jasmin in complex/cloud architectures, this is a proof-of-concept model for deploying simple and advanced clusters, these were used for making stress tests and performance metering of the sms gateway, documented here.

Before you begin you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. It is recommended to run this tutorial on a cluster with at least two nodes that are not acting as control plane hosts. If you do not already have a cluster, you can create one by using minikube or you can use one of these Kubernetes playgrounds:

Your Kubernetes server must be at or later than version v1.10. To check the version, enter kubectl version.

Simple k8s architecture

This is barely simple architecture with running pods and a SMPP simulator to allow simple functional or performance testing.

Note

This section of the guide uses the provided Kubernetes objects located in this directory.

Start by adjusting the namespace in configmaps.yml: replace the rabbitmq and redis hosts to hostnames provided by your own Kubernetes cluster then deploy:

  1. kubectl apply -f redis.yml
  2. kubectl apply -f rabbitmq.yml
  3. kubectl apply -f jasmin.yml

You should have the cluster up and running within seconds, your Jasmin pod must log to stdout the following messages:

INFO 1 Starting Jasmin Daemon ...
INFO 1 Interceptor client Started.
INFO 1 RedisClient Started.
INFO 1 AMQP Broker Started.
INFO 1 RouterPB Started.
INFO 1 SMPPClientManagerPB Started.
INFO 1 DLRLookup Started.
INFO 1 SMPPServer Started.
INFO 1 deliverSmThrower Started.
INFO 1 DLRThrower Started.
INFO 1 HTTPApi Started.
INFO 1 jCli Started.

Warning

If you don't have the indicated above logged lines to Jasmin's pod stdout then you are having troubles somewhere, do not step forward before solving them.

Now you can connect jcli by first running a port-forward and then connecting to the forwarded port:

kubectl port-forward jasmin 8990:8990

Then:

telnet 127.0.0.1 8990

Note

The kubectl port-forward command will not return unless you ctrl-c to stop the port-forward, the second command (telnet) needs to be run in another terminal session.

You can now make the same steps to port-forward the smpp (2775) port or the http (1401) port and start using Jasmin.

If you need to connect Jasmin to a provided smpp simulator then first deploy the simulator:

kubectl apply -f smppsimulator.yml

And then add a new SMPP client connector by following these steps:

smppccm -a
> cid smpp_simulator
> host smppsim.test.farirat.svc.cluster.local
> username smppclient1
> password password
> ok
smppccm -1 smpp_simulator

You will also need to create a group, user and at least a mt route to make your first sms delivery test, this guide is your friend !

Note

You may adjust the host value in the example above to your own host (provided by your Kubernetes cluster).

Advanced deployment architecture

[work in progress]

Sending your first SMS

For the really impatient, if you want to give Jasmin a whirl right now and send your first SMS, you'll have to connect to :doc:`/management/jcli/index` and setup a connection to your SMS-C, let's assume you have the following SMPP connection parameters as provided from your partner:

Basic SMPP connection parameters
Paramater Description Value
Host Host of remote SMS-C 172.16.10.67
Port SMPP port on remote SMS-C 2775
Username Authentication username smppclient1
Password Authentication password password
Throughput Maximum sent SMS/second 110

Note

In the next sections we'll be heavily using jCli console, if you feel lost, please refer to :doc:`/management/jcli/index` for detailed information.

1. Adding SMPP connection

Connect to jCli console through telnet (telnet 127.0.0.1 8990) using jcliadmin/jclipwd default authentication parameters and add a new connector with an CID=DEMO_CONNECTOR:

Authentication required.

Username: jcliadmin
Password:
Welcome to Jasmin console
Type help or ? to list commands.

Session ref: 2
jcli : smppccm -a
> cid DEMO_CONNECTOR
> host 172.16.10.67
> port 2775
> username smppclient1
> password password
> submit_throughput 110
> ok
Successfully added connector [DEMO_CONNECTOR]

2. Starting the connector

Let's start the newly added connector:

jcli : smppccm -1 DEMO_CONNECTOR
Successfully started connector id:DEMO_CONNECTOR

You can check if the connector is bound to your provider by checking its log file (default to /var/log/jasmin/default-DEMO_CONNECTOR.log) or through jCli console:

jcli : smppccm --list
#Connector id                        Service Session          Starts Stops
#DEMO_CONNECTOR                      started BOUND_TRX        1      0
Total connectors: 1

3. Configure simple route

We'll configure a default route to send all SMS through our newly created DEMO_CONNECTOR:

jcli : mtrouter -a
Adding a new MT Route: (ok: save, ko: exit)
> type defaultroute
jasmin.routing.Routes.DefaultRoute arguments:
connector
> connector smppc(DEMO_CONNECTOR)
> rate 0.00
> ok
Successfully added MTRoute [DefaultRoute] with order:0

4. Create a user

In order to use Jasmin's HTTP API to send SMS messages, you have to get a valid user account, that's what we're going to do below.

First we have to create a group to put the new user in:

jcli : group -a
    Adding a new Group: (ok: save, ko: exit)
    > gid foogroup
    > ok
    Successfully added Group [foogroup]

And then create the new user:

jcli : user -a
Adding a new User: (ok: save, ko: exit)
> username foo
> password bar
> gid foogroup
> uid foo
> ok
Successfully added User [foo] to Group [foogroup]

5. Send SMS

Sending outbound SMS (MT) is simply done through Jasmin's HTTP API (refer to :doc:`/apis/http/index` for detailed information about sending and receiving SMS and receipts):

http://127.0.0.1:1401/send?username=foo&password=bar&to=06222172&content=hello

Calling the above url from any brower will send an SMS to 06222172 with hello content, if you receive a response like the below example it means your SMS is accepted for delivery:

Success "9ab2867c-96ce-4405-b890-8d35d52c8e01"

For more troubleshooting about message delivery, you can check details in related log files in /var/log/jasmin:

Messaging related log files
Log filename Description
messages.log Information about queued, rejected, received and sent messages
default-DEMO_CONNECTOR.log The SMPP connector log file