Quick Start

Get your remote development environment running in just a few minutes.

Prerequisites

Ensure you have installed:

• Docker - Install Docker
• Docker Compose - Included with Docker Desktop
• Git - Install Git

Step 1: Clone and Configure

# Clone the repository
git clone https://github.com/MKS2508/mks-dev-environment.git
cd mks-dev-environment/docker

# Copy environment template
cp .env.example .env

# Optional: Edit passwords and configuration
vim .env

Step 2: Start Services

# Start all services
docker compose up -d

# Check status
docker compose ps

Wait for all services to be healthy (may take a few minutes on first run).

Step 3: Initialize Guacamole

Run the initialization script once to set up the database and create the default connection:

cd guacamole
chmod +x init.sh
./init.sh

This will:

• Download and apply the Guacamole database schema
• Create a default RDP connection to devenv-full

Step 4: Access Your Environment

Web Desktop (Guacamole)

Open your browser to: http://localhost:8081/guacamole

• Username: guacadmin
• Password: guacadmin
• ⚠️ Change password after first login!

Code-Server (VS Code in Browser)

Open: http://localhost:8443

• Password: From .env file (default: devenv)

SSH Access

ssh root@localhost -p 2223

Requires SSH key configured in .env.

X2Go (High Performance Desktop)

X2Go offers better performance than RDP with lower latency.

Installation:

# macOS
brew install --cask x2goclient

# Linux
sudo apt install x2goclient

Connection:

• Host: localhost
• Port: 2223
• Username: root
• Session Type: XFCE

RDP Access

Connect from any RDP client to: localhost:3389

• Username: root
• Password: From .env file (default: devenv)

What's Next?

• 📖 Architecture - Learn about the system architecture
• ⚙️ Configuration - Customize your environment
• 🖥️ Guacamole Setup - Configure web desktop connections
• 🔧 Troubleshooting - Common issues and solutions

Stopping Services

# Stop all services
docker compose down

# Stop and remove volumes (⚠️ deletes data)
docker compose down -v

Updating

# Pull latest changes
git pull

# Rebuild and restart
docker compose up -d --build