Docker

This guide explains how to run Nected locally using Docker Compose. It is intended for developers and teams looking to test the platform, build rules, or evaluate Nected features in a controlled, single-node environment.

Docker deployment is for doing quick POCs without the features like Load testing, stress testing and production-level usage.

Pre-requisites

Supported Operating Systems

• macOS (Intel/M-Series)

• Linux (Ubuntu 20.04+)

• Windows (with WSL2)

Required Tools

Tool	Version
Docker Engine	v25.x+
Docker Compose	v2.x+

Ports Availability

Ensure the following ports are available and not already in use:

Service	Port
UI (Konark)	3000
Backend (Nalanda)	8001
Backend (Vidhaan)	8002
Editor	3001

Note: Docker Compose automatically provisions PostgreSQL, Redis, and Elasticsearch containers. No manual configuration is required.

For Common prerequisites, refer to this page: Common Requirements

Installation Steps:

The following steps will run a local instance of the Nected Platform using the default configuration file (docker-compose.yml):

1. Open your terminal (on Linux/Mac) or Command Prompt/PowerShell (on Windows).

2. Clone the Nected repository using Git:

   git clone <https://github.com/nected/docker-compose.git>

3. Change the directory into the root of the project:

   cd  docker-compose

4. Start the Docker containers using Docker Compose:

   docker-compose up

Access the local dashboard:

1. Open the browser and access http://localhost:3000

2. Use credential [email protected] / devPass123 to sign in to the local dashboard.

3. Once you've created an account, you can either start with the free plan or activate your instance with a license key.

<aside> 💡

IMPORTANT: While accessing rule and workflow API from other services, replace http://10.10.0.1:8002/ with http://localhost:8002/

</aside>

Email Configuration

To enable email in your local setup please refer to the following. Change should be made in nectedconfig/nalanda.env

Configure Email Service: Set up an email service to enable Nected to send notifications and alerts. Learn more about configuring email services.

Notes

• Do not use these defaults in production.

• These values are suitable only for local setups and quick evaluations.

• For staging or production-grade environments, refer to the Kubernetes.

Once updated, restart the containers to apply changes:

docker-compose down && docker-compose up -d

This ensures that your environment variables are loaded and used correctly by all dependent services.

Troubleshooting:

1. For Apple M4 users, please do update the following keys in .env:

   ES_JAVA_OPTS="-Xms512m -Xmx512m -XX:UseSVE=0"
   ES_CLI_JAVA_OPTS="-XX:UseSVE=0"

   To update this, follow these steps:

   1. Go to the .env file located in the docker-compose folder.

   2. Uncomment line no. 10 and 11:

      # ES_JAVA_OPTS="-Xms512m -Xmx512m -XX:UseSVE=0"
      # ES_CLI_JAVA_OPTS="-XX:UseSVE=0"

      Once these changes are made, try docker-compose up again.

2. Integrating local databases/API: To integrate your local databases and API services in the Nected application, please use your machine IP instead of localhost.