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:
2
Configure Environment Variables
Edit the Ensure DNS entries (
.env
file at the root of the project to configure your Docker environment:Example .env
configuration: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:This command will start all necessary Prisme.ai microservices and databases (MongoDB, Redis, Elasticsearch).
4
Verify Deployment
Check running containers:Verify logs for issues:
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
Docker Compose Useful Commands
Docker Compose Useful Commands
- Start containers:
- Stop containers:
- View logs:
- Restart services:
Resolving DNS Issues
Resolving DNS Issues
If DNS entries are not resolving:
- Check your
/etc/hosts
file (Linux/Mac) orhosts
file (Windows). - Ensure wildcard DNS (
*.pages.local.prisme.ai
) is configured correctly.
Resource Constraints
Resource Constraints
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).