WolGoWeb 项目安装与使用教程

WolGoWeb 项目安装与使用教程

项目地址:https://gitcode.com/gh_mirrors/wo/WolGoWeb

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

WolGoWeb/
├── docker/
│   ├── Dockerfile
│   └── README.md
├── src/
│   ├── main.go
│   ├── config.go
│   └── ...
├── github/workflows/
│   └── build.yml
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── version

目录结构说明

• docker/: 包含Docker相关的文件，如Dockerfile和README.md，用于Docker部署。
• src/: 项目的源代码目录，包含主要的Go文件，如main.go和config.go。
• github/workflows/: 包含GitHub Actions的工作流配置文件，如build.yml。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• go.mod: Go模块依赖管理文件。
• go.sum: Go模块依赖的校验文件。
• version: 项目版本文件。

2. 项目的启动文件介绍

src/main.go

main.go 是项目的入口文件，负责启动WebAPI服务。以下是main.go的主要功能：

• 初始化配置: 从命令行参数或环境变量中读取配置。
• 启动WebAPI服务: 监听指定端口，处理HTTP请求。
• 处理唤醒请求: 根据接收到的请求，发送唤醒命令到局域网内的主机。

启动命令示例

./WolGoWeb_linux_amd64 -port 9090

• -port: 指定WebAPI服务的端口号，默认是9090。

3. 项目的配置文件介绍

配置文件位置

项目没有独立的配置文件，配置主要通过命令行参数或环境变量进行。

配置参数说明

• -c: 设置配置源，默认是命令行和环境变量。
• -port: 开放服务端口，默认是9090。
• -web: 是否启用Web页面，默认是true。
• -username: 设置Web页面登陆账号，仅在启用Web页面时有效。
• -password: 设置Web页面登陆密码，仅在启用Web页面时有效。
• -key: API权限验证KEY，默认是false，不进行权限验证。

环境变量配置

在Docker部署时，可以通过环境变量来配置：

version: '3'
services:
  wol-go-web:
    image: chishin/wol-go-web:latest
    container_name: WolGoWeb
    restart: unless-stopped
    network_mode: host
    environment:
      - PORT=9090
      - KEY=false

• PORT: 开放服务端口，默认是9090。
• WEB: 是否启用Web页面，默认是true。
• USERNAME: 设置Web页面登陆账号，仅在启用Web页面时有效。
• PASSWORD: 设置Web页面登陆密码，仅在启用Web页面时有效。
• KEY: API权限验证KEY，默认是false，不进行权限验证。

通过以上配置，可以灵活地启动和管理WolGoWeb服务。

WolGoWeb 基于Golang的远程唤醒WebAPI 项目地址: https://gitcode.com/gh_mirrors/wo/WolGoWeb