Install Simflofy

*Click here for steps on installing Simflofy in a Docker Container

---

Install Java

1. Download the installer for your platform
2. Select Temurin 11 (LTS) and click Latest Release
   1. Run the executable file
3. You may need to give permission to allow changes to your advice.
4. Follow the installer instructions.
   1. Make note of the installation location. You may need it for later steps.

---

Install Apache Tomcat

1. Download the Tomcat 9 package for your platform type
   • MAC install instructions for Tomcat
   • For Windows users, follow the instructions in the setup wizard. You will need the location of your java installation.
2. Start Tomcat
   • Mac Users: Following the instructions MAC install instructions for Tomcat for starting Tomcat from the command line.
   • Windows Users: Inside your tomcat installation, in the 'bin' folder, there is a file, tomcat9w.exe. This application acts a user interface for Tomcats. Allowing you to start/stop the process as well as altering variables like memory and logging locations.
3. You can verify Tomcat has started by checking the url localhost:8080 (or whatever port you set). You should see a tomcat landing page.
4. SHUTDOWN Tomcat for the Simflofy installation.

info

Set the JVM_opts MIN and MAX memory options. Setting your MAX to be as much as possible. -Xmx3072m -Xms1024

Shared Loader (Optional)

A shared loader allows you to keep your simflofy-global.properties and mongo_db.properties from being overwritten when installing a new Simflofy war file. When Simflofy starts, the properties in the shared loader folder will take precedence over the ones in simflofy-admin/WEB-INF/classes.

To set it up:

1. Open tomcat/conf/catalina.properties.
2. Add "${catalina.base}/shared/classes" to shared.loader.
3. If the folder tomcat/shared/classes folder does not exist, create it.
4. Put your simflofy-global.properties or mongo_db.properties file in the new folder.

---

Install MongoDB

1. Download MongoDB 4.x+
   • MAC install instructions for MongoDB
   • For windows installation go here
2. Verify Service is installed and running.
   1. For Mac/Linux, you can simply type mongo into the command prompt, and you should be automatically taken to the mongo shell.
   2. For Windows installations, you will need to navigate to the mongodb installation and open mongo.exe to access the mongo shell.
3. Create the Simflofy database and user in MongoDB by executing the following commands in the mongo shell.

use simflofy; 
db.createUser({"user":"simflofy", "pwd":"PASSWORD",
"roles":["readWrite", "dbAdmin"]});

Passwords

Remember to set your password using your organization's password policy.

caution

In some cases, MongoDB will have some settings that need to be changed. If, during start-up, you encounter this (or a similar) error:

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'simflofyGlobalProperties': Invocation of init method failed; nested exception is com.mongodb.MongoWriteException: error processing query: ns=simflofy_db.tsSimflofyPropertiesTree: key $eq "simflofy.initialize.mongo"

You will want to make sure the MongoDB notablescan setting is false. To do that, you can run these commands against your MongoDB:

Check notable scan
db.adminCommand( { getParameter: 1, notablescan: 1 } )

Set notable scan to false
db.adminCommand( { setParameter: 1, notablescan: 0 } )

---

Install Simflofy Admin Server

1. Copy the Simflofy Admin war file or expanded zip to Tomcat Installation Directory > webapps directory
2. Navigate to the mongo-db.properties file Tomcat > Webapps > Simflofy > Admin > WEB-INF > classes > mongo-db.properties.
3. Set the credentials for the user and the database connection details.
4. Depending on what database you created the admin user in, you may have to append the database name to the end of the uri. This is the authenticating database. The following example config assumes you followed the previous steps exactly.

    mongo.db.username=simflofy  
    mongo.db.password=#whatever password you set during mongo user creation  
    mongo.db.uri=mongodb://[[USER]]:[[PASS]]@localhost:27017/simflofy

5. In the same folder, open simflofy-global.properties and check if all of the 'initialize' properties are set to true. If not, set them to true and save. See the section on properties for more information.

6. If you performed an optional step while installing Tomcat, move the global properties files to the shared/classes folder. Now the properties files will persist after redeploying the war.

7. Start Tomcat

8. Copy and paste the following into your browser

   http://(servername):(port)/simflofy-admin

Default Simflofy Username/Password is admin/admin.

You can find info on architecture/ports, docker installs, getting to the user interface, changing passwords, and the command line utility in the Getting Started with Simflofy Guide.

---

Related Articles:

• Quick Start User Guide
• LDAP Configuration