The miniOrange identity provider (IdP) is a service that stores and verifies user identity. IdPs are typically cloud-hosted services, and they often work with single sign-on (SSO) providers to authenticate users.The purpose of this guide is to get you up and run as quickly as possible so that you can play with and test-drive various features that miniOrange has. It is a standalone application with default database and packaged tomcat and does not cover any complex deployment options. We support both windows and linux os for installation.
This short tutorial walks you through starting up the server in standalone mode, setting up the initial admin account, and logging into the miniOrange admin dashboard.
System Requirements
miniOrange On-premise server has the following system requirements. This section lists recommended versions and requirements.
- Operating System: Any operating system that runs minimum Java 8
- CPU Core: 4 Core
- RAM: 4GB or above
- HDD: 20GB or above
- JAVA Environment: JDK 1.8.0_251 and above
- Server Access Policies: Port 80 (HTTP Port) Port 1812, 1813 (Radius UDP Port), RDP Port(Windows Server)- For login, SSH Port(Linux Server)- For login
- Database: Find the list of all supported versions here.
Install On-Premise Server
You can install miniOrange On-premise server in following ways:
Follow the steps to deploy miniOrange On-premise server on your operating system:
Prerequisites:
- Installation of JDK 1.8 requires login through the oracle account. If you don't have the oracle account, Click here to directly install JDK 1.8.
- If JAVA is already installed and Environment variables are set correcty on your system, then you dont need to follow this step, you can directly go to Install On-Premise Server.
Note:
Once the Java installation is complete, check that the JAVA_HOME environment variable has been set correctly.Open a command prompt and type echo %JAVA_HOME% and hit Enter. If you see a path to your Java installation directory, the JAVA_Home environment variable has been set correctly. If nothing is displayed, or only %JAVA_HOME% is returned, you'll need to set the JAVA_HOME environment variable manually.
- Set Java environment variables i.e. JAVA_HOME and JRE_HOME and path variables. Lets say JDK software is installed on your computer, for example, at C:\Program Files\Java\jdk1.8.0_221 then JAVA_HOME and JRE_HOME paths can be as mentioned -
- JAVA_HOME - C:\Program Files\Java\jdk1.8.0_221
- JRE_HOME - C:\Program Files\Java\jdk1.8.0_221\jre
- To Save these variables, right click My Computer and select Properties > Advanced
System Settings.Click the Environment Variables button.Under System Variables, click
New.In the Variable Name field, enter:
- JAVA_HOME - C:\Program Files\Java\jdk1.8.0_221
- JRE_HOME - C:\Program Files\Java\jdk1.8.0_221\jre
- Also update the path variable set with path : path_to_JAVA_HOME/bin. You can Read more about java specfic environment variables.
- You can verify whether above environment variables are set correctly. Execute below commands to verify environment variables -
echo %JAVA_HOME%
echo %JRE_HOME%
Start miniOrange On-premise IDP Server:
- To start the miniOrange server, go to the mo-idp-server-<version>/bin directory of the server distribution (i.e. folder with name similar to mo-idp-server-1.0.3 (version may vary)). Execute the startup file based on your environment.
> ...\bin\startup.bat
Run Tomcat as a Service for miniOrange IDP
- Make sure your environment variable like JAVA_HOME and CATALINA_HOME are set.
- Navigate the to <Tomcat Root Directory>/bin.
- Open a CMD in the current directory and run mo-service.bat
- You will be prompted with an administrator grant screen. Click Yes.
- Enter the required information and hit Enter.
- The miniOrange Service should be installed successfully.
- Open linux terminal using your root profile.
- Locate folder which contains the downloaded on-premise mo-idp-installer.sh script file (mo-idp-installer.sh).
- Run the following command in terminal:
sh mo-idp-installer.sh
- You will be prompted to install JAVA. Type "n" if JAVA 8 is already installed, if not type "y". As shown below:
- After pressing "y", JAVA 8 will be installed.
- Once the Java installation is completed, miniOrange Onpremise zip file will be downloaded & extracted from the source
- In case if JAVA 8 is already present, the script will directly download miniOrange onpremise zip and extract it in the same folder.
- In case, some other version of JAVA is already installed, you will receive the message "Java 8 not found". Let the script install JAVA 8 by pressing "y" when requested.
- Once the extraction is completed, IDP server will automatically start up and can be accessed through http://localhost:8080/initialize
- After extraction of the file you can see the folder "mo-idp-server-X as shown below.
- As Tomcat has already started up, you can check the logs in catalina.out file */mo-idp-server-X/logs/catalina.out as shown below:
- Go to http://localhost:8080/initialize and setup your database.
- You can download OpenJDK8 package using
apt install openjdk-8-jdk for Debian, Ubuntu, etc. OR
yum install java-1.8.0-openjdk for Fedora, Oracle Linux, Red Hat Enterprise Linux, etc.
- If JAVA is already installed and Environment variables are set correcty on your system, then you dont need to follow this step, you can directly go to Install On-Premise Server.
Note:
Once the Java installation is complete, check that the JAVA_HOME environment variable has been set correctly. Open a terminal and type echo $JAVA_HOME and hit Enter. If you see a path to your Java installation directory, the JAVA_Home environment variable has been set correctly. If nothing is displayed you'll need to set the JAVA_HOME environment variable manually.
- Linux users can use below commands to set JAVA_HOME and JRE_HOME variables using below commands -
export JAVA_HOME=/path/to/jdk
export JRE_HOME=/path/to/jre
- You can verify whether above environment variables are set correctly. Execute below commands to verify environment variables -
echo $JAVA_HOME
echo $JRE_HOME
- To start the miniOrange server, go to the mo-idp-server-<version>/bin directory of the server distribution (i.e. folder with name similar to mo-idp-server-1.0.3 (version may vary)). Execute the startup file based on your environment.
- Linux/Unix: Execute chmod +x startup.sh to give executable permission to this file. Set relevant
permission of mo-idp-server folder to allow the creation of new folder like temp or logs folder – chmod
755.
$ .../bin/startup.sh
Run Tomcat as a Service for miniOrange IDP
- Install Tomcat as Linux Service from Apache project site.
- Unpack the tomcat folder in opt directory. For this, you will need a terminal and root access.
- Create Tomcat user with restricted permissions:
groupadd tomcat
useradd -s /sbin/nologin -g tomcat -d /opt/mo-idp-server tomcat
passwd tomcat
- Set the tomcat user as the owner of the $CATALINA_HOME folder.
chown -R tomcat.tomcat /opt/mo-idp-server
- Configure Tomcat to run as a Service
Using init.d
- Navigate to /etc/init.d , create a directory named as tomcat and paste the below code.
#!/bin/bash
## Change the path of mo-idp folder below
### BEGIN INIT INFO
# Provides: tomcat
# Required-Start: $network $remote_fs $syslog
# Required-Stop: $network $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Start Tomcat at boot time
# Description: Start Tomcat at boot time
### END INIT INFO
export JAVA_HOME=/usr/lib/jvm/jre
export CATALINA_HOME=/opt/<PATH OF MiniOrange IDP Folder>
export JAVA_OPTS="-Xms250m -Xmx1024m"
RETVAL=$?
case $1 in
start)
if [ -f $CATALINA_HOME/bin/startup.sh ];
then
echo $"Starting Tomcat"
su -p -s /bin/sh tomcat $CATALINA_HOME/bin/startup.sh
fi
;;
stop)
if [ -f $CATALINA_HOME/bin/shutdown.sh ];
then
echo $"Stopping Tomcat"
su -p -s /bin/sh tomcat $CATALINA_HOME/bin/shutdown.sh
fi
;;
*)
echo $"Usage: $0 {start|stop}"
exit 1
;;
esac
exit $RETVAL
- The script shown above would have a LSB type header to define dependencies and runlevels.
- To make the script executable:
chmod ug+x /etc/init.d/tomcat
- Configure the system to run the script at boot:
sudo update-rc.d tomcat defaults # Debian, Ubuntu
sudo chkconfig --add tomcat # Red Hat & co.
- If you want to remove the service:
sudo update-rc.d -f tomcat remove # Debian, Ubuntu
- To start/stop the script manually:
service tomcat [start | stop]
- Or the old-fashioned way (Ubuntu):
/etc/init.d/tomcat [start | stop]
1. Setup Database
- After tomcat startup, open http://localhost:8080 in browser. You will see a page to choose a database configuration for the identity server. You can choose where you would like to store its data.
- miniOrange On-Premise Identity Provider gives you the flexibility to choose your database type. We support Embedded H2 Database which is a light weight database good for testing purposes. Later you can migrate to your production database type that is supported in the external database section. In External Database section, we support PostgreSQL (11+), MySQL (8+) and Oracle Databases.
Note:
Before you proceed with Embedded H2 database, make sure your system has given write permission to the IdP folder i.e. mo-idp-server-<version> folder. If not then first assign the write permission to the IdP folder to avoid getting stuck in permission issues. Write permission is required because Embedded H2 database is created in IdP folder with the folder named data.
2. Setup Admin Account
- Setup your Admin Account. Enter a Username and Password for your admin account.
- Once your admin account is created, you will be auto logged in to the dashboard screen.
3. Setup Custom Branding
Modify the Server Base URL in General Product Settings in the IdP
- On miniOrange admin dashboard, go to Settings >> Product Settings (present on the right top).
- Enter the Server Base URL as shown in the image below.
Run miniOrange IDP server over SSL (Optional)
Note:
Before moving forward, you need to make two changes related to samesite cookie. Starting with version 80, Google Chrome will change the default value for the SameSite cookie parameter to Lax. Therefore, changes are required and SameSite parameter has to be set to NONE.
To do changes, follow the path: mo-idp-server-<version>/moas/WEB-INF/classes. In this folder search for the file spring-context-onpremise and open it in editor. Search for bean id="customCookie". you will see a bean with name,samesite and secure properties. Update value of samesite from LAX to NONE and of secure to true.
1. Generate a Keystore
- Open a command prompt or terminal. And go to <Path to JAVA_HOME/bin> path and enter the command given below.
keytool -genkey -alias onpremssoidp -keyalg RSA -keystore onpremssoidp.jks
- If you get a permission error (mostly on a windows machine) in this step.Then change the location in command prompt or terminal to Desktop or any other location of your choice.
- Enter your convenient password and remember it.(If the password you entered didn’t work then keep the password as “changeit” ).
2. Generate SSL Certificate
- After Pressing the Return key it will prompt for a password for <onpremssoidp>. Hit Return to continue.
(Note: firstname and lastname needs to be the server DNS name/hostname of the server)
- SSL self-signed certificate is generated at the given location.
3. Configure Tomcat with above-generated Keystore
Using a certificate from Trusted CAs like LetsEncrypt, GoDaddy, Comodo SSL.
Creating a New Keystore
- Navigate to the directory where you plan to locate the new keystore.
- Enter the following command:
keytool -genkey -alias server -keyalg RSA -keysize 2048 -keystore your_site_name.jks
- When prompted, create a password for your new Keystore.
- Enter the required information (Note: Do not type your own name into the name field, type your
FQDN).
- When finished, verify your information by typing “Y” or “Yes”.
- Finally, enter the password you just created in step three.
Creating a CSR on Tomcat Servers
- Run the following command:
keytool -certreq -alias server -file csr.txt -keystore your_site_name.jks
- Once prompted, enter the password you created in step three of the Keystore instructions
- Use the information you supplied when creating the keystore. The CSR will be generated and saved
in the chosen directory as “CSR.txt.”
- We recommend saving and backing up the keystore file once you’ve complete generating the CSR. Once
you’ve got the CSR complete, choose the SSL certificate you’d like to install on your Tomcat server
and then purchase it, copy/pasting the CSR (open the .txt file) into the relevant field (usually the
one labelled CSR).
- Once the purchase and validation are complete, the CA will email you a bundle that includes your
SSL certificate and an intermediate certificate that needs to be installed with it.
How to Install an SSL Certificate on Your Tomcat Server
- Save your certificate(s) to the Keystore directory you created.
- Use the following command to import the keystore:
keytool -import -alias server -file your_site_name.p7b -keystore your_site_name.jks
- You should see a confirmation message that says: “Certificate reply was installed in keystore.”
- Type “Y” or “Yes” to trust the certificate.
- Now, finally, we just need to configure the Tomcat server to serve the website via HTTPS.
Configuring Your SSL/TLS Connector
- Using a text editor, open your Tomcat server.xml file.
- Locate the connector you want to secure with your new keystore.
- Configure the connector to use port 443 (HTTPS), your configuration file should look something
like this:
<Connector port="443" maxHttpHeaderSize="8192" maxThreads="100"
minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" scheme="https" secure="true"
SSLEnabled="true" clientAuth="false"
sslProtocol="TLS" keyAlias="server"
keystoreFile="/home/user_name/your_site_name.jks"
keystorePass="your_keystore_password" />
- Save the changes to your server.xml file.
- Restart your Tomcat server.
- If the above methods dont work follow the link given below
- Click here to follow the steps if you have any other CA certificates.
Migration from Zip Distribution to Installer
- Navigate to your current Tomcat Installation Directory and take backup of your current moas directory present in <tomcat-root>
- Take a backup of your database. In case you are using the internal integrated database,then you can take a backup of the data folder present in the <tomcat-root>. In the case of an external database, you can take a snapshot of the DB.
- Take backup of <tomcat-root>/conf/server.xml file if you have added additional connectors for SSL in tomcat itself.
- Delete the current tomcat installation.
- In case of it being installed as a service then make sure to uninstall the Windows Service.
- Download the installer and run the downloaded installer file and install the latest On-Premise Server.
- Stop the On-Premise service which was just installed.
- Go to the installed directory root.
- Go to path <moas-backup-root>/WEB-INF/classes/ and copy db.properties and license files.
- Go to path <On-Premise-service-root>/moas/WEB-INF/classes/ and paste the db.properties and license files.
- Start the On-Premise IDP Server service that you installed.
Upgrade On-premise IDP
- Download the latest version of the Windows Installer from the downloadables section.
- Run the installer, it will automatically detect and install the latest version.
- Stop the IDP Server.
- Navigate to your current Tomcat Installation Directory and take backup of your current moas directory present in <tomcat-root>.
- Take a backup of your database. In case you are using the internal integrated database,then you can take a backup of the data folder present in the <tomcat-root>. In the case of an external database, you can take a snapshot of the DB.
- Now replace the moas folder in the Tomcat Root Directory with the moas folder present in the downloaded package.
- Now copy over the following files from backup moas to the newly deployed moas.
- \moas\WEB-INF\classes\license.
- \moas\images\logo.png
- \moas\images\favicon.ico
- Start the Tomcat Server.
Prerequisites:
- Login to your admin account and go to Settings>>Product Settings. Copy your Server Base URL.
- Take a backup of the miniorange db in your db instance.
- Take a backup of the following files in the server.
- mo-idp-server-3.*/moas/WEB-INF/classes/db.properties
- mo-idp-server-3.*/moas/WEB-INF/classes/license
- Go to mo-idp-server-3.*/bin and Shut down the running tomcat instance. (you can use sh shutdown.sh)
Steps to upgrade:
- Download the latest version to your linux server and unzip it.
- You will find moas folder inside the uncompressed folder. Replace the mo-idp-server-3.3.*/moas with the new moas folder
- Replace the backups of db.properties and license file on the same path as mentioned above.
- Go to mo-idp-server-3.*/bin and Shut down the running tomcat instance. (you can use sh shutdown.sh)
- Restart the tomcat instance using sh startup.sh
- Open a browser and go to < Your-Server-Base-URL >/initialize
Uninstall On-premise IDP
- Navigate to Add or remove Programs on your windows System.
- Search for miniOrange in the list and click on uninstall.
- Click Yes when prompted for confirmation.
- Let the uninstall process be completed.
- Click OK on the confirmation prompt.
- If you have installed the Tomcat as a Windows Service then we need to remove that first. Navigate to <Tomcat Root>/bin directory and open a CMD in the current directory. Run the command
mo-service.bat uninstall
- Delete the Tomcat Directory.
- Shutdown any running miniorange tomcat process/ service.
- Take any backups you might need for the database.
- Go to the folder mo-idp-server-3.* and delete it.
