Local Installation
Local Setup
This guide is for local development and testing purposes only. For production environments, please contact our team for a managed solution.
Prerequisites
Before starting the installation, ensure you have all required software installed on your system.
Required Software
1. Docker & Docker Compose
- Install Docker Desktop (includes both Docker Engine and Docker Compose)
2. Node.js
3. Git
System Requirements
Minimum Requirements
These are the minimum requirements for running Zymmr in development mode:
- CPU: 2+ cores
- RAM: 4GB minimum (8GB recommended)
- Storage: 20GB free space
- OS:
- Windows 10/11 Pro or Enterprise
- macOS 12 or later
- Ubuntu 20.04 or later
- Network: Stable internet connection
Installation Steps
Source Code
The source code is available on GitHub: zymmr/zymmr-docker
- Clone the repository:
bash
git clone https://github.com/zymmr/zymmr-docker.git
cd zymmr-docker
- Set the site name and start containers:
bash
set SITE_NAME=abc.zymmr.com && docker-compose up -d
- Access Zymmr at
http://<server-ip>
Linux Setup
- Clone the repository:
bash
git clone https://github.com/zymmr/zymmr-docker.git
cd zymmr-docker
- Set the site name and start containers:
bash
SITE_NAME=abc.zymmr.com docker-compose up -d
- Access Zymmr at
http://<server-ip>
Troubleshooting
Common Issues
- Port Conflicts
bash
# Check for port usage
sudo lsof -i :3000
sudo lsof -i :5432
- Docker Issues
bash
# View logs
docker-compose logs -f app
# Restart services
docker-compose restart