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:

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
      1. Embedded web server
      2. Java Application Server
  4. Configuration
    1. Configuration concepts
    2. Configuring the ikbViewer application
      1. ContentServerConfiguration
      2. PageEngineConfiguration
      3. SearchClientConfiguration
      4. CacheManagerConfiguration
      5. SecureTokenEngineConfiguration
      6. ActivitiProcessEngineConfiguration
      7. BpelProcessServicesConfiguration
    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. Import startup data
    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. Security roles
        1. ikbViewer
        2. ikbStudio
        3. ikbWebServices
        4. ikbBatch
        5. ikbActiviti
        6. ikbProcessServicesWS
        7. ikbInstant
        8. ikbWebdav
    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. 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 user repository (authentication)
      1. iKnowBase internal user repository
      2. Configuring authentication with Active Directory
      3. Configuring single sign-on using the SPNEGO protocol with Active Directory
        1. Prerequisites
        2. Configure Active Directory (Windows Server 2008 R2)
        3. Configure the quickstart web server
        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- and group roots
      4. Combined Active Directory and iknowbase
        1. Configuring conditional SPNEGO support
    6. Configure SSL
      1. Terminating SSL in an external proxy
    7. Advanced topics
      1. Specify session cookie domain
    8. Troubleshooting
      1. iKnowBase applications can become partially unavailable if temp files are cleaned during runtime
  12. Installing on Oracle WebLogic Server
    1. Installation and configuration of WebLogic
    2. Create and deploy data source
    3. Configure a user repository (realm)
    4. Deploy applications
      1. Clusters and session replication
    5. 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
    6. Configure SSL
      1. Terminating SSL in the application server
      2. Terminating SSL in an external proxy
  13. 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 security providers (authentication)
      1. File-based security
      2. LDAP-based security
      3. Single sign-on with Windows Active Directory
    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. iKnowBase does not detect HTTPS (secure) mode on GlassFish 4 behind an SSL terminating reverse proxy
      4. Session replication does not work in GlassFish 4