Merge pull request #2 from AlexWaha/add-ssl

Final check, fix, done

Author: AlexWaha

README.md

@@ -1,8 +1,8 @@
 # 🚀 DockDev — Instant Docker Dev Domains
 
-> ⚡️ DockDev is a fast CLI tool that helps you create isolated Docker-based development environments with reverse proxy and custom local domains. 
-> 
-> It lets you work locally in Windows + WSL with multiple projects — and access them in the browser using friendly domain names like http://app.local.
+> ⚡️ DockDev is a fast CLI tool that helps you create isolated Docker-based development environments with reverse proxy and custom local domains.
+>
+> It lets you work locally in Windows + WSL with multiple projects — and access them in the browser using friendly domain names like https://app.test.
 
 ![Docker](https://img.shields.io/badge/Docker-ready-blue)
 ![Go](https://img.shields.io/badge/Built%20with-Go-informational)
@@ -16,48 +16,67 @@
 **DockDev** is a developer CLI utility written in Go that helps you instantly:
 
 ✅ Features
-- 🔧 Spin up isolated Docker-based dev environments with NGINX and any containers like PHP, Redis etc.
+- 🔧 Spin up isolated Docker-based dev environments with NGINX, PHP, Node.js, Redis, ElasticMQ etc.
 - 🌐 All traffic is routed through a shared reverse proxy (nginx-reverse-proxy) for seamless local domain support
+- 🔐 **Automatic SSL certificate generation** with Windows trust store integration (HTTPS ready!)
 - 🛠 Assign static IPs via a shared user-defined Docker network (bridge mode)
-- 🌍 Access each project via clean local domains like http://app.local
+- 🌍 Access each project via clean local domains like https://app.test
 - 🗂 Automatically add the domain to your Windows hosts file
 - ⚙️ Reverse proxy configs are generated per-project and hot-reloaded or restarted as needed
-- 🗃️ Includes a shared MySQL container for all projects — connect via native MySQL GUI clients on Windows (e.g. TablePlus, DBeaver, DataGrip etc.)
+- 🗃️ Includes a shared MySQL container for all projects — connect via native MySQL GUI clients on Windows
+- 🖥️ Interactive CLI interface for creating and managing projects
+- 🚀 Automatic Docker Desktop startup and container management
 
 ✅ Ideal for full-stack development inside **WSL2 + Docker Desktop** environments.
 
 ---
 
+## 📋 Prerequisites
+
+- Windows with WSL2
+- Docker Desktop
+- Go 1.24+ (for building from source)
+
 ## 🛠 Installation & Build
 
-💡 You don't need to build it, use the ready-to-run script `dockerdev`
+### Option 1: Build from Source 🔨
 
-1. Install [Go](https://go.dev/dl/)
-2. Clone the repository and enter the folder:
+1. Clone the repository
+2. Run the build script:
 
 ```bash
-git clone https://github.com/your-org/dockdev.git
-cd dockdev
+./build.bat
 ```
 
-3. Build the binary (choose based on your OS)::
+The build script will:
+- Compile the Go code for Linux (WSL compatibility)
+- Create a distribution in the `../dist` folder with the executable
 
-🪟 For Windows (CMD):
-Run `build.bat`
+3. Manually copy the required files to your WSL user folder for example to `/home/user/dockdev`:
+   - `dist/dockdev` (executable)
+   - `dist/templates/` (directory with all templates)
+   - Create a `.env` configuration file (see Configuration section)
+
+4. Set proper executable permissions in your WSL environment:
+```bash
+chmod +x dockdev
+```
 
-> This produces a Linux-compatible binary you can run inside WSL2 or Linux servers.
+### Option 2: Use Pre-built Binary 📦
+
+1. Download the latest release from the releases page
+2. Extract the archive to your preferred location
+3. Run the executable from WSL2
 
 ---
 
 ## ⚙️ Setup
 
-### Copy required files and folders:
-
-> All from folder dist to your WSL
+### Required files and folders in your WSL environment:
 
-- `.env`
-- `dockdev`
-- `templates`
+- `.env` (configuration file)
+- `dockdev` (executable)
+- `templates/` (directory with templates)
 
 ---
 ## 💡 Before you start!
@@ -67,54 +86,73 @@ Run `build.bat`
 > For example: `root /var/www/html/public;`
 >
 > 1. You can update it before adding new project in `templates/nginx.conf.tmpl` for all projects
-> 
-> 2. or after, directly in `domains/YOUR_DOMAIN/conf/nginx/default.conf` 
+>
+> 2. or after, directly in `domains/YOUR_DOMAIN/conf/nginx/default.conf`
 > #### If #2 - Don't forget to remove and run project containers manually!
 
+---
 
 ## 🚀 Usage
 
-### ➕ Create a new domain/project
+### 📘 Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `./dockdev` | Start interactive mode |
+| `./dockdev domain.test` | Create a new project with the specified domain |
+| `./dockdev domain.test --no-ssl` | Create a project without SSL (not recommended) |
+| `./dockdev rm domain.test` | Delete an existing project |
+| `./dockdev -H` or `--help` | Show help message |
 
-#### Interactive:
+### 💬 Interactive Mode
+
+Run the tool without arguments to enter interactive mode:
 
 ```bash
 ./dockdev
 ```
 
-#### Direct:
+Interactive mode will:
+- Show existing projects
+- Allow you to create new projects
+- Allow you to delete existing projects
+- Guide you through all options with prompts
+
+### 🆕 Create a New Project
 
 ```bash
-./dockdev app.local
+./dockdev mydomain.test
 ```
 
 🔧 It will:
 
-- Create `domains/app.local/`
-- Assign next free IP like `10.0.100.12`
+- Create `domains/mydomain.test/`
+- Generate SSL certificates and add them to Windows trust store (**HTTPS ready**)
+- Assign next free IP like `172.20.0.12`
 - Assign IP's for all project containers
 - Generate:
-  - `docker-compose.yml`
-  - `conf/nginx/default.conf`
-  - `app/index.html`
-  - reverse proxy config in `shared-services/sites`
+    - `docker-compose.yml`
+    - `conf/nginx/default.conf`
+    - `app/index.html`
+    - reverse proxy config in `shared-services/sites`
 - Update:
-  - `.ipmap.env` > This file just FYI
-  - `Windows hosts` file
+    - `.ipmap.env` > This file just FYI
+    - `Windows hosts` file
+- Automatically start all services
+- Open your browser to https://mydomain.test
 
 > Your application must be in  `app` folder: `domains/YOUR_DOMAIN/app`
----
 
-### 🗑 Remove a project
+### 🗑️ Delete a Project
 
 ```bash
-./dockdev rm app.local
+./dockdev rm mydomain.test
 ```
 
 You'll be prompted:
 
 ```
-Are you sure you want to delete domain 'app.local'? [y/N]
+Are you sure you want to delete domain 'mydomain.test'? [y/N]
 ```
 
 Deletes:
@@ -123,16 +161,91 @@ Deletes:
 - Reverse proxy `.conf`
 - IP mapping entry
 - Hosts file entry
+- SSL certificates from disk and Windows trust store
 - Drop all domain containers
 
+### ❓ Show Help
+
+```bash
+./dockdev --help
+```
+
+---
+
+## 🏗️ Project Structure
+
+Each project environment includes:
+
+- 🌐 Nginx web server
+- 🐘 PHP-FPM 8.3
+- 📦 Node.js 23
+- ⚡ Redis server
+- 📨 ElasticMQ (SQS-compatible message queue)
+- 🗃️ Shared MySQL database (across all projects)
+
+---
+
+## 🔐 SSL Certificates
+
+DockDev automatically:
+
+1. Generates a root CA certificate and adds it to Windows trust store
+2. Creates domain-specific SSL certificates for each project
+3. Configures Nginx to use HTTPS
+4. Makes all projects accessible via secure HTTPS connections
+
+This means you can develop with:
+- HTTPS by default
+- No browser security warnings
+- Proper SSL testing in your local environment
+- Full compatibility with secure-only features
+
+---
+
+## ⚙️ Configuration
+
+The tool uses an `.env` file for configuration:
+
+```
+DOCKDEV_FOLDER=dockdev
+NETWORK_NAME=local_net
+SUBNET=10.0.100.0/24
+REVERSE_PROXY_IP=10.0.100.2
+SHARED_MYSQL_IP=10.0.100.3
+PROJECT_START_IP=10.0.100.10
+MYSQL_ROOT_PASSWORD=root
+MYSQL_USER=user
+MYSQL_PASSWORD=userpass
+```
+
+---
+
+## 📁 Directory Structure
+
+```
+├── dockdev                  # Main executable
+├── templates/               # Project templates
+│   ├── app/                 # Default web application files
+│   ├── conf/                # Configuration templates
+│   ├── image/               # Docker image definitions
+│   │   ├── node/            # Node.js image
+│   │   └── php/             # PHP image
+│   └── shared-services/     # Shared services templates
+├── domains/                 # Generated project directories
+└── shared-services/         # Shared services (MySQL, Nginx proxy)
+    ├── certs/               # SSL certificates
+    ├── sites/               # Nginx site configurations
+    └── data/                # Persistent data
+```
+
 ---
 
 ## 🧱 Architecture
 
 - 🔧 `dockdev`: CLI manager (Go)
-- 📁 `templates/`: reusable template files 
+- 📁 `templates/`: reusable template files
 > You can extend docker-compose.yml.tmpl with your containers
-- 🌍 `shared-services/`: reverse proxy & shared Mysql DB
+- 🌍 `shared-services/`: reverse proxy & shared MySQL DB
 - 🛠 `.ipmap.env`
 >📘 Reference file for developers, to track which containers was assigned to which IP
 - 🔌 All containers in one shared Docker `bridge` network
@@ -141,8 +254,8 @@ Deletes:
 
 ## ✅ Platform Compatibility
 
-| Platform              | Supported |
-|-----------------------|-----------|
+| Platform              | Supported      |
+|-----------------------|----------------|
 | ✅ Windows 10/11 + WSL | ✔️ Recommended |
 
 ---
@@ -151,6 +264,6 @@ All routed via NGINX with shared IP space and automatic DNS mapping.
 
 ---
 
-## 📄 License
+## 📝 License
 
-This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. 

dist/.env

@@ -10,4 +10,4 @@ PROJECT_START_IP=10.0.100.10
 # Shared MySQL credentials
 MYSQL_ROOT_PASSWORD=root
 MYSQL_USER=user
-MYSQL_PASSWORD=userpass
+MYSQL_PASSWORD=userpass

dist/dockdev

@@ -9,7 +9,7 @@ services:
       - ./nginx.conf:/etc/nginx/nginx.conf:ro
       - ./sites:/etc/nginx/sites:ro
       - ./certs:/etc/nginx/ssl:ro
-      - ./logs/nginx:/var/log/nginx
+      - ./logs/nginx:/var/log/nginx:rw
     networks:
       {{.NetworkName}}:
         ipv4_address: {{.ReverseProxyIP}}
@@ -24,8 +24,8 @@ services:
       MYSQL_USER: {{.MySQLUser}}
       MYSQL_PASSWORD: {{.MySQLPassword}}
     volumes:
-      - ./data/mysql:/var/lib/mysql
-      - ./logs/mysql:/var/log/mysql
+      - ./data/mysql:/var/lib/mysql:rw
+      - ./logs/mysql:/var/log/mysql:rw
     ports: ['3306:3306']
     networks:
       {{.NetworkName}}:

dist/templates/shared-services/docker-compose.yml.tmpl

@@ -0,0 +1,21 @@
+server {
+    listen 80;
+    server_name {{.Domain}};
+    return 301 https://$host$request_uri;
+}
+
+server {
+    listen 443 ssl;
+    server_name {{.Domain}};
+
+    ssl_certificate /etc/nginx/ssl/{{.Domain}}/{{.Domain}}.crt;
+    ssl_certificate_key /etc/nginx/ssl/{{.Domain}}/{{.Domain}}.key;
+    ssl_protocols TLSv1.2 TLSv1.3;
+    ssl_ciphers HIGH:!aNULL:!MD5;
+
+    location / {
+        proxy_pass http://{{.IPsByService.main}}:80;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+    }
+}

dist/templates/site-ssl.conf.tmpl

@@ -1,21 +1,10 @@
 server {
     listen 80;
     server_name {{.Domain}};
-    return 301 https://$host$request_uri;
-}
-
-server {
-    listen 443 ssl;
-    server_name {{.Domain}};
-
-    ssl_certificate /etc/nginx/ssl/{{.Domain}}/{{.Domain}}.crt;
-    ssl_certificate_key /etc/nginx/ssl/{{.Domain}}/{{.Domain}}.key;
-    ssl_protocols TLSv1.2 TLSv1.3;
-    ssl_ciphers HIGH:!aNULL:!MD5;
 
     location / {
         proxy_pass http://{{.IPsByService.main}}:80;
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
     }
-}
+}