andrzejtrzaska/appserver

appserver 镜像文档

镜像概述

appserver是一个基于Go Gin框架开发的轻量级单页应用(SPA)服务器镜像，主要用于提供静态文件服务服务服务，并能将API请求转发至指定的后端服务，适用于前端应用的快速部署与API代理场景。

核心功能与特性

• API请求转发：自动将所有以/api/*开头的请求转发至环境变量API_HOST_HOST指定的后端服务
• 静态文件服务：默认提供public文件夹中的静态资源（如HTML、CSS、JavaScript等）
• SPA路由支持：当请求未匹配任何静态文件或API路由时，自动返回public/index.html，支持前端路由
• 自定义目录配置：可通过命令行参数指定静态文件目录，灵活适配不同项目结构

使用场景

• 前端单页应用（React、Vue、Angular等）的开发与生产环境部署
• 需要将API请求代理至后端服务的前端项目
• 简单静态网站的部署，同时需处理API请求转发的场景

使用方法

环境变量配置

基本使用示例

1. 使用默认静态文件目录

运行容器，使用默认的public目录（容器内路径）并转发API至指定后端：

bash
docker run -e API_HOST=localhost:4000 appserver

2. 自定义静态文件目录

通过命令行参数指定容器内的静态文件目录（如dist）：

bash
docker run -e API_HOST=localhost:4000 appserver dist

3. 挂载本地静态文件目录

将本地项目的静态文件目录挂载到容器内，实现文件实时更新：

bash
docker run -e API_HOST=localhost:4000 -v $(pwd)/public:/app/public appserver

docker-compose 配置示例

yaml
version: '3'
services:
  appserver:
    image: appserver
    environment:
      - API_HOST=backend-service:4000  # 后端服务地址（需与后端服务在同一网络）
    volumes:
      - ./frontend/dist:/app/public    # 挂载本地前端构建产物目录
    ports:
      - "8080:8080"                    # 映射容器端口到主机
    restart: unless-stopped

许可证

MIT