On-Premises

The OID application stack is a Node.js application that can be deployed on-premises. This document provides guidance on how to deploy OID on-premises.

warning

This installation method is NOT RECOMMENDED for production environments, as it requires manual setup and maintenance. This method is suitable for development and exploring the architecture of the app.

Prerequisites

• Node.js >= 20.x
• PNPM >= 9.x

Installation

To deploy OID on-premises, you need access to the source code. Download the source code from the OID GitHub repository.

Once you have the source code, follow these steps to deploy OID on-premises:

1. Install the required dependencies:

   pnpm install

2. Create a .env file in the root of the project with the application configuration values. Use the .env.example file as a template and update the values accordingly:

   cp .env.example .env
   info

   Alternatively, you can set the environment variables directly in your environment before starting the OID server.

3. Start the OID server:

   pnpm start

4. Access the OID server at http://localhost:3001.

Configuration

OID can be configured using environment variables. The following environment variables are available:

Variable Name	Description	Default Value
NODE_ENV	The environment in which the OID server is running.	development
HTTP_HOST	The host on which the OID server is running.	localhost
HTTP_PORT	The port on which the OID server is running.	3001