Enterprise 4.12 Installation

Sections Available in Enterprise Installation

Function	Description
Installation Requirements	Discover the specific hardware, software, and system prerequisites needed for a successful Enterprise V4.12 installation
Pre-Installation	Prepare your device step-by-step instructions, including tasks such as system configuration, database setup, and user account management.
Installation Instructions	Follow the detailed installation steps provided in the guide to install Enterprise V4.12 on Innoslate.
Innoslate Setup	To successfully set up Innoslate, follow the detailed steps provided in this section.
Troubleshooting	Install seems to not be working? Check out our troubleshooting tips.
Configuration Notes	Settings.Properties File

Installation Requirements

Minimum Requirements:

• Operating System: Windows 10, 11, Server 2016/Server 2019/Server 2022
• Processor: Dual Core Processor
• RAM: 4GB RAM
• Hard Drive Space: 10GB Free Hard Drive Space, a Solid State Drive is recommended (500MB is required for Innoslate Server Files)
• Database: PostgreSQL or Microsoft SQL Server 2008 or higher (Full Text Search must be on in SQL)

Recommended Requirements:

• Operating System: Windows 10, 11, Server 2016, Server 2019, Server 2022
• Processor: Quad Core Processor
• RAM: 8GB RAM
• Hard Drive Space: 25GB Free Hard Drive Space, a Solid State Drive is recommended (500MB is required for Innoslate Server Files)
• Database: PostgreSQL or Microsoft SQL Server 2008 or higher (Full Text Search must be on in SQL)

Pre-Installation Checklist

• Install a compatible database: Innoslate supports SQL Server 2008 (or later) or PostgreSQL.
• Create the database in SQL or PostgreSQL.
  • Guides:
    • SQL
    • PostgreSQL
• Confirm the following ports are open: 8080, 8005, 443, and either 1433 (SQL Server) or 5432 (PostgreSQL).
• Verify system meets minimum installation requirements.
• Ensure usernames and passwords for database or Innoslate accounts do not contain the following special characters: #, %, ^, &, +, ", ', \, {, }, |, !.
• Enterprise users must generate a unique Innoslate License ID from the machine where Innoslate will be used before receiving their official License Key (see Steps 3 & 4 in the Innoslate Setup section). Skip this step if you already have a license.
• Download Innoslate Enterprise v4.12: Innoslate 4.12 Installer (file download begins upon clicking).

Note for Existing Environments: If you have a pre-configured settings.properties file from a previous Innoslate installation, you can bypass the Innoslate Setup Wizard. Refer to the article Streamlining Innoslate Setup from an Existing Enterprise Environment for instructions.

Installation Instructions

1. Run the Innoslate Enterprise v4.12 installer as an administrator.
2. If Microsoft Defender flags an unverified app, click "Run Anyway".
3. When prompted to allow Innoslate to make changes to your computer, click “Yes”.
4. The Innoslate Setup Wizard will open. Click “Next” to proceed.
5. Agree to the license agreement by clicking “I Agree”.
6. Ensure the Innoslate4 and Service components are selected for installation, then click “Next”.
7. Choose the destination folder (default: C:\Innoslate4) and click "Install".
8. Wait for the installation to complete, then click "Finish".
9. The setup wizard should launch in your browser at http://localhost:8080/setup/. If it doesn’t, navigate to this URL manually.

Innoslate Setup

Reminder: Proceed only if you are initiating a brand-new Innoslate environment. If you intend to use an existing environment and already possess a pre-configured settings.properties file from a previous installation, you may skip the following steps. For guidance on existing environments, refer to Streamlining Innoslate Setup from an Existing Enterprise Environment for comprehensive instructions.

1. Click “Begin Setup”.
2. Accept the Innoslate End-User License Agreement and click “Next”.
3. Select the appropriate Platform Type for your environment:
   
   • Local
   • Amazon Web Services
   • Microsoft Azure
   • Docker
   • Legacy (already have license)
4. After selecting the platform, an Innoslate License ID will appear. Copy this ID and provide it to your Account Manager to retrieve your license.
   
   • For more on the Innoslate License ID system, please visit: Innoslate License ID
5. Once you receive your license key, check “I have received a Global License Key”, paste or upload the key, and click “Validate”. Verify the license count and expiration date, then click “Next”.
6. Configure the database connection by entering the host location, port number, database name, and administrator credentials. 
   
   • Ensure the database is created prior to this step.
   • Use database administrator credentials for “Username” and “Password”.
   • If the database is on a separate machine, enter the appropriate IP address or machine name.
   • Default ports: PostgreSQL (5432), SQL Server (1433). Adjust if customized.
   • The database connection string will auto-populate based on input.
   • Use default Java Database Connection pool settings unless specific changes are needed.
7. Upon successful connection, a “Database Successfully Connected” prompt will appear. Click “Next”.
8. Choose an authentication method (Native, CAC, PKI, LDAP, SAML, OAUTH) and provide required details. You can select Native for now and configure other methods later with Support documentation. Click “Next”.
   For specific parameters required by each authentication type, please refer to their respective documentation below: 
   • OAUTH (preferred)
   • SAML
   • LDAP
   • LDAPS (select LDAP)
   • CAC & PKI - Contact Support
   • For full insight on all Authentications see our Authentication Overview.
9. Set up the Innoslate System Administrator (“Super Admin”) account. This account has full configuration access and does not consume a license if not added to an organization. Optionally, designate additional Organizational Admin or Support Users (by username). Click “Next” once all fields are validated.
10. Configure file system settings in your Operating System for blob objects and uploads (default: 100MB max file upload, 10,000,000 max entities in reports). Create a file for Innoslate to store these items. For AWS, consider using S3 for persistent files. Click “Next”.
11. Set up email notifications (optional). Enter Mail Security, Host, Port, Username, Password, and preferences, or skip and configure later. Click “Next”.
12. Select browser cache options. Click "Next".:
    • Native
    • Redis (enter URL, Port, and Password if applicable)
13. Configure AI Provider settings (Open AI, Ask Sage, Azure AI) for Chat AI and Image AI tools. Enter required fields (e.g., URL, API Key, Model, Org Key). Click “Next”.
    This flexibility is beneficial if you intend to establish a default AI tool across all organizations within your Innoslate environment. You may designate separate organizational sandboxes to utilize their preferred AI model from the available options—AskSage, Azure OpenAI, or OpenAI after installation.
    
    We highly suggest "AI Models and Platform Options" for further information on these AI models.
14. Review the settings.properties file, which summarizes all configurations. Use navigation buttons to make adjustments on the appropriate page if needed, then click “Next”.
    
15. Click “Apply Settings” to finalize the configuration.
16. Click “Finish”, then restart the Innoslate service using the Innoslate4 Windows service or by running  restart_innoslate_service.cmd in the C:\Innoslate4\utilities folder.

📖For a full glossary of all available parameters for the Innoslate Setup steps see Innoslate Enterprise Setup Glossary.

After Setup

1. Open your browser and access the login page at http://localhost:8080/ (or your configured URL) and log in as the Super Admin account created in Step 9 of the setup.
2. Set up Organizational Sandboxes (Organizations)

Notes:

• • An entity limit of zero (0) indicates unlimited entities.
  • Do not use the slug “socket” (reserved for internal use).

Troubleshooting

Innoslate Service Missing 

• Refresh the Windows Services list.
• If missing, navigate to C:\Innoslate4\utilities, run install_innoslate_service, then restart_innoslate_service.

Database Connection Failure:

• Verify the database service is running and the database is created.
• Check admin credentials for special characters (e.g., #, %, ^).
• Confirm the database name and port settings (PostgreSQL: 5432, SQL Server: 1433).
• Ensure Full Text Search is enabled using: 
  SELECT SERVERPROPERTY('IsFullTextInstalled') 
  (1 = enabled, 0 = not enabled; install via SQL Server Installation Center if needed).
• Check firewall settings for blocked ports.
• Java Issues: Run set_java_home_path in C:\Innoslate4\utilities to locate or install Java.

Browser Setup Interrupted:

• Run launch_localhost_setup in C:\Innoslate4\utilities to restart the setup process.

Innoslate Hangs/Won’t Start:

• Ensure the Innoslate4 service is running via Windows Services.

Configuration Notes

• For a glossary of all available parameters for the Innoslate Setup via the settings.properties file, see settings.properties Glossary.
• For further configuration, please see Apache Tomcat Configurations.
• The settings.properties file, located at C:\Innoslate4\apache-tomcat\webapps\innoslate4\WEB-INF, stores all configuration settings. For users with existing environments, you can bypass the Setup Wizard by copying a pre-configured settings.properties file to this location and restarting the Innoslate service. See Streamlining Innoslate Setup from an Existing Enterprise Environment for detailed instructions.