← Back to Docs

Installation

Install and set up WellTested

Complete installation guide for WellTested with multiple deployment options.

System Requirements

Minimum Requirements

  • CPU: 2 cores
  • RAM: 4 GB
  • Disk: 10 GB free space
  • OS: Linux, macOS, or Windows with WSL2

Software Requirements

Option 1: Docker (Recommended)

  • Docker 20.10+
  • Docker Compose 2.0+

Option 2: Local Development

  • Python 3.11+
  • Node.js 18+
  • npm 9+

Installation Methods

Docker provides the easiest and most reliable installation method.

1. Download Release Package

Download the latest release from the official website or GitHub releases:

# Download the package (replace version number)
wget https://github.com/merico-ai/welltested/releases/download/v3.6.1/welltested-v3.6.1.tar.gz

# Or use curl
curl -LO https://github.com/merico-ai/welltested/releases/download/v3.6.1/welltested-v3.6.1.tar.gz

2. Extract Package

tar -xzf welltested-v3.6.1.tar.gz
cd welltested-v3.6.1

3. Run Installation Script

cp .env.example .env
./install.sh

The installation script will:

  • Check prerequisites (Docker, Docker Compose)
  • Configure environment variables
  • Start all services
  • Verify installation

4. Access WellTested

Open your browser: http://localhost:5173

Local Development Installation

For development or when Docker is not available.

1. Download and Extract

tar -xzf welltested-v3.6.1.tar.gz
cd welltested-v3.6.1

2. Configure Environment

cp .env.example .env

3. Start Services

./start.sh

This automatically:

  • Checks prerequisites
  • Installs dependencies
  • Starts backend and frontend
  • Opens browser

4. Access WellTested

Open your browser: http://localhost:5173

Post-Installation

Default Credentials

Username: admin Password: admin

⚠️ Important: Change these credentials after first login!

First Login

  1. Navigate to http://localhost:5173
  2. Login with default credentials
  3. You’ll be prompted to configure LLM settings
  4. Click “Go to System Settings”

Continue to: LLM Configuration

Troubleshooting

Port Already in Use

Error: Port 5173 is already allocated

Solution:

# Find process using port
lsof -i :5173

# Kill process or change port in docker-compose.yml

Docker Permission Denied

Error: permission denied while trying to connect to Docker daemon

Solution:

# Add user to docker group
sudo usermod -aG docker $USER

# Logout and login again

Backend Won’t Start

Error: ModuleNotFoundError or import errors

Solution:

cd backend
pip install -e . --force-reinstall

Frontend Build Fails

Error: npm install fails

Solution:

cd frontend
rm -rf node_modules package-lock.json
npm install

Can’t Access UI

Checklist:

  • ✅ Backend running on port 8000
  • ✅ Frontend running on port 5173
  • ✅ No firewall blocking ports
  • ✅ Browser cache cleared

Next Steps

After installation:

  1. Configure LLM - Set up AI models
  2. Create Project - Create your first project
  3. Upload API - Import OpenAPI document

← Back: Quick Start | ← Documentation | Next: LLM Configuration →