Version 24

    Once you've installed the Jive Node SDK and created a Jive project with it (such as an app, a tile, a cartridge, an external storage framework), you can deploy it by bundling and installing an add-on containing your project. This add-on is automatically created by the Node SDK at runtime.


    NOTE: For instructions on installing an add-on without the Jive Node SDK, refer to Installing and Updating an Add-on into Your Community.


    To install and deploy your service using the Jive Node SDK:


    1. Update the client configuration file. Before starting your Node server, update the jiveclientconfiguration.json file (which resides in the root directory of your project) to reflect the URL and port of the Node.js server that will serve your Node SDK project. This information is given to the Jive server so that it can access the app server — both at registration time, and when a user accesses your content. By default, it is set to localhost, port 8090:


          "clientUrl" : "http://localhost",

          "port" : "8090"


      These default settings are appropriate if you are running your Node.js server and your Jive server on the same system. For complete information about how to configure your project, refer to jiveclientconfiguration.json - Definition.
    2. If applicable, start your service. This can be performed by executing app.js with Node.js using the following command:

      node app.js

      A few additional details to consider:
      • When creating a Jive-hosted app or an internal custom view tile, you do not need to start a standalone service. Otherwise, you typically do want to start the node service.
      • If you would like to run the node process in the background, you can use standard Unix syntax to do this, such as  node app.js &  and then press <ENTER> one more time to re-access the console. Subsequently, to stop the process, you can simply type killall node .
    3. If applicable, create the add-on package. When the service starts, it automatically creates an add-on package (named using configuration information specified in your project. This will be used to install the add-on. However, if you are not running a Node service, you can create an add-on package without starting a service using the following command:

      jive-sdk build add-on

      A few additional details to consider:
      • If you are building an add-on for a Jive-hosted app or an internal custom view tile, you need to specify that Jive will be hosting your assets. To do this, use the following command instead:

        jive-sdk build add-on --apphosting="jive"

      • When developing in a cloud environment (such as Nitrous.IO), be sure to download the file from the dev environment so that you can upload it to the Jive server.
    4. Log in to your Jive environment. You will need to be a community manager or have the ability to install add-ons for personal use on this Jive server. We suggest you use the Jive Developer Sandbox for testing.
    5. Upload the add-on package.
      1. Select "Add-ons" from the Manage area of your account settings.
      2. Click Upload Package.
      3. Click Choose File.
        Select the file located within the root directory where you created your Node SDK project.
      4. Once you've selected the file, click Continue.


    To better understand the communication that occurs between your service and the Jive server during add-on registration, refer to the Add-on Creation and Registration Sequence document.


    To test the service that you've installed, refer to the documentation for the particular service you created.