# nest-template

**Repository Path**: JoinXin/nest-template

## Basic Information

- **Project Name**: nest-template
- **Description**: nest 模版 ，一个快速便捷的Node 框架sadsadasdasd
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://gitee.com/JoinXin/nest-template/settings#index
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-27
- **Last Updated**: 2024-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nest-template

# 配置项详解

## 1, linux 发布配置文件

- docker-compose.yml
- Dockerfile
- deploy.sh
- deploy_offline.sh

## 2, windows 发布配置文件

- win_service/config.service.json 
> windwos 服务模式 启动配置  

```json
{
    // 程序名称
    "name": "lp_test",
    // 程序描述
    "description": "test desc",
    // 最大重启次数 不设置 一直重启
    "maxRestarts": 9999,
    // 重启等待延时 3s
    "wait": 3,
    // 程序启动路径
    "script": "dist/main.js",
    // 是否要以指定用户权限登录
    "allowServiceLogon": true,
    // 用户名
    "account": "pc",
    // 用户密码
    "password": "root"
}
```

- win_service/config.app.json 
> 程序配置项(需要暴露给现场人员配置的 配置项)（安装程序以此配置为基准 生成动态表单 供安装人员填写）

```json
[
    {
        "title": "app配置",
        "config": [
            {
                "key": "logFile",
                "desc": "日志地址"
            }
        ]
    },
    {
        "title": "mysql配置",
        "config": [
            {
                "key": "mysql_host",
                "desc": "mysql IP",
                // 可选字段（valid=true 必选）
                "originKey": "host"
            },
            {
                "key": "user",
                "desc": "mysql 用户名",
                "originKey": "username"
            },
            {
                "key": "password",
                "desc": "mysql 密码",
                "originKey": "password"
            },
            {
                "key": "port",
                "desc": "mysql 端口",
                "originKey": "port"
            },
            {
                "key": "db",
                "desc": "数据库名称",
                "originKey": "database"
            }
        ],
        // 可选
        "valid": true,
        // 可选字段（ valid=true 必选）
        "validType": "mysql"
    }
]

```

- win_service/config.production.json   
> 生产环境配置（由web运维软件，安装器模块注入，最终以环境变量方式注入 提供程序使用）仅在以windows服务启动时生效

```json
{
    "NODE_ENV": "production"
}
```

##  3，程序运行时的配置选择：先用环境变量，没有则用config/*.json 中的配置