iKnowBase Installation Guide

Welcome to the iKnowBase Installation Guide. Note that this installation guide only covers upgrades from iKnowBase 5.7.2 and newer. If you are upgrading from an older version, you must first upgrade to iKnowBase 5.7.2 using the old upgrade instructions, and then use these upgrade instructions to upgrade to the latest version.

Introduction

This book is conceptually structure into three parts:

• Part one (comprised of the chapters Installation toplogies, Installation overview, Upgrade overview and Configuration overview) gives an overview of the installation. For experience users, the installation and upgrade overview chapters will also contain most of the required information.

• Part two (comprised of a chapter for the Database repository, one chapter for each of some of the java applications and one chapter for the Solr search server) gives a more detailed understanding of what the installation of these components actually include.

• Part three (comprised of one chapter for each supported servlet- or application server) contains detailed information about installations on that particular platform.

Table of contents

1. iKnowBase Installation Guide
   1. Introduction
   2. Table of contents
2. Installation topologies
   1. iKnowBase components
   2. Sample topologies
      1. iKnowBase Quickstart
      2. Oracle WebLogic Server 12c (simple scenario)
   3. Supported infrastructure
3. Quick installation and upgrade overview
   1. Download and install the iKnowBase software
      1. Directory structure
      2. Download and install the software
      3. Configure the repository-specific property file
   2. Install or upgrade the database repository
   3. Install and run web applications
4. Configuration
   1. Configuration concepts
      1. Property sources
      2. The ikb_installation_properties database table
   2. Configuring the ikbViewer application
      1. ContentServerConfiguration
      2. PageEngineConfiguration
      3. SearchClientConfiguration
      4. CacheManagerConfiguration
      5. SecureTokenEngineConfiguration
      6. ActivitiProcessEngineConfiguration
      7. BpelProcessServicesConfiguration
      8. SpringSecurityConfiguration
         1. Debug
         2. Default authentication module
         3. Authentication modules
            1. Basic module configuration
            2. Container module configuration
            3. Form module configuration
            4. FormAuto module configuration
            5. Header module configuration
            6. Spnego module configuration
            7. LDAP UsernamePassword authentication provider
            8. iKnowBase UsernamePassword authentication provider
            9. Social authentication provider
         4. Secure Token authentication
         5. Anonymous / Public authentication provider
         6. iKnowBase User Details
         7. Switch User
         8. User Account Activation
         9. IKB Auth Token
   3. Configuring the ikbBatch application
      1. FileConverterConfiguration
      2. BatchPageEngineConfiguration
      3. ContentIndexerConfiguration
      4. EmailReaderConfiguration
   4. Configuring the ikbStudio application
   5. Configuring the ikbWebdav application
      1. FtpServiceConfiguration
   6. Configuring the ikbWebServices application
      1. WebServicesConfiguration
      2. WebServicesSecurityConfiguration
   7. Configuring the ikbInstant application
      1. InstantServerConfiguration
      2. InstantQueueServerConfiguration
   8. Sample script
5. Database repository
   1. Fresh install
      1. Prepare the database schema
      2. Custom step for Oracle 12c database with Pluggable databases (PDB)
      3. Import startup data based on a export file
      4. Import startup data based on database link
   2. Upgrade
      1. Export existing scripts
      2. Prepare the database schema
      3. Upgrade schema and install latest code
      4. Recompile invalid packages
   3. De-installation
   4. Advanced topics
      1. Duplicate an existing installation
      2. Running iKnowBase in a Oracle Enterprise Edition database
      3. Configuring the Activiti BPM Engine tables
6. Java applications
   1. Fresh install
      1. Before you start
         1. Cluster support
      2. Create data source
      3. Deploy the applications
      4. Application security
   2. Advanced topics
      1. Deploy with "/ikbViewer" prefix
         1. Background
         2. Update domain definition to match new endpoint
7. Batch Server
   1. Installation
   2. The EmailReader
      1. Enable or disable the EmailReader
   3. The FileConverter
      1. Understanding the FileConverter
      2. Installing Outside In technology
      3. Configuring the FileConverter
      4. Testing and troubleshooting
         1. Running tests
         2. Missing libraries
         3. Missing fonts
8. WebDav Server
   1. Installation
   2. The WebDav Server
      1. Enable or disable the WebDav Server
      2. Configuring the WebDav Server for dimension based WebDav folders
   3. Client configuration
      1. Enabling Basic authentication
      2. Editing an iKnowBase document from Microsoft Office
      3. Mounting WebDAV folders in Windows
   4. Troubleshooting
9. Apache Solr Search Server
   1. Installation
   2. Starting and stopping
   3. Configuration
      1. Security-plugin
      2. SolrCloud
      3. Master-Slave setup
      4. Configure the iKnowBase applications
10. Instant Server
    1. Installation
       1. Special requirements
    2. The Instant Server
       1. Enable or disable the Instant Server
       2. Configuring the Instant Server
       3. Testing and troubleshooting
11. Web Application Security
    1. Quick install
    2. Overview
    3. Configuration
    4. Authentication
       1. Default authentication module
          1. Instant and WebDav
       2. Force a specific authentication mechanism
       3. Available authentication modules
          1. Username and password capable Providers
          2. Social capable Providers
          3. Trusted HTTP request header as authentication
          4. iKnowBase Auth Token
             1. iKnowBase Auth Token: LOGIN
             2. iKnowBase Auth Token: ACTIVATION
          5. Authentication token processing
    5. Authorization
       1. Administrator
       2. Development toolkit
       3. iKnowBase 6.5 and earlier versions
    6. Switch user
       1. Switch user access check procedure
       2. Switch user audit procedure
       3. Switch user database object ot_switch_user
       4. Trigger switch user
    7. Logout
    8. Custom security implementation
    9. Examples
       1. Set password for users in iKnowBase User Repository
       2. Form based authentication against iKnowBase User Repository
       3. Custom login form
       4. Basic authentication against iKnowBase User Repository
       5. Username and password authentication against LDAP User Repository
       6. Authentication against LDAP User Repository with mapping for the iKnowBase username
       7. Windows single sign on
          1. Prerequisites
          2. Configure Active Directory (Windows Server 2008 R2)
          3. Configure Web Application Security (SPNEGO and LDAP)
          4. Configure Active Directory for end users
          5. Configure user synchronization for Active Directory users
          6. Using an alternative username
          7. Configuring multiple and separate user dn patterns
          8. Combined Windows single sign on and iKnowBase User Repository
          9. Conditional SPNEGO support
          10. SPNEGO fallback
       8. Explicit authentication trigger with redirect
       9. Integrating with Oracle SSO 10g
          1. Guarantee integrity of HTTP server Osso-User-Dn
          2. Rely on Oracle HTTP Server OSSO plugin
          3. Configure the iKnowBase Header authentication module
       10. Switch user database procedures
           1. Package spec
           2. Package body
       11. Enable Social authentication with user activation link
    10. Troubleshooting
        1. I only want to change the configuration for a specific web application
        2. I am being logged out from ikbViewer while active in ikbStudio (or vice versa)
        3. 'AES-256-bit is not supported', 'java.security.InvalidKeyException: Illegal key size' or 'Unable to initialize due to invalid secret key'
        4. Error creating bean with name 'aesBytesEncryptor'
12. iKnowBase Quickstart embedded web server
    1. Preparations
    2. Configure the quickstart instance
    3. Run and test the quickstart instance
    4. Deploy the applications
       1. Default deployment
       2. Specify applications to deploy
       3. Add custom applications
       4. Customizing the url mount point
       5. Defining virtual hosts
    5. Configure Web Application Security
    6. Configure SSL
       1. Terminating SSL in an external proxy
       2. Configuring SSL listener in iKnowBase Quickstart
    7. Advanced topics
       1. Specify session cookie domain
       2. Specify work directory
       3. Specify logs directory
       4. Setting max form size
    8. Troubleshooting
       1. Database connections through firewall or on an unreliable network
       2. Unexpected error occurred: java.lang.IllegalStateException: Form too large
13. Installing on Oracle WebLogic Server
    1. Installation and configuration of WebLogic
    2. JDBC drivers
       1. For Oracle Database 11g and higher
    3. Create and deploy data source
    4. Configure a user repository (realm)
    5. Deploy applications
       1. Clusters and session replication
    6. Configure user realms (authentication)
       1. Using Oracle Internet Directory for authentication
       2. Using the iKnowBase user repository for authentication
          1. Overview
          2. Installation
          3. Troubleshooting
    7. Configure SSL
       1. Terminating SSL in the application server
       2. Terminating SSL in an external proxy
    8. Troubleshooting
       1. Database connections through firewall or on an unreliable network
14. Installing on GlassFish Server
    1. Installation and configuration of GlassFish itself.
    2. Configuring a database data source
    3. Configuring cluster single-sign-on-state
    4. Configuring the HTTP listener for ikbInstant
    5. Deploy the applications
    6. Deploy the /ressurs-directory
    7. Configure Web Application Security
    8. Configure SSL
       1. Terminating SSL in the application server
       2. Terminating SSL in an external proxy
    9. Troubleshooting
       1. Using custom passwords on java keystores
       2. GlassFish server.log: AS-NAMING-00006 and RAR8067
       3. GlassFish server.log: log4j called after unloading and Class invariant violation
       4. Database connections through firewall or on an unreliable network