Direct Download Instructions


This page explains how to install the Ubuntu Distribution of M-Pin SSO.


  1. Installing via APT repository
  2. Installing package directly


To install M-Pin SSO from our APT repository, run the following commands:

  1. To import the SSO repository key:

    wget -q http://cvx-repo.certivox.com/key -O- | sudo apt-key add -
  2. To add the SSO repository to your /etc/apt/sources.list file:

    echo "deb http://cvx-repo.certivox.com/ trusty main" >> /etc/apt/sources.list

    If you are not logged into your server as root, the above command will fail, because the '>>' write to file is a second command which also requires root access

  3. To update your sources:
    apt-get update
  4. Run the apt-get install command to get SSO on your system:

    apt-get install mpin-sso

    This will install the latest M-Pin SSO (currently v4.0). If you need to install v3.5, run the following command: apt-get install mpin-sso-3.5

  5. Once all the dependencies are listed, you will be prompted to continue. Press y at this prompt:
    0 upgraded, 162 newly installed, 0 to remove and 20 not upgraded.
    Need to get 92.6 MB of archives.
    After this operation, 200 MB of additional disk space will be used.
    Do you want to continue? [Y/n]
  6. The apt program will install the dependencies neeeded to run M-Pin SSO automatically and will prompt you to continue with the installation. Type yes if you want to continue:
    No previous installation found, proceed with installation? [yes/no] yes
    Proceeding with M-Pin Core installation...
    Downloading components [1/5] (mpin3.5_python2.7_x86_64bit_linux.tar.gz)
    Downloading components [2/5] (mpin3.5_mobile.tar.gz)
    Downloading components [3/5] (mpin3.5_mpincommand.tar.gz)
    Downloading components [4/5] (mpin3.5_pythonlibs.tar.gz)
    Downloading components [5/5] (mpin3.5_servers.tar.gz)
    M-Pin Server has been installed into the following folder /opt/mpin.
    For a list of helpful commands, navigate to the install directory and type: ./mpin --help.
    To quickly test out the built-in demo, run: ./mpin start all.
    Then open a browser on the same machine and visit: http://127.0.0.1:8005.
    Select Sign in from here and follow the on-screen instructions.
    For more details on testing the demo site, please visit: http://docs.certivox.com/testing-the-demo-site
    For the next steps, go to http://docs.certivox.com/getting-started
    The M-Pin Core documentation home page can be found here: http://docs.certivox.com/m-pin-core
    ...
  7. The installation will then prompt you to create a new Credentials File. If you are installing M-Pin SSO for the first time, type Y.
    The installer needs to know whether to create a Credentials File for this installation. You SHOULD NOT CREATE a
    Credentials File if this installation is to be part of a cluster with an existing M-Pin SSO server which already has a
    Credentials File. A Credentials File MUST BE CREATED if this installation is stand-alone (not part of a cluster) or if
    it is the first server to be created for a cluster.
    ...
    If unsure, see the following help page: http://docs.certivox.com/installing-m-pin-sso-direct-download-distribution-only
    Create a Credentials File for this installation? [y/n]

At this point you SHOULD CREATE a Credentials File if your installation is stand-alone (not part of a cluster) or if it is the first server to be created for a cluster.

However, a Credentials File SHOULD NOT BE CREATED if this installation is planned to be a part of a cluster with an existing M-Pin SSO server which already has a Credentials File.

Therefore proceed with one of the following two options:


Press Enter
Provide or skip entering your email address (it is recommended that you provide an email address).
You will get the following console output:

  Getting Dedicated D-TA keys... Done

After a few seconds, the following text is displayed to indicate that your M-Pin SSO has been installed successfully and is now operational:

  Your M-Pin SSO is now up and running. You can access it at: http://HOST where HOST is the Public DNS or
  Public IP address of your M-Pin SSO machine (Port 80 must be enabled).

You are now ready to access your newly-created M-Pin SSO instance. You can find instructions in the 'First Time Access' section of the menu.

Type No and press Enter. You will get the following output:

  You chose not to create a Credentials File for this installation.
  To make this installation operational, copy your existing Credentials File (credentials.json) to the following folder: /opt/mpin
  Proceeding with installation, please wait…

After a few seconds, the following text will indicate that your M-Pin SSO has been installed successfully.

  Your M-Pin SSO is now up and running. You can access it at: http:// where is the Public DNS or Public IP address of
  your M-Pin SSO machine (Port 80 must be enabled).

Now, to make your M-Pin SSO installation operational, you must copy the Credentials File from another SSO server within the cluster. This can be done with either:

  cp <sso-server1>/opt/mpin/credentials.json <sso-server2>/opt/mpin/credentials.json

Now you can start the required services with the following commands:

  sudo /usr/sbin/service mpin start   
  sudo /usr/sbin/service mpinSSO start

After running these commands, your M-Pin SSO will be up and running and you will be able to access it at: http://HOST where HOST is the Public DNS or Public IP address of your M-Pin SSO machine. (Port 80 must be enabled).

You are now ready to access your newly-created M-Pin SSO instance. You can find instructions in the 'First Time Access' section of the menu.


  1. Download the installation package (a .deb file) and copy it to your User’s home directory.
    The download location is https://mpin-install.miracl.com/sso_4.0.x86_64
    You can also use the following command:
    wget --content-disposition https://mpin-install.miracl.com/sso_4.0.x86_64

    Note: The actual link for the installation package might be subject to change.
    If you want to install v3.5 use this command:

    wget --content-disposition https://mpin-install.miracl.com/sso_3.5.x86_64
  2. Update the local package manager index.
    Run:
    sudo apt-get update

    When finished, the last line of the console output should be:

    Reading package lists... Done
  3. Install the M-Pin SSO package.
    Run:
    sudo dpkg -i <deb-package>

    where <deb-package> is the name of the installation package file. For example, sudo dpkg -i mpin-sso-4.0.x86_64.deb
    some required dependencies will be missing, so the process will finish with an error message:

    <…>
    dpkg: error processing package mpin-sso (--install):
    dependency problems - leaving unconfigured
    Errors were encountered while processing:
    mpin-sso
  4. Install the dependencies:
    sudo apt-get -f install

    You will be prompted to confirm the upgrade operation:

    The following packages will be upgraded:
    libc6
    1 upgraded, 170 newly installed, 0 to remove and 117 not upgraded.
    1 not fully installed or removed.
    Need to get 66.0 MB of archives.
    After this operation, 190 MB of additional disk space will be used.
    Do you want to continue? [Y/n]

    Type Y and press Enter or just press Enter.
    Upgrading the packages may take a couple of minutes.

Next, you will be asked whether this installation is part of a cluster of existing M-Pin SSO Servers:

The installer needs to know whether to create a Credentials File for this installation.
...
A Credentials File SHOULD NOT BE CREATED if this installation is planned to be a part of a cluster with an existing M-Pin SSO server which already has a Credentials File.
...
A Credentials File MUST BE CREATED if this is installation is stand-alone (not part of a cluster) or if it is the first server to be created for a cluster.
...
If you are not sure of the next steps, see the following help page: http://docs.MIRACL.com/installing-m-pin-sso-direct-download-distribution-only
...
Create a Credentials File for this installation? [y/n]

At this point you SHOULD CREATE a Credentials File if your installation is stand-alone (not part of a cluster) or if it is the first server to be created for a cluster.

However, a Credentials File SHOULD NOT BE CREATED if this installation is planned to be a part of a cluster with an existing M-Pin SSO server which already has a Credentials File.

Therefore proceed with one of the following two options:


Press Enter
Provide or skip entering your email address (it is recommended that you provide an email address).
You will get the following console output:

  Getting Dedicated D-TA keys... Done

After a few seconds, the following text is displayed to indicate that your M-Pin SSO has been installed successfully and is now operational:

  Your M-Pin SSO is now up and running. You can access it at: http:// where is the Public DNS or Public IP address of
  your M-Pin SSO machine (Port 80 must be enabled).

You are now ready to access your newly-created M-Pin SSO instance. You can find instructions in the 'First Time Access' section of the menu.

Type No and press Enter. You will get the following output:

  You chose not to create a Credentials File for this installation.
  To make this installation operational, copy your existing Credentials File (credentials.json) to the following folder: /opt/mpin
  Proceeding with installation, please wait…

After a few seconds, the following text will indicate that your M-Pin SSO has been installed successfully.

  Your M-Pin SSO is now up and running. You can access it at: http:// where is the Public DNS or Public IP address of
  your M-Pin SSO machine (Port 80 must be enabled).

Once you have copied your Credentials File, to make your M-Pin SSO installation operational, start the required services with the following commands:

  sudo /usr/sbin/service mpin start   
  sudo /usr/sbin/service mpinSSO start

After running these commands, your M-Pin SSO will be up and running and you will be able to access it at: http://HOST where HOST is the Public DNS or Public IP address of your M-Pin SSO machine. (Port 80 must be enabled).

You are now ready to access your newly-created M-Pin SSO instance. You can find instructions in the 'First Time Access' section of the menu.