Installation

The Installation section is intended to get you up and running quickly with a simple SMS sending scenario through HTTP API or SMPP Server API.

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 Prerequisites & Dependencies 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:

version: "3"

services:
  redis:
    image: redis:alpine
    restart: unless-stopped

  rabbit-mq:
    image: rabbitmq:alpine
    restart: unless-stopped

  jasmin:
    image: jookies/jasmin:0.10
    restart: unless-stopped
    container_name: jasmin
    volumes:
      - /var/log/jasmin:/var/log/jasmin
    ports:
      - 2775:2775
      - 8990:8990
      - 1401:1401
    depends_on:
      - redis
      - rabbit-mq
    environment:
      REDIS_CLIENT_HOST: redis
      AMQP_BROKER_HOST: rabbit-mq

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 …

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 Management CLI overview 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 Management CLI overview 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 HTTP API 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