InnoKB v2.x User's Manual


  1. Installing InnoKB Server

    By default, InnoKB server will copy all its files into the '[install-dir]' directory, all newly created databases will be located in the '[install-dir]/repository/' sub directory, and access logs will go into the '[install-dir]/logs/' sub directory. You might change these default settings by editing the '[install-dir]/innokb_config.xml' config file with a UTF-8 compatible plain text editor.

    InnoKB includes an initial privilege file '[install-dir]/innokb_grant.xml' which initializes the server with a few pre-defined user/group accounts and relevant privileges. You do never need to manually edit this file, just login to the administrator interface whereby you can change the settings via the web interface.

    • For Windows

      Installing InnoKB on Windows is easy, just run the setup program downloaded from our website and follow the instructions, InnoKB server will be installed appropriately. Note that you'll need to login to Windows with your administrator account and run the setup program as administrator, so the setup program has the privileges registering InnoKB as an NT Service.

      By default, InnoKB will be registered as an 'Automatic' service within the Windows Service Control Manager, that means InnoKB Server will start at computer startup. This way, you don't need to login to the server computer and manually start it up every time. Although, if you don't want it to start automatically at computer startup, you might change its startup type to 'Manual' within the Windows Service Control Manager. For detailed instructions on this operation, please refer to Windows Administrators Reference.

    • For Linux/FreeBSD

      To install InnoKB on Unix servers (e.g. Linux/FreeBSD/Solaris), simply extract the downloaded .tgz pack into a directory ( e.g. /usr/local/innokb/ ). Before starting it up, you might need to set the file attributes appropriately, like this,

      # cd /usr/local/innokb
      # chmod +x *.so
      # chmod +x innokb_linux_i386

      InnoKB server's main executable file (something like innokb_linux, innokb_freebsd) can be put into the 'rc.local' file on Unix for InnoKB to automatically start at computer startup. Note that if you do this, you'll need to use a few command arguments for the server to run as a Daemon in background instead of on Console (See below.)

      InnoKB doesn't automatically install itself as a service (daemon) on Unix at this time, you might want to write a shell script for this purpose if necessary.

      To enable InnoKB server to handle non-ANSI characters, please be sure to set the system locale appropriately. For example, on Linux for InnoKB to handle Chinese characters, you might set system locale like this,

      # export LC_ALL=zh_CN.gb2312
      # export LANG=zh_CN.gb2312

  2. Uninstalling InnoKB Server

    Before uninstalling InnoKB Server, you'd want to first make backups for your own databases under the database repository directory.

    • For Windows

      Open Control Panel, double-click the 'Add/Remove Programs' icon, select the 'InnoKB Server' item, and then press the 'Add/Remove' button, and 'Yes' to uninstall it.

    • For Linux/FreeBSD

      Simply remove the InnoKB server's directory, and clear relevant shell scripts if any.

  3. Getting Started

    After installing InnoKB Server properly, you can follow the instructions below to run InnoKB and build up your own databases.

    1. Startup InnoKB Server

      • For Windows, right-click on the 'Start -> Programs -> InnoKB Server -> Start InnoKB Server' menu item, and select the 'Run as administrator' menu item to start it. If you had InnoKB Server installed as an Auto-startup service, InnoKB Server will run at computer startup.

      • For Unix, run the command line like this:

        # /usr/local/innokb/innokb_linux_i386 -daemon -silent -port 8083

        where the '-daemon' arguement indicates InnoKB server to run as daemon in background, instead of on console.

        In order to have InnoKB Server automatically start at computer startup, just write the command line into the /etc/rc.local file.

    2. Stop InnoKB Server

      • For Windows, right-click the 'Start -> Programs -> InnoKB Server -> Stop InnoKB Server' menu item, and select the 'Run as administrator' menu item to stop it.

      • For Unix, run the command line like this:

        # killall innokb_linux_i386

    3. Login to InnoKB Server

      Once InnoKB server successfully starts up, you can login via the following URLs with a modern web browser. By default, InnoKB server listens on TCP/8083.

      • http://<hostname>:8083/admin (for the administrator interface)
      • http://<hostname>:8083/edit (for the editor interface)
      • http://<hostname>:8083/view (for the viewer interface)

      where the '<hostname>' is your host name or ip address. If you connect to InnoKB server from on the server computer itself, it can be 'localhost', like this,

      At the first time you login, you may use the default 'root' account and leave the password blank to login to the server. For security considerations, we suggest that you immediately set a password for the 'root' account once you're logged into InnoKB Server.

    4. Login as administrators for database setup

      Before building up your own knowledge base, you'd need to first login as adminstrator and configurate the server settings, such as user/group accounts, access privileges and relevant settings.

      To login to InnoKB Server as administrators, please launch a web browser, and load the URL to the administrator interface, like this,

      http://localhost:8083/admin

      then the Login page appears, whereby you can login with the default 'root' account, no password is required at the stage of the server setup. After you're logged in, we suggest that you immediately set a password for the 'root' account. To do so, click the 'Users' sub tab within the administrator control panel, you'll find the 'root' account on the list, whereby you can press the 'Initialize' link on the 'Login password' column, and set a password for the 'root' account.

    5. Creating new databases

      InnoKB server installs a sample database for demonstrating the usage of the application. You'll need to create your own databases to build up a knowledge base. To create a new database, please first click the 'Databases' sub tab within the administrator interface, then press 'New database entry' button below the database list, you'll need to supply a new database ID and a title. Creating a new database indicates InnoKB server to make a sub directory under the pre-defined repository directory on the server computer, and the new directory is named with the supplied database ID. The database ID must comply with the file name specifications of the server platform.

    6. Adding new user/group accounts

      InnoKB server installs a few essential user/group accounts by default. You might want to add more user/group accounts for viewers, editors or other visitors. To create a user account, please click the 'Users' sub tab, then press the 'New user account' button below the user list. You'll need to supply a new user ID and description text to create the new account. To create a group account, click the 'Groups' sub tab, and press the 'New group account' button, you'll need to supply a new group ID and description text.

      InnoKB server does not directly grant privileges to individual user accounts, but only to group accounts, so you'll need to set owner groups for each user accounts to obtain the corresponding group privileges. To set owner groups for an user account, please click the 'Change' link on the 'Owner groups' column of the user accounts table, then select the owner groups on the popup window.

    7. Granting access privileges on databases to groups

      Now that the databases and user/groups accounts are created, you'd want to grant access privileges on the databases to individual groups. In order to grant privileges on databases, you'll need to first create a new privilege entry, then you can select databases and privileges to grant with the new privilege entry. To create a new privilege entry, press the 'New privilege entry' button below the privileges list, then select the target group account which the privilege entry applies to. Once the privilege entry is created, it will be listed out in the table, whereby you can press the 'Change' link to specify the databases and access privileges that are being granted to the group account. You can also add comments on each privilege entries by pressing the 'Edit' link on the 'Description' column.

      In the access privilege list window, InnoKB provides the 'viewer' and 'editor' privilege schemes, you can press the [Viewer] or [Editor] button to select it. Although, you'll need to double check if they exactly match your purposes.

    8. Enabling anonymous access

      InnoKB server requires a normal user account with viewing-specific privileges to enable the anonymous access option. Before it is enabled, please be sure to first create a user account and grant the viewing-specific privileges to it. By default, InnoKB servers installs the 'anonymous' user account which belongs to the default 'viewer' group and could be suit for this purpose if you didn't change the user/group account.

      To enable the anonymous access, please click the 'Anonymous Access' sub tab, then press the button under the tab, then you can select a specific user account on the popup window for anonymous access.

      Note that once the anonymous access option is enabled, your databases would be accessible by random visitors. So you'd want to grant a minimal access privileges to the anonymous account for security considerations.

    9. Login as editors(viewers) for editing/viewing

      In order to edit/view a database, you'd need to login into the server as editor/viewer.

      To login to InnoKB Server as editor/viewer, please launch a web browser, and load the URL to the editor/viewer interface, like this,

      http://localhost:8083/edit

      http://localhost:8083/view

      then the Login page appears, whereby you can login with your account ID and password.

    10. Adding new info items

      An 'Info item' is the essential entity for InnoKB to store your information in a database. Every info item has a unique ID (digital number) assigned by InnoKB server when it's created. Each info item accepts a webpage as default content that is shown under the 'Item Content' tab, and a collection of files stored as attachments.

      To create an info item, press the 'New item' tool button under the 'Info Items' tab, you'll need to supply a title text for the new item, and selectively assign a label for the new item. To label an info item during it's created, press the 'Labels' button on the 'New info item' window, then you can select an existing label, or add new labels if needed. Once a new info item is created, the results list will be updated in order for the new info item to be listed out immediately.

    11. Adding labels and sub labels

      InnoKB provides the labels and sub labels feature (namely Tags, Categories) which allows you to categorize info items in the tree structure. Each info item can be put into more than one labels (categories). You can run a query with labels, or combine labels into search criteria. The labels and sub labels are shown in the tree structure within the editor interface.

      Within the editor interface, you can add new labels to create a label tree precedingly, or add new labels if needed while creating info items. To create new labels, please press the 'New label' tool button, then, on the popup window, you can choose to add sibling or child labels.

    12. Running queries with labels

      Running queries with labels is simple, clicking on an label in the tree view automatically run the query, query results will be shown in the results list on the right side.

    13. Viewing and editing info items

      Within the find results list, clicking on an info item opens it in the next 'Item Content' sub tab, whereby you can view the HTML content and attachments of the info item. InnoKB provides an inbuilt HTML editor for content editing. In order to edit the item content, press the 'Edit' tool button under the 'Item Content' tab, the HTML content will go into the design mode, whereby you can enter your information and format the text in HTML.

      The inbuilt HTML editor provides a set of easy-to-use utilities for editing/formatting, such as font name, size, color, style, indentation, alignment and making hyperlinks, inserting images etc.

      During the editing, you can select 'Save now' menu item to save the content as a revision on the server, or press the 'OK' button to save and exit the design mode to view the content. If you'd want to cancel editing and discard changes, press the 'Cancel' tool button and confirm, the info item will revert to the last revision state.

    14. Edit HTML source code

      InnoKB allows experts to directly edit the item content in HTML source code. To do so, please select the 'Edit source' menu item in the design mode, then you can edit the HTML source in the popup window. In addition, you can choose to edit the source in a third-party professional HTML editor and then copy/paste the HTML source back to here.

    15. Editing item title or copy from within selected text

      The info item title can be modified at any time by typing a new title text in. If you'd want to title an info item with a portion of text in the HTML content, please first highlight the text, then select the 'Title with selection' menu item.

    16. Uploading files as attachments

      Each info items accept a collection of files as attachments. To upload files as attachments, please press the 'Attach' tool button on the right side bar of the item content, then select files from within the local file system to upload.

      Note that InnoKB server will attempt to index the files when they're uploaded, so it may take a while for this process to complete.

    17. Inserting images into HTML content

      To insert an image into an info item's HTML content, please first go into the design mode, then click the 'Insert Image' tool button, and supply a URL to the target image. If the target image is a web resource and you'd like to link with the original resource, just use the image URL. If you'd like to use an image on the local file system, you'll need to first upload the image files as attachments, then you can select the image and link to the content.

    18. To make a hyperlink in the HTML content, please first go into the design mode, then highlight a portion of text, and click the 'Make hyperlink' tool button, then supply the link to the target resource. On the popup window, you can select an attachment or an info item to link. If you'd like to link to other info items that are not listed, please first select the items into the results list by running a query.

    19. Revisions management

      Every time an info item's content is saved or a file is uploaded, a revision is automatically created in the resivion history. To view revision history of an info item, please select the 'Revision history' menu item under the 'Item content' tab. For attachments, press the 'Revision' button in the attachment list.

      Note that, on the revision list window, you can select revisions to delete forever, or roll back the info item to an old revision by set an old revision as the current one.

    20. Labeling and unlabeling info items

      To label info items from within the query results list, please check the info items, then select the 'Apply label' menu item, on the popup window, you can select an existing label for the info items, or create new labels and then select one.

      To label the currently opening info item, press the 'Label' button on the right side bar under the 'Item Content' tab, then select an existing label or create new labels and select one.

      To remove labels from on a collection of info items, first check them in the results list, then select the 'Remove label' menu item, on the popup window, you can check the labels to remove.

      To remove labels from on the currently opening info item, select the labels on the right side bar under the 'Item content' tab, then select the 'Remove' menu item and confirm.

    21. The editor interface provides a quick search box on the top of the main frame, so you can type a text to find and then press the 'Search' button, find results will be listed under the 'Info Items' tab.

      If you'd like to restrict the find results with additional criteria, please click the 'Search' tab on the left pane in the main frame, whereby you can run queries with creator, revisor, labels and database range in addition to the text to find.

    22. Sorting options

      By default, find results are sorted by date modified and in the decreasing order, so the recently modified items are listed on the first page. If you'd like to customize the sort options, you may use the 'Sort options' popup menu, or simply click the table headers. Clicking on a table header select the field to sort the results by, clicking again reverses the sequence between increasing and decreasing.

    23. Customizing columns shown on the results list

      By default, only a few columns are displayed on the result list. You have the convenience of turning on/off the customizable columns by using the 'Columns' popup menu.

    24. Customize the page size of the results list

      By default, the results list only display 20 items per page. If you'd like to customize the page size, please select the 'Custom page size' menu item.

    25. Select language for the web interface

      To select a language for the web interface, please click the 'Language' link on the top right corner in the main frame. Note that before you can select a language for the web interface, the corresponding language packs must be first installed with InnoKB server. Please consult the system administrators for more info about the installed language packs.

    26. Saving the preferences in user profile

      Each users can create a profile for saving settings data on the server. This way, you can restore the last settings whenever and wherever you login with the user account. The preference data include the pane size, custom columns of results, language settings and etc. To save the preference data, please select the 'Save preference' menu item.

  4. FAQs

    1. What is the initial login ID and password at the first time using InnoKB?

      At the first time you login to InnoKB server, please fill out the login form with the initial login ID 'root' and leave the password box blank.

    2. How to estimate the quantity of licenses required for InnoKB Server?

      InnoKB Server licenses are related to how many concurrent users are logged in at a time. Within InnoKB Server, you can add as many user/group accounts as you need, only the concurrent users who are logged in to the server at a time require their own licenses. For example, if you have added 20 user accounts into the database server, but only 5 users at most need to access the database server at a time, you'll need the 5-user license for the 5 concurrent users.

    3. What to do when web sessions timed out?

      By default, a web session will time out if it is left in idle for 30 minutes. That's to say, if you take no actions requesting InnoKB server within 30 minutes, your current web session will timeout.

      If the current web session timed out, you might re-login with your password and continue using it without reloading the interface. All the user interfaces (viewer, editor and administrator) have included the 'Re-login' button on the right top corner of their main frames.

      Note that If you've been in the design mode editing HTML content for 30 minutes or more, without any requests to the database server, your current web session may timeout, and you may lose the lock on the item's content, so posting changes to the server will fail. If in this case, you might re-login and lock the item content again, and then re-submit the changes to the item content. In case of any accidental data loss in this case, we suggest that you try to make a backup for the modified content or even save it in a local file on the hard disk, and then try back again when it's recovered from the issues.

    4. How to open the web interfaces of InnoKB Server?

      To open the InnoKB web interfaces, please load the following URLs within a web browser;

      • http://[hostname]:[portnum]/edit
      • http://[hostname]:[portnum]/admin
      • http://[hostname]:[portnum]/view

      where the [hostname] is the server's IP address or host name you specified. To determine the server's IP address or hostname, please consult the network administrators, or figure it out by running a command line on the server computer, like this: "ipconfig /all" for Windows, "ifconfig" for Unix.

      If you load the web interfaces on the local server computer where InnoKB Server is installed, the [hostname] can be either 'localhost' or '127.0.0.1', while the [portnum] is 8083 by default.

    5. What type of files does InnoKB attempt to index and search?

      On Windows, InnoKB Server attempts to parse documents according to file extension names by utilizing Windows IFilters installed on the target system. The IFilters for MS-Office and HTML documents are integrated within Windows XP+; The IFilters for RTF/TEXT documents are integrated within myBase; For other types of documents (e.g. PDF) to be searchable, you'd need to install the corresponding IFilters provided by the manufactory. Once new IFilters are installed for some types of documents, you'd need to clear and rebuild the index data for the relevant documents to be indexed and searchable.

      However, on Linux/FreeBSD systems, there's currently no things like Windows IFilter available, InnoKB uses its own file filters to parse the specific documents (TXT/RTF/HTML).

  5. Howtos

    1. How to change the default TCP/8083 for InnoKB on Windows NT?

      By default, InnoKB Server listens on TCP/8083. On Unix systems, you have the convenience of running InnoKB server with any TCP port number via the command line, like this,

      # /usr/local/innokb/innokb_solaris_sparc -daemaon -quiet -port 8083

      where the '8083' can be replaced with any other TCP port number you see fit in your system.

      For Windows NT, InnoKB server is registered as an NT Service, and the service is controlled by Windows Service Control Manager, you don't have the chance to directly run its command line, so if you'd want to change the TCP port number, you'd need to re-register the InnoKB service with a different TCP port number, by following these steps,

      • Press the 'WIN+R' key or click 'Start -> Run' menu item;
      • Type in the 'CMD' command and press [Enter], this opens a Console window;
      • Change the currently working directory to the '[install-dir]' folder where the 'innokb_winnt.exe' resides;
      • Unregister the existing InnoKB Service by running this command: 'innokb_winnt.exe -unregister';
      • Re-register InnoKB service by running this command: 'innokb_winnt.exe -register -port 8083', where '8083' can be replaced with the TCP port number you want;
      • Close the Console window and restart InnoKB service by using the 'Start -> Programs -> InnoKB Server -> Start InnoKB service' menu.
    2. How to save/restore the UI settings (e.g. language, pane size etc)?

      In order to save/restore the UI settings, please click the 'Action -> Save preferences' menu item. Each user saves the UI settings in its own profile area, and the saved settings will be automatically restored at the next visit.

    3. How to customize the Date/Time formats?

      The data/time formats are locale specific and can be customized by editing the language file 'common.ini' which resides in the '/locale/[LANG]' sub directory.

    4. How to customize the repository directories?

      InnoKB Server stores all database files within the repository directories. The default database repository path is initially set to the '[install-dir]/repository' directory. You can customize the repository path by editing the 'innokb_config.xml' file at this line:

      <RepositoryPath>./repository/</RepositoryPath>

      You can replace the default one or add multiple direcotries like this:

      <RepositoryPath>D:\appdata\innokb\;./repository/</RepositoryPath>

      The semicolon (;) is used for delimiters between the paths. The first one is the place where new databases will be located.

      Note that, on Windows, the database repository directory must be accessible by the 'System' account, as InnoKB server runs as an NT service in background under the 'System' account by default.

    5. How to backup InnoKB databases?

      InnoKB stores all databases under the default '[install-dir]/repository' folder or your custom repository directory. To backup a database, periodically archive the database folder including all files by using a zip/tar utility (e.g. WinZip, WinRar or Unix tar). Note that before making backups for InnoKB databases, please be sure to first stop or pause InnoKB service, in case of any file access conflicts. To backup the server configurations, just create backups for both the 'innokb_config.xml' and 'innokb_grant.xml' files.

    6. How to move existing databases to another server computer?

      Simply copy the database folders including all files to the target './repository' folder on the target server computer, and then restart InnoKB service to load them. But a few suggestions;

      • Before copying a database, we suggest that you first shutdown the running InnoKB services in order for all using files to close normally.
      • Before copying a database, it's strongly recommended to pack the database folder as an archive (e.g. .zip or .rar), then copy and extract the archive into the target './repository' folder.
      • To configurate the target server with the same settings, please use the same 'innokb_config.xml' file.
      • To replicate users and privileges settings, please use the same 'innokb_grant.xml' file.
    7. .

      .

  6. Tips

    1. Integrating with existing websites

      To integrate InnoKB into an existing website, you might insert the InnoKB login form into a webpage as follows.

      <form action='http://hostname:8083/_sessionopen' method='post' enctype='application/x-www-form-urlencoded'>


      <div>Login ID:</div>
      <div><input type=text name=uid></div>
      <div>Password:</div>
      <div><input type=password name=pwd></div>
      <div><input type=submit value='Login'></div>
      <div><input type=hidden name=uri value='/view'></div>
      <div><input type=hidden name=cookie value=1></div>

      </form>

      where the 'hostname' is the host name or IP address you specified; The above form will let users login to the viewer interface. To login to other interfaces, change the value of the 'uri' field, for example, the '/admin' leads users to the administrative control panel, while the '/edit' for editors.

      If the 'anonymous access' option is enabled within InnoKB, random visitors may access to your knowledge base without having to login. If in this case, you can simply put the target URL on existing webpages, for example, you can paste the HTML code into your webpages as follows.

      <a href='http://<hostname>:8083/view'>View xxx Knowledgebase</a>

    2. Is there a way to easily type in <BR> instead of <P> when pressing the Enter key?

      Within the design mode, IE inserts a <P> into the text when pressing the [Enter] key. This could double the paragraph spacing. If you'd like a <BR> instead of a <P> for a single paragraph spacing, please try using the [Shift+Enter] combination key; Mozilla Firefox doesn't have this problem.

    3. Is there a way to import data from existing myBase .nyf databases?

      There's a data file converter [ Nyf2InnoKB ] available for converting myBase .nyf files into InnoKB databases. [ Download ]

      By using this converter, each .nyf database is converted into a repository that can be mounted as a separate database entry within InnoKB; If you'd like to merge the imported info items into one database, please try using the 'Copy' opertion within InnoKB editor interface.

    4. .

      .

  7. Notes

    1. User Interface Localization

      InnoKB 2.x reads localized messages from within the .INI files which are located in the the '/locale/[LANG]/' directory, where the '[LANG]' is the target language ID (e.g. en-US, zh-CN, zh-TW etc.). The default language files in English are installed in the '/locale/en-US' sub directory. If you'd like to translate them, please first copy all the files to a new directory named with your language ID, and then translate the copied files to your language. Once the language files are translated and properly installed into the '/locale/[LANG]' sub directory, it can be selected from within the web interface by clicking the 'Language' link on top of the main frame.

    2. Upgrading to v2.x from v1.x

      From v2.0 on, InnoKB Server uses 'labels' and 'sub labels' for informatioin organizing and categorizing, the tree structure in the old versions is not available any more within the new version 2.0, and you'd need to create a new structure by adding labels and sub lables for organizing the info items.

      CAUTION: InnoKB v2.x changed several attribute tags in the .XML database file Specs. Before upgrading to v2.x from v1.x, you'd need to first create backups for existing databases created within old versions. Once a database is modified with v2.x, the database will be converted into v2.x database formats which are not back-compatible with InnoKB 1.x any more, and there's no option available to downgrade the formats from 2.x to 1.x.

    3. Using Unicode, UTF-8 and ANSI CodePage

      If you'd never use any Non-ASCII content with InnoKB, you may ignore this note. Otherwise, in order for InnoKB Server to better manipulate multilingual text other than US-ASCII, please make sure that the appropriate language packs are installed properly on your system. Although, there're still a few notes using ANSI CodePage on different OS platforms;

      Within InnoKB, all text content are encoded in UTF-8, including item titles, Html content, filenames, labels etc., and all attachments are stored as they originally are without any conversions, and InnoKB Server will attempt to parse the attachments and index them for fast search.

      In fact, InnoKB Server accepts any files as attachments, that may be not encoded in Unicode but possibly in ANSI CodePage. If in this case, a translation from ANSI CodePage to Unicode is required for parsing, being indexed and searchable. So this is the real place where we will care for Character Set and text Encoding.

      Otherwise, you would never care for any Character Set or Encoding of the content you input within the editor's web interface, you can save, view, search all these text content without a problem on all the supported OS platforms. This is also true for any attachments that are encoded in UCS2-LE, UCS2-BE and UTF-8. That's to say, any Unicode based textual attachments will be indexed and searchable. The UCS2 encoded files require BOM in the file header, but not the UTF-8 encoded files, InnoKB Server attempts to detect them automatically.

      Anyway, if you'd have to upload any files as attachments that are encoded in ANSI CodePage, you'd need to set the system locale appropriately or set the 'LC_CTYPE' setting in the 'innokb_config.xml' config file. The results also depend on the target server OS platform. On Windows and GNU/Linux, InnoKB Server attempts to translate ANSI CodePage into Unicode by using the system locale or the application sepcific LC_CTYPE setting. However, on FreeBSD and Solaris, InnoKB Server doesn't translate any non-ACSII text into Unicode, as results, those non-ASCII text files may be not fully indexable or searchable. Well, it does not affect other operations, e.g. viewing, downloading, etc.

      In short, on Windows, please adjust the system CodePage settings appropriately via 'Control Panel -> Regional and Language Options -> Advanced -> Language for non-Unicode Programs'; On GNU/Linux, please adjust the locale settings or set the LC_CTYPE setting in 'innokb_config.xml'. This makes possiblities for InnoKB Server to parse and index text attachments encoded in the appropriate ANSI CodePage. But on FreeBSD and Solaris, all user input including file uploads are assumed Unicode encoding (either of UCS2-LE, UCS2-BE and UTF-8), other encoding based files must be first converted into Unicode before uploading to InnoKB Server, so that they can be indexed and searchable.

      Another place that may care for Charset and Encoding is the Console or log viewer. On Windows and Linux, it is somewhat easy to correct display for non-ASCII characters by properly setting the system locale. However, on FreeBSD and Solaris, all non-ASCII characters are ignored on Console output.

    4. .

      .

  8. Troubleshooting

    1. Win32::OperService Failed/ErrCode(1060): The specified service does not exist as an installed service.

      This error message indicates that InnoKB Server might have failed to install. On Windows 2000/XP/2003/Vista, InnoKB must be registered as an NT service, this operation requires to perform under administrative accounts. So we suggest that you first re-login as a Windows administrator and then reinstall InnoKB. Once InnoKB server is properly installed and started up, it is accessible under the 'user' accounts via web browsers.

    2. Error Code: -981 / ERR_MKDIR_FAILURE, Failure creating directory on server

      In order for InnoKB to create a new database on server computers, the repository directory must have the 'write' attribute. On Unix platform, you might use the 'chmod +w ' command to append the 'write' attribute to the InnoKB repository direcotry.

    3. InnoKB worked at localhost:8083, but can't get connected from on other computers.

      If connections to InnoKB server from other computers over network fails, it is most likely that the firewall installed on your server computer has banned the TCP/8083 port number. If in this case, we suggest that you try to enable TCP/8083 within your firewall, or use another TCP port number that is available and allowed on your system. For instructions on enabling a TCP port within firewall, please refer to the firewall user's guide.

    4. .

      .