Installation On-premise
This page explains how to install MobbID if you want to host the service on your own on-premise or on your preferred cloud provider.
Please make sure you are familiar with these tools since we are using them in the installation process:
Distribution deployment file
When you are ready to install the MobbID server on your own on-premise or your development environment you will received a deployment file mobb-id-deployment-x.y.z.zip
:
It contains:
- README.md: Readme file with all the instructions to proceed with the installation.
- Vagrantfile: Vagrant file with the definition of the VirtualBox instance for the local deployment.
- site.yml: Ansible script for the instalation of all required components: bbdd, application server, libs and the MobbID application itself.
- mobb-id-work-x.y.z-distribution.zip: The actual MobbID app is containt within this file along with some scripts and the required native libraries.
You can either configure your remote server or deploy a virtual machine locally.
Deployment
Local Deployment
You can use the mobb-id-deployment
file to easily configure a local environment using Vagrant to create a virtual machine and ansible to configure everything in just a few minutes.
Note: Please make sure you have vagrant, ansible and virtual box installed on your local environment
To deploy MobbID locally:
- Unzip the
mobb-id-deployment
file - Open a terminal or command line, access the just unzipped mobb-id-deployment folder
- Execute
vagrant up
.
The ansible playbook should take care of everything and, in a few minutes, you should have a MobbID server ready to use in http://localhost:8080/mobb-id
If you want to use some other port you can tweak the configuration in the Vagrantfile
Remote deployment
Follow these instructions if you want to deploy MobbID into your remote server. Following steps are made for Amazon AWS EC2, but they could be easily adapted for an Azure instance or any other vendor as well.
Tip: Upload your public key to the EC2 instance and configure it in the ~/.ssh/authorized_keys. Test that you can access with
ssh ubuntu@YOUR_EC2_IP
Also make sure you open the 8080 TCP port on your EC2 instance
- Use the terminal or command line to access to previously unzipped
mobb-id-deployment
folder - Execute this command
ansible-playbook -i YOUR_EC2_IP, site.yml --user ubuntu
Once the deployment is finished you should be able to access the MobbID service in http://YOUR_EC2_IP:8080/mobb-id
Check your installation
To check that you've successfully deployed MobbID you can access the /test.json operation. It should give you this result:
{
cryptography_status: "OK, maxKeyLength is 2147483647",
database_access: "DDBB conection is OK",
code: "OK"
}
If you don't see a similar result please contact your technical support.
Version deployed
You can also check which version you have deployed with the /version.json
{
"code": "OK",
"description": "OK",
"platformVersion": "4.5.0",
"buildDate": "2017-10-17 15:23"
}
Install your license
If the installation have been successful there should be a folder named mobb-id-work
under the CATALINA_BASE
folder (default Tomcat directory). If you are using Ubuntu this is usually in /var/lib/tomcat7
. This in the content of the mobb-id-work:
|-- cfg
|-- changelog.txt
|-- database
|-- lib
|-- lic
|-- samples
`-- webapp
To be able to create, enroll and verify users you need to set up your license file. You must copy the license file in the $CATALINA_BASE/mobb-id-work/lic
folder and change the owner of the file so it is the tomcat's users who own them:
drwxr-xr-x 2 root root 4096 Oct 31 12:56 ./
drwxr-xr-x 9 root root 4096 Oct 31 12:36 ../
-rw-r--r-- 1 tomcat7 tomcat7 1280 Oct 31 12:56 your-license-file.lic
-rwxr-xr-x 1 tomcat7 tomcat7 3162 Oct 31 12:36 publicMobbeelLicense.gpg*
Advanced configuration
Once you got your own MobbID server instance you can tweak the configuration to it suits your need. Please check out the configuration section.