01. Getting Started
Daniel Berki edited this page Feb 16, 2024
·
19 revisions
Message Silo comes with a dedicated CLI tool called siloctl
.
- Download the version corresponding to your OS into a folder.
OS | Link |
---|---|
Windows | Download |
Linux | Download |
MacOS | Download |
-
Add the folder where
siloctl
downloaded into the PATH environment variable. -
Ensure
siloctl
is working.
siloctl --version
You are able to run Message Silo services in your own hardware via Docker containers.
docker run -d --name some-silo -p 5000:8080 messagesilo/messagesilo:latest
Message Silo supports data persistence to the database for entities, ensuring that data remains accessible even after a possible restart. MongoDB is used for this purpose to provide robust and reliable data storage.
- Create the following docker-compose file
version: '3.8'
services:
messagesilo:
image: messagesilo/messagesilo
ports:
- "5000:8080"
environment:
DATABASE_CONNECTION_STRING: "mongodb://database:27017" # MongoDB connection string (You can use Atlas instead).
DATABASE_NAME: "messagesilo-local" # The name of the MongoDB database what Message Silo uses.
AI_API_KEY: "" # (Optional) OpenAI API key (if you would like to use AI type enricher entity).
depends_on:
- database
database:
image: mongo:6-jammy
ports:
- "27017:27017"
volumes:
- ~/mongo/data:/data/db
- Start Message Silo services
docker-compse up
Continue learning about Message Silo & siloctl
in the next section: Entities & Concepts