Getting Started

Execution

CLI

# Select Chat while configuring your modules
npx @conduitplatform/cli deploy --config

Docker

Prerequisites

# Set up the Container Network
docker network create conduit

# Start Redis
docker run -d --name conduit-redis \
              --network-alias redis \
              --network "conduit" \
              -h conduit-redis \
              -p 6379:6379 \
              docker.io/library/redis:latest

# Start Conduit
docker run -d --name conduit-core \
              --network-alias conduit \
              --network "conduit" \
              -h conduit-core \
              -p 55152:55152 -p 3030:3030 -p 3031:3031 \
              -e REDIS_HOST="conduit-redis" -e REDIS_PORT="6379" \
              ghcr.io/conduitplatform/conduit:latest

# Start MongoDB
docker run -d --name conduit-mongo \
              --network-alias mongo \
              --network "conduit" \
              -h conduit-mongo \
              -p 27017:27017 \
              docker.io/library/mongo:latest

# Start Database
docker run -d --name conduit-database \
              --network-alias database \
              --network "conduit" \
              -h conduit-database \
              -e REGISTER_NAME="true" -e CONDUIT_SERVER="conduit-core:55152" \
              -e DB_TYPE="mongodb" \
              -e DB_CONN_URI="mongodb://conduit-mongo:27017" \
              ghcr.io/conduitplatform/database:latest
# Start Router
docker run -d --name conduit-router \
              --network-alias router \
              --network "conduit" \
              -h conduit-router \
              -p 3000:3000 -p 3001:3001 \
              -e REGISTER_NAME="true" -e CONDUIT_SERVER="conduit-core:55152" \
              ghcr.io/conduitplatform/authentication:latest

docker run -d --name conduit-chat \
              --network-alias chat \
              --network "conduit" \
              -h conduit-chat \
              -e REGISTER_NAME="true" -e CONDUIT_SERVER="conduit-core:55152" \
              ghcr.io/conduitplatform/chat:latest

At this point, you should have a functional Chat instance.
Your users are now capable of creating, joing and utilizing chat rooms to communicate with each other.
You may also create chat rooms and populate them with participants yourself using the Admin Panel.

---

Using the Admin Panel

The admin panel lets you browse the available chat rooms, create new ones and preview their messages.

Creating Rooms

While in the "Rooms" tab of the Chat administration page, click on the "Create Chat Room" button.
A side pane should be brought up on your right, where you can specify your room's details.