MayWeb Documentation
Comprehensive guides and references to help you master your development environment. Find everything you need to configure, customize, and optimize MayWeb for your workflow.
Getting Started
Welcome to MayWeb! This section will guide you through the initial setup and configuration of your development environment.
System Requirements
- Windows 10 or 11 (64-bit)
- 4GB RAM (8GB recommended)
- 2GB free disk space
- Internet connection for initial setup and updates
Installation Guide
-
Download the Installer
Visit our download page and get the latest installer for your system.
-
Run the Installer
Double-click the downloaded .exe file and follow the setup wizard instructions.
Note
You may need administrator privileges to install system services.
-
Choose Installation Path
Select where you want MayWeb installed (default is C:\MayWeb).
-
Select Components
Choose which services you want to install initially (you can add more later).
-
Complete Installation
Click "Install" and wait for the process to complete.
First Launch Checklist
Pro Tip
Complete these steps to optimize your MayWeb experience right after installation.
- Launch MayWeb from your Start Menu or desktop shortcut
- Configure your root directory (where your projects will live)
- Set your preferred PHP and Node.js versions
- Enable automatic updates in Settings
- Start essential services (Apache, MySQL)
- Create your first virtual host
UI Overview
MayWeb's intuitive interface is designed to give you complete control over your development environment with minimal effort.
Service Panel
The service panel is your command center for all development services:
- Toggle services on/off with a single click
- View service status (running, stopped, error)
- Access service logs directly from the UI
- Restart services individually or all at once
- View resource consumption for each service
PHP and Node.js Switchers
Switch between different versions of PHP and Node.js without restarting your environment:
# Switching PHP version
mayweb php switch 8.1
# Switching Node.js version
mayweb node switch 18
Note
Some version changes may require service restarts. MayWeb will prompt you when necessary.
Disk, CPU, RAM Monitors
Real-time resource monitoring helps you keep track of your system's performance:
- Disk usage: Monitor your project and system disk space
- CPU usage: Track processor load from development services
- RAM consumption: See memory usage at a glance
- History graphs: View resource usage over time
- Threshold alerts: Get notified when resources run low
Warning
Consistently high resource usage may indicate misconfiguration or resource-intensive processes.
Service Management
Detailed guides for configuring and managing each service in MayWeb.
Apache
Configure virtual hosts, manage modules, and adjust performance settings.
# Create a new virtual host
mayweb apache vhost create myproject.test
MySQL/MariaDB
Manage databases, users, and import/export data with ease.
# Access MySQL shell
mayweb mysql shell
Redis
Configure memory limits, persistence, and monitor keyspace.
# Monitor Redis in real-time
mayweb redis monitor
Node.js
Run Node applications, manage npm packages, and switch versions.
# Install global package
mayweb node npm install -g package-name
PostgreSQL
Manage PostgreSQL databases, roles, and extensions.
# Create new PostgreSQL database
mayweb postgres createdb mydb
Update System
MayWeb's smart update system keeps your environment current with minimal effort.
How Updates Work
- Weekly check for updates (configurable)
- Download updates in the background
- Install with a single click when ready
- Rollback option if anything goes wrong
- Component-specific updates
- Changelog preview before updating
Skipping and Forcing Updates
Sometimes you may want to skip an update or force an immediate check:
# Skip the current pending update
mayweb update skip
# Force immediate update check
mayweb update check --force
Important
Skipping critical security updates is not recommended. MayWeb will notify you about important updates that shouldn't be skipped.
Customization
Tailor MayWeb to fit your specific development workflow with these customization options.
Managing Ports
Change default ports to avoid conflicts with other services:
# Change Apache port to 8080
mayweb config set apache.port 8080
Directory Aliases
Create shortcuts to frequently accessed directories:
# Create an alias for your projects folder
mayweb alias add projects C:\dev\my-projects
# Access from terminal
cd ~projects
Startup Behavior
Configure what happens when MayWeb launches:
- Automatically start services on launch
- Launch to system tray instead of main window
- Start minimized
- Run specific scripts on startup
- Delay service startup sequence
FAQs & Troubleshooting
Solutions to common issues and answers to frequently asked questions.
Why won't Apache start?
Common reasons include:
- Port conflict (usually port 80 or 443)
- Invalid configuration in httpd.conf
- Missing dependencies
- Insufficient permissions
- Incorrect document root path
Check the Apache error log for specific details:
mayweb logs apache
How do I reset my MySQL root password?
Follow these steps:
- Stop MySQL service
- Start MySQL in safe mode with skipping grant tables
- Connect to MySQL and update the password
- Restart MySQL normally
mayweb mysql reset-password
Can I use MayWeb with WSL?
Yes! MayWeb works well with Windows Subsystem for Linux:
- Access MayWeb services from WSL via localhost
- Use MayWeb's CLI tools from WSL terminals
- Map Windows directories in WSL for seamless file access
- Run Linux commands against MayWeb services
Reporting Bugs
Found an issue? Help us improve MayWeb:
- Check existing issues on our GitHub repository
- Create a new issue with detailed reproduction steps
- Include MayWeb version and system information
- Attach relevant log files
- Describe expected vs actual behavior
Download Archive
Access previous versions of MayWeb for compatibility or testing purposes.
| Version | Release Date | Status | Download |
|---|---|---|---|
| 1.2.0 | June 15, 2023 | Stable | Download |
| 1.1.5 | May 20, 2023 | Legacy | Download |
| 1.1.0 | April 10, 2023 | Legacy | Download |
| 1.0.3 | March 5, 2023 | Legacy | Download |
| 2.0.0-beta | June 18, 2023 | Beta | Download |
Security Note
Always verify the SHA-256 checksum of your downloads to ensure file integrity:
# Verify download checksum
certutil -hashfile MayWeb_Setup.exe SHA256