superorbital/example

Example Web Application Docker镜像文档

一、镜像概述

Example Web Application 是一个轻量级的示例Web应用Docker镜像，主要用于技术工作坊、培训课程或Docker入门学习场景。该镜像封装了基础的Web服务功能，可快速部署并演示Web应用的运行流程，帮助用户理解容器化部署的基本概念和操作步骤。

二、核心功能和特性

核心功能

• 内置HTTP服务器，支持基本HTTP请求处理
• 提供默认演示页面，展示应用运行状态
• 支持自定义端口映射，灵活配置服务端口
• 可通过环境变量配置应用参数（如服务端口、页面标题等）

特性

• 轻量级：基于精简基础镜像，镜像体积小，启动速度快
• 易部署：无需复杂依赖，一键运行容器即可启动服务
• 可配置：支持通过环境变量自定义关键参数，适配不同演示需求
• 可视化：提供简单直观的Web页面，便于验证服务运行状态

三、使用场景和适用范围

使用场景

• 技术工作坊：演示Docker容器化部署流程
• 培训课程：讲解Web应用容器化基础概念
• Docker入门学习：实践容器启动、端口映射、环境变量配置等操作
• 教学演示：展示Web服务与容器的交互关系

适用范围

• 开发人员：学习Docker基础操作和Web应用部署
• 培训讲师：在课程中快速搭建演示环境
• 初学者：通过实例理解容器化技术的核心概念

四、使用方法和配置说明

前提条件

• 已安装Docker Engine（推荐版本20.10+）
• 网络环境可访问Docker镜像仓库（或已提前加载本地镜像）

1. 获取镜像

从Docker仓库拉取镜像（若未指定仓库地址，默认使用官方/工作坊私有仓库）：

bash
docker pull example-webapp:latest

2. 基本运行示例

2.1 快速启动容器

使用默认配置运行容器，映射容器80端口到主机8080端口：

bash
docker run -d -p 8080:80 --name example-webapp example-webapp:latest

• -d：后台运行容器
• -p 8080:80：将主机8080端口映射到容器80端口（容器内默认HTTP服务端口为80）
• --name example-webapp：指定容器名称为example-webapp

2.2 验证服务运行

容器启动后，通过浏览器或curl命令访问主机8080端口：

bash
curl http://localhost:8080

若服务正常运行，将返回默认演示页面内容（如"Example Web App is running!"）。

3. 环境变量配置

该镜像支持通过环境变量自定义应用行为，常用配置如下：

示例：自定义端口和标题

bash
docker run -d \
  -p 9000:8080 \  # 主机9000端口映射到容器8080端口（容器内端口通过PORT变量修改为8080）
  -e PORT=8080 \
  -e PAGE_TITLE="Workshop Demo App" \
  --name custom-webapp example-webapp:latest

4. Docker Compose配置示例

通过docker-compose.yml实现更便捷的部署和管理：

yaml
version: '3.8'
services:
  example-webapp:
    image: example-webapp:latest
    container_name: example-webapp
    ports:
      - "8080:80"  # 主机端口:容器端口（容器端口需与PORT环境变量一致，默认80）
    environment:
      - PAGE_TITLE="Docker Compose Demo"
      - SHOW_VERSION="true"
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动命令：

bash
docker-compose up -d

5. 自定义页面内容（可选）

若需替换默认演示页面，可通过挂载主机目录到容器内Web服务的静态文件目录（默认路径/app/static）：

bash
docker run -d \
  -p 8080:80 \
  -v /path/to/local/static:/app/static \  # 本地静态文件目录挂载到容器
  --name custom-page-webapp example-webapp:latest

注：本地目录需包含至少一个index.html文件，作为Web服务的默认首页。

五、注意事项

1. 端口冲突：运行容器时需确保主机端口未被占用，若提示"Bind for 0.0.0.0:8080 failed"，可更换主机端口（如-p 8081:80）。
2. 权限问题：若挂载本地目录时出现权限错误，可添加-u root参数以root用户运行容器（仅建议测试环境使用）。
3. 镜像版本：生产环境或正式演示建议指定具体版本号（如example-webapp:1.0），避免因latest标签自动更新导致兼容性问题。
4. 网络访问：若容器运行在远程服务器，需确保防火墙开放映射的主机端口，否则无法从外部访问。

六、总结

Example Web Application Docker镜像为技术工作坊和Docker入门学习提供了简单、易用的演示工具。通过本文档的指导，用户可快速掌握容器拉取、运行、配置及访问的全流程，为深入学习容器化技术奠定基础。