Installation

This section contains various articles on the installation, system requirements, and supported environments of App Studio.

Appkit is most commonly run as a lightweight Java web application that can be deployed in any Java Servlet Container (application server) such as Tomcat, Glassfish, Jetty depending on your preferences or IT standards. The Appkit application is designed to be stateless, making deployment and scaling (for example, with load balancers a straightforward exercise.

Requirements

App Studio is a standalone application with the following requirements:

Installation

  1. Download App Studio Enterprise.

  2. Copy the App Studio Enterprise zip file to any convenient path.

  3. Unzip the file, and follow the instructions provided in the README.md file.

App Studio Wizard is included when deploying Fusion Server.

include::/app-studio/concepts/app-studio-enterprise/index.asciidoc

Configuring the application server

For development and testing purposes you can deploy the Appkit web application in any modern servlet container and it will run and serve queries as long as the computer has network access to the underlying search engine. This is a non-exhaustive list of servers that have been used to run Appkit applications:

  • Tomcat 6+

  • JBoss 8+

  • Jetty 6+

  • GlassFish 4+

Java runtime environment

Appkit requires Java JDK 8 to be installed on the application server. Java EE is not needed.

Memory allocation

You must make sure that the servlet container is configured with access to an adequate amount of memory and heap space. The standard Appkit application does not have specific requirements but specific modules (for example, the Social Module have a larger footprint. See the Troubleshooting page for more information.

Typical production setup

Your production setup will be a matter of preference because Appkit imposes no specific requirements in terms of topology or infrastructure. Some organisations choose to front the application server (servlet container) with either Apache or another webserver. In a public-facing scenario, this can yield some gains when serving static content and creates a buffer between the outside world and the execution environment.

Using Windows Integrated Authentication for internal applications

If you would like to take advantage of Integrated Windows Authentication for single sign on in your search application, the typical pattern is to front the servlet container (for example, Tomcat) with Microsoft Internet Information Services. In this pattern IIS handles the authentication with Active Directory and then forwards the request to Tomcat where it is picked up by Appkit and used by our Security Module for user information, authorisation or personalisation.