开源项目 ztncui-aio 使用教程

开源项目 ztncui-aio 使用教程

ztncui-aio项目地址:https://gitcode.com/gh_mirrors/ztn/ztncui-aio

1. 项目的目录结构及介绍

ztncui-aio/
├── LICENSE
├── README.md
├── docker-compose.yml
├── etc/
│   ├── nginx/
│   │   └── nginx.conf
│   └── ztncui/
│       └── passwd
├── scripts/
│   ├── entrypoint.sh
│   └── setup.sh
└── var/
    └── lib/
        └── mongodb/

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• docker-compose.yml: Docker 容器编排文件。
• etc/: 配置文件目录。
  • nginx/: Nginx 配置文件目录。
    • nginx.conf: Nginx 主配置文件。
  • ztncui/: ztncui 配置文件目录。
    • passwd: ztncui 用户密码文件。
• scripts/: 脚本文件目录。
  • entrypoint.sh: Docker 容器入口脚本。
  • setup.sh: 项目初始设置脚本。
• var/: 数据存储目录。
  • lib/: 库文件目录。
    • mongodb/: MongoDB 数据存储目录。

2. 项目的启动文件介绍

项目的启动主要依赖于 docker-compose.yml 文件。该文件定义了如何启动和管理 Docker 容器。以下是 docker-compose.yml 文件的关键部分：

version: '3'
services:
  ztncui:
    image: keynmol/ztncui
    container_name: ztncui
    ports:
      - "3443:3443"
    volumes:
      - ./etc/ztncui:/opt/key-networks/ztncui/etc
      - ./var/lib/mongodb:/var/lib/mongodb
    environment:
      - HTTP_ALL_INTERFACES=yes
    depends_on:
      - mongodb

  mongodb:
    image: mongo
    container_name: mongodb
    volumes:
      - ./var/lib/mongodb:/var/lib/mongodb

• ztncui: 定义了 ztncui 服务的容器配置，包括端口映射、卷挂载和环境变量。
• mongodb: 定义了 MongoDB 服务的容器配置，包括卷挂载。

3. 项目的配置文件介绍

etc/nginx/nginx.conf

这是 Nginx 的主配置文件，负责配置 Web 服务器的各种参数和路由规则。以下是部分配置示例：

server {
    listen 80;
    server_name example.com;

    location / {
        proxy_pass http://ztncui:3443;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

etc/ztncui/passwd

这是 ztncui 的用户密码文件，用于存储用户认证信息。文件格式如下：

admin:password123

其中 admin 是用户名，password123 是密码。

通过以上配置，可以启动和管理 ztncui 项目，并进行相应的用户认证和 Web 服务配置。

ztncui-aio项目地址:https://gitcode.com/gh_mirrors/ztn/ztncui-aio