Deployment

Overview

The io.Manager can be deployed on-premise and can run inside your organization network.

The deployment consists of the following:

  • io.Manager Server - a NodeJS app, the actual server;
  • io.Manager Admin UI - a React app that allows managing the data stored in io.Manager;
  • MongoDB database;

The server is provided as a set of NPM packages exposing the io.Manager Server and the io.Manager Admin UI as modules. The modules provide extension points for different customizations like authentication and storage.

The NPM packages exposing the io.Manager Server and Admin UI are hosted in a private NPM repository. To obtain access, contact us.

⚠️ Note that it's recommended to use the template repository approach, although you can also use the NPM packages directly and build your own deployment.

Using the Template Repository

The template repository is a template for building and deploying io.Manager to your own infrastructure. It provides a Docker Compose configuration for local development and testing, as well as Kubernetes configurations for deployment to a production environment. This is the recommended approach for deploying io.Manager.

Follow the instructions in the README.md file to build and deploy io.Manager.

Using the NPM Packages

⚠️ *Note that it's possible to use the NPM packages exposing the io.Manager Server and Admin UI directly, but it's recommended to use the template repository approach for deploying io.Manager.

Access

The NPM packages exposing io.Manager and the Admin UI are hosted in a private NPM repository. To obtain access, contact us.

Environment Setup

Generate an .npmrc file that will contain the authentication information for connecting to the private NPM repository. Make sure to exclude this file from your source control system.

To generate an .npmrc file:

  • Login to JFROG.
  • Expand the menu in top right.
  • Click "Setup".
  • Select "NPM".
  • From the dropdown menu select _default-npm-virtual_.
  • Copy the snippet.
  • Create an .npmrc file with the copied contents.

MongoDB

The io.Manager uses MongoDB as a database. You must have a running MongoDB instance.

Now you can begin using the packages and start the server locally.

Examples

For an example of how to run io.Manager and the Admin UI using NPM packages and basic authentication, see the io.Manager Basic Authentication example on GitHub. Follow the instructions in the README file to start io.Manager and the Admin UI.