Skip to main content

Documentation Index

Fetch the complete documentation index at: https://prismeai-docs-next.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Docker provides an effective solution for deploying Prisme.ai in local or on-premise environments. This guide covers everything you need to quickly deploy and manage Prisme.ai using Docker Compose.

​
Prerequisites

Ensure your system meets the following prerequisites:
  • Docker (version 20.10+) and Docker Compose installed.
  • Minimum hardware: 4 vCPU, 16 GB RAM, 50 GB disk space recommended.
  • Git installed for cloning the repository.
  • DNS setup: Local wildcard DNS (*.pages.local.prisme.ai) pointed to Docker host machine.

​
Docker Environment Setup

Follow these steps to set up your local Docker environment for Prisme.ai:
1

Clone Repository

Clone the Prisme.ai repository from GitLab:
git clone https://gitlab.com/prisme.ai/prisme.ai.git
cd prisme.ai
2

Configure Environment Variables

Edit the .env file at the root of the project to configure your Docker environment:Example .env configuration:
PAGES_HOST=.pages.local.prisme.ai:3100
CONSOLE_URL=http://studio.local.prisme.ai:3000
API_URL=http://api.local.prisme.ai:3001/v2
ACCOUNT_VALIDATION_METHOD=auto
UPLOADS_MAX_SIZE=100mb
Ensure DNS entries (studio.local.prisme.ai, api.local.prisme.ai) point to your Docker host IP.
3

Start Prisme.ai with Docker Compose

Launch Prisme.ai and its dependencies using Docker Compose:
docker-compose up -d
This command will start all necessary Prisme.ai microservices and databases (MongoDB, Redis, Elasticsearch).
4

Verify Deployment

Check running containers:
docker-compose ps
Verify logs for issues:
docker-compose logs -f
5

Access Prisme.ai Studio

Visit the URL defined in your .env file (e.g., http://studio.local.prisme.ai:3000) to access the Prisme.ai Studio.

​
Docker Best Practices

Resource Management

  • Monitor resource usage regularly.
  • Adjust container resource limits using Docker Compose configurations.

Persistent Storage

  • Ensure volumes are correctly configured for persistent storage.
  • Regularly back up Docker volumes.

Network Configuration

  • Utilize dedicated Docker networks for Prisme.ai.
  • Configure proper DNS records for easier access and testing.

Security Measures

  • Regularly update Docker and images.
  • Limit container privileges and exposure to the host system.

​
Common Commands & Troubleshooting

  • Start containers: 
    docker-compose up -d
  • Stop containers: 
    docker-compose down
  • View logs: 
    docker-compose logs -f [service-name]
  • Restart services: 
    docker-compose restart [service-name]
If DNS entries are not resolving:
  • Check your /etc/hosts file (Linux/Mac) or hosts file (Windows).
  • Ensure wildcard DNS (*.pages.local.prisme.ai) is configured correctly.
If encountering performance issues:
  • Increase Docker resources (CPU, RAM) in Docker Desktop settings or Docker Engine configurations.
  • Optimize services by tuning environment variables (UPLOADS_MAX_SIZE, database caches).

​
Next Steps

Helm Deployment

Explore deploying Prisme.ai using Helm

High Availability

Learn about ensuring high availability

Products Configuration

Configure your Prisme.ai AI products

Install from scratch (v27)

Fresh-install walkthrough.

Migration v27

Migrate an existing instance to v27.

Operations Management

Learn about scaling operations efficiently