Skip to main content

​
Installation

MachinaOs can be installed using npm for development or Docker for production.

​
Prerequisites

  • Node.js 18+
  • Python 3.12+
  • Git

​
Quick Install

# Clone the repository
git clone https://github.com/trohitg/MachinaOS.git
cd MachinaOs

# Install dependencies
npm run build

# Start all services
npm run start
The app will be available at:
  • Frontend: http://localhost:3000
  • Backend: http://localhost:3010
  • WhatsApp: http://localhost:9400

​
Environment Configuration

Copy the example environment file: 
cp .env.example .env

​
Key Settings

​
VITE_CLIENT_PORT
number
default:"3000"
Frontend development server port
​
PYTHON_BACKEND_PORT
number
default:"3010"
Backend API server port
​
AUTH_MODE
string
default:"single"
Authentication mode: single (first user is owner) or multi (open registration)
​
REDIS_ENABLED
boolean
default:"false"
Enable Redis cache. Set to true for production.
​
VITE_ANDROID_RELAY_URL
string
WebSocket URL for remote Android device connections

​
Full Environment Example

# Ports
VITE_CLIENT_PORT=3000
PYTHON_BACKEND_PORT=3010

# Authentication
AUTH_MODE=single
JWT_SECRET_KEY=your-secret-key-min-32-chars

# Cache (production)
REDIS_ENABLED=false
REDIS_URL=redis://localhost:6379

# Optional API Keys
OPENAI_API_KEY=
ANTHROPIC_API_KEY=
GOOGLE_AI_API_KEY=
GOOGLE_MAPS_API_KEY=

​
Verify Installation

  1. Open http://localhost:3000 in your browser
  2. You should see the MachinaOs workflow editor
  3. Check the backend health: curl http://localhost:3010/health
If you see the workflow canvas with the component palette, installation is complete!

​
Troubleshooting

Change the port in .env:
VITE_CLIENT_PORT=3001
PYTHON_BACKEND_PORT=3011
Create a virtual environment:
cd server
python -m venv venv
source venv/bin/activate  # or venv\Scripts\activate on Windows
pip install -r requirements.txt
Check logs and rebuild:
docker-compose logs -f
docker-compose down
docker-compose up --build -d

​
Next Steps

Quick Start

Build your first workflow in 5 minutes