Getting Started

Execution

CLI

# Select Storage 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/router:latest

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

Notice: This module is disabled by default as it requires initial configuration.

Selecting Local storage as your provider is the fastest way to get started.
For more information on how to configure the Storage module, see Configuration.

---

Using the Admin Panel

Creating a Container

Creating your own file system requires that you create a container first.

After creating a container, you may now populate your file system.

Create a Folder

Choose a name for your folder and select the container where you wish to store it.

Repeat the same process for creating additional subfolders.

Store a file in a folder

Optianally, navigate to the folder where you wish the file to be stored in.
Example: /mycontainer/myfolder

Click on Add and specify your file's details.

Save your file.