GoDoxy项目使用教程

GoDoxy项目使用教程

godoxy Easy to use reverse proxy with docker integration 项目地址: https://gitcode.com/gh_mirrors/go/godoxy

1. 项目目录结构及介绍

GoDoxy项目的目录结构如下：

godoxy/
├── certs/                     # 存储SSL证书文件
│   ├── cert.crt
│   └── priv.key
├── compose.yml                # Docker Compose文件
├── config/                    # 配置文件目录
│   ├── config.yml             # 主配置文件
│   ├── middlewares/           # 中间件配置目录
│   │   ├── middleware1.yml
│   │   └── middleware2.yml
│   ├── providers/             # 提供者配置目录
│   │   ├── provider1.yml
│   │   └── provider2.yml
├── data/                      # 数据存储目录
│   ├── metrics/               # 度量数据
│   │   ├── uptime.json
│   │   └── system_info.json
└── .env                       # 环境变量文件

• certs/：存放SSL证书文件，包括证书和私钥。
• compose.yml：Docker Compose文件，用于定义和运行多容器Docker应用。
• config/：配置文件目录，包含主配置文件和额外的中间件、提供者配置。
• data/：数据存储目录，用于存放系统信息和运行时长等数据。
• .env：环境变量文件，用于设置环境变量。

2. 项目的启动文件介绍

项目的启动主要依赖于compose.yml文件和.env环境变量文件。

• compose.yml：这是一个Docker Compose文件，它定义了GoDoxy服务及其依赖的服务的配置。它包括服务名称、使用的镜像、环境变量、端口绑定等信息。

  示例片段：

  version: '3'
  services:
    godoxy:
      image: yusing/godoxy:latest
      environment:
        - PROXY_PORT=8080
      ports:
        - "8080:8080"
      volumes:
        - ./data:/data
      networks:
        - godoxy_net
  networks:
    godoxy_net:
  

• .env：环境变量文件，用于设置GoDoxy在运行时需要使用的环境变量，如监听端口、数据库配置等。

  示例内容：

  PROXY_PORT=8080
  

启动项目时，你需要运行以下命令：

docker-compose up -d

这将启动在compose.yml文件中定义的所有服务。

3. 项目的配置文件介绍

项目的配置主要通过config/config.yml文件进行。

• config/config.yml：这是GoDoxy的主配置文件，它包含了GoDoxy运行所需的所有配置信息，如代理设置、自动SSL配置、中间件设置等。

  示例配置：

  proxy:
    port: 8080
    ssl:
      enabled: true
      cert_path: ./certs/cert.crt
      key_path: ./certs/priv.key
    routes:
      - host: "*.domain.com"
        to: "http://localhost:8080"
  

在此文件中，你可以配置GoDoxy的监听端口、SSL设置、路由规则等。确保在修改配置后重启GoDoxy服务以应用新的配置。

godoxy Easy to use reverse proxy with docker integration 项目地址: https://gitcode.com/gh_mirrors/go/godoxy