Skip to content
/ nginx Public

A custom nginx image optimized for SPA front-end project with multiple environment support

Notifications You must be signed in to change notification settings

cuigh/nginx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

此镜像是为了解决 SPA 前端项目在 Docker 下的多环境部署问题,它可以在站点启动时把环境依赖参数自动注入到项目中。

快速上手

example 目录下包含了一个完整的示例项目,对一个已有的 SPA 项目来说,你可以按照下面的步骤做改造。

1. 添加配置文件

src/config目录下添加各环境下的配置文件,并按app.{profile}.json规范命名,如app.production.json

{
    "API_BASE_URL": "https://{your-api-site-domain}"
}

2. 在项目中使用配置

由于启动器会把环境变量注入到 window.config 全局变量中,所以项目中使用环境变量的方式需要做一些调整。

const baseUrl = window.config?.API_BASE_URL || import.meta.env.VITE_API_BASE_URL;

如果你使用了 TypeScript,你可能还需要扩展Window对象的定义以通过编译,在 config 目录中新建一个 config.d.ts 文件,并输入如下内容

interface Window {
    config?: {
        API_BASE_URL: string
    }
}

现在你只需要在.env.development.env.local中添加开发环境的配置参数即可,其它环境下的配置你应该把它们挪到config目录中。

3. 添加 Dockerfile 文件

假设项目输出目录为 dist,把下面三行代码复制到 Dockerfile 文件中即可构建可支持多环境的通用镜像。

FROM cuigh/nginx
COPY dist .
COPY src/config config/

4. 启动站点

启动容器时通过profile环境变量激活指定环境的配置参数。

docker run -e PROFILE=prd --name test -it -p 8080:80 test

5. 高级功能

  1. 如果你喜欢,你可以使用 yaml 格式的配置文件。
  2. 如果你喜欢,你依然可以使用 .env.{profile} 文件来存放配置,从而继续享受美好的旧时光。

需要注意的是,无论使用哪种配置文件,在构建 Docker 镜像时一定要把配置文件包含进去。

About

A custom nginx image optimized for SPA front-end project with multiple environment support

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published