Domino AppDev Pack

1.0.5

Domino Installation

The AppDev Pack kit contains addon components for the Domino server and components that you would use outside of the Domino server. This section describes the contents of the kit and the installation instructions for the components that are installed directly onto the Domino server.

About the AppDev Pack kit

The AppDev Pack 1.0.5 kit is a compressed tar file that contains the following files:

FileDescription
1001-proton-addin-0.7.0.tgzThe Linux binaries and scripts for Domino server V10.0.1FP5 or later.
1001-proton-addin-0.7.0.zipThe Windows binaries and scripts for Domino server V10.0.1FP5 or later.
1101-proton-addin-0.7.0.tgzThe Linux binaries and scripts for Domino server V11.0.1 or later.
1101-proton-addin-0.7.0.zipThe Windows binaries and scripts for Domino server V11.0.1 or later.
adpconfig.ntfThe Domino server template for configuring AppDev pack components.
domino-appdev-docs-site.tgzA copy of the AppDev Pack documentation for offline use.
domino-cfgtest-1.0.8.tgzA Node.js application that demonstrates features of the App Dev Pack.
domino-db-0.0.5-javadoc.jarThe documentation for the domino-db Java API.
domino-db-0.0.5.jarThe domino-db Java API that is required to work with Domino data from a Java application.
domino-domino-db-1.6.0.tgzThe domino-db Node.js API that is required to work with Domino data from Node.js application.
domino-iam-service-1.5.0.tgzThe Node.js application that provides Identity and Access Management (IAM) for the Domino server.
domino-node-iam-client-1.5.0.tgzThe Node.js module that provides the API to work with IAM from a Node.js application.
domino-richtext-0.2.0.tgzThe Node.js module that provides the API to work with Domino rich text from a Node.js application.
node-demo.nsfA Domino database that's referenced in the API documentation and contains sample documents.

Files ending with .tgz are GZIP compressed tar archives. Files ending in .zip are ZIP compressed archives. You need a suitable tool to extract the contents of these archives.

The AppDev Pack kit contains binaries and a database template that must be installed on a Domino server.

To start, copy the following files from the AppDev pack kit to your Domino server:

  • adpconfig.ntf
  • One of the following proton-addin binary archives:
    • 1001-proton-addin-0.7.0.tgz - If running Domino 10.0.1 on Linux
    • 1001-proton-addin-0.7.0.zip - If running Domino 10.0.1 on Windows
    • 1101-proton-addin-0.7.0.tgz - If running Domino 11.0.1 on Linux
    • 1101-proton-addin-0.7.0.zip - If running Domino 11.0.1 on Windows

Install the binaries

Using your selected proton-addin installation archive perform the following actions depending on your OS platform.

Before you begin: Shut down the Domino server.

Linux Installation

The <domino>-proton-addin-0.7.0.tgz installation archive for Linux contains the following files:

FileDescription
protonThe proton Domino server addin task.
libiamclient.soThe required shared library used by the proton addin task.
oauthcfgThe Domino OAUTH configuration tool.
liboauth-dsapi.soThe OAuth Domino Server plugin (DSAPI).
make_certs.shA sample script that you can use to create your own private SSL/TLS Certificate Authority and additional certificates for client/server use.
make_keyring.shA sample script for creating a Domino keyfile with a server certificate.

To install these files into your Domino server program directory complete the following steps using a terminal shell:

  1. Switch to the Domino binary directory

    • if Domino 11:

      $ cd /opt/hcl/domino/notes/latest/linux

    • if Domino 10:

      $ cd /opt/ibm/domino/notes/latest/linux

  2. Verify that libnotes.so exists in this directory

    $ ls -la libnotes.so

  3. Expand the <domino>-proton-addin-0.7.0.tgz archive

    The following command assumes that the proton-addin archive was copied to the /tmp directory on the Domino server. Adjust the path to the archive if necessary.

    Note: This command replaces the files of an existing AppDev pack installation.

    $ sudo tar -xvf /tmp/<domino>-proton-addin-0.7.0.tgz

  4. Verify installation of files and fixup file permissions and ownership

    $ sudo sh -v ./setup_proton.sh

Windows Installation

The <domino>-proton-addin-0.7.0.zip installation archive for Windows contains the following files:

FileDescription
proton.exeThe proton Domino server addin task.
iam-client.dllThe required shared library used by the proton addin task.
oauthcfg.exeThe Domino OAUTH configuration tool.
oauth-dsapi.soThe OAuth Domino Server plugin (DSAPI).
make_certs.cmdA sample script that you can use to create your own private SSL/TLS Certificate Authority and additional certificates for client/server use.
make_keyring.cmdA sample script for creating a Domino keyfile with a server certificate.

To install these files into your Domino server program directory complete the following steps using PowerShell:

  1. Switch to the Domino binary directory

    • if Domino 11:

      > cd 'c:\Program Files\HCL\Domino'

    • if Domino 10:

      > cd 'c:\Program Files\IBM\Domino'

  2. Verify that nnotes.dll exists in this directory

    > dir nnotes.dll

  3. Expand the <domino>-proton-addin-0.7.0.zip archive

    The following command assumes that the proton-addin archive was copied to the c:\temp directory on the Domino server. Adjust the path to the archive if necessary.

    Note: This command replaces the files of an existing AppDev pack installation.

    > expand-archive c:\temp\<domino>-proton-addin-0.7.0.zip -destinationpath . -force

Prepare the configuration database

The AppDev Pack requires that configuration settings be stored in the adpconfig.nsf database. You may replicate this database across multiple Domino servers in your domain. Each Domino server has its own settings document in the configuration database.

The AppDev Pack kit includes the file adpconfig.ntf which is the template for adpconfig.nsf.

The template is signed by Lotus Notes Template Development/Lotus Notes and has the long name AppDev Pack Configuration and short name stdADPConfig.

To prepare the configuration database, complete the following steps:

  1. Copy adpconfig.ntf from the AppDev Pack kit to your Domino server's data directory.

  2. Complete one of the following steps:

    • New installations:

      Use adpconfig.ntf to create a new database called adpconfig.nsf on the Domino server. Or, create a replica of adpconfig.nsf from another server in your Domino domain. If the other server runs an older version of AppDev Pack, run the following Domino command to upgrade the database to the new design:

      > load design -f adpconfig.nsf

    • Upgrades:

      Run the following Domino command to upgrade the adpconfig.nsf database to the new design:

      > load design -f adpconfig.nsf
← Administration OverviewConfiguration →