Sign inSign up

miemiefeng/vpn-auto-register

By miemiefeng

•Updated about 1 year ago

VPN自动注册服务 - 智能的VPN订阅管理系统

Image
0

794

miemiefeng/vpn-auto-register repository overview

⁠VPN自动注册服务 Docker部署指南

⁠快速开始

⁠1. 准备工作

确保您的NAS或服务器已安装:

  • Docker
  • Docker Compose
⁠2. 配置服务

编辑 config/config.yaml 文件,配置您的邮箱和API信息:

# Gmail配置(用于注册)
gmail:
  base_email: "[email protected]"
  password: "your_app_password"

# QQ邮箱配置(用于接收验证码)
qq_email:
  email: "[email protected]"
  password: "your_qq_password"
  imap_server: "imap.qq.com"
  imap_port: 993
⁠3. 一键部署
# 给脚本执行权限
chmod +x deploy.sh manage.sh

# 执行部署
./deploy.sh
⁠4. 验证部署

访问 http://your_nas_ip:10084 查看服务状态。

⁠管理命令

使用 manage.sh 脚本进行日常管理:

# 查看服务状态
./manage.sh status

# 查看实时日志
./manage.sh logs-f

# 重启服务
./manage.sh restart

# 停止服务
./manage.sh stop

# 启动服务
./manage.sh start

# 备份数据
./manage.sh backup

⁠目录结构

vpn-auto-register/
├── config/          # 配置文件目录
│   └── config.yaml  # 主配置文件
├── data/            # 数据持久化目录
│   └── accounts.json # 账号数据
├── logs/            # 日志目录
├── Dockerfile       # Docker镜像构建文件
├── docker-compose.yml # Docker Compose配置
├── deploy.sh        # 一键部署脚本
└── manage.sh        # 管理脚本

⁠端口说明

  • 10084: HTTP服务端口,用于提供订阅服务和状态查看

⁠数据持久化

以下目录会被持久化到宿主机:

  • ./config -> /app/config (配置文件,只读)
  • ./data -> /app/data (数据文件)
  • ./logs -> /app/logs (日志文件)

⁠健康检查

容器内置健康检查,每30秒检查一次服务状态。

⁠故障排除

⁠1. 服务无法启动
# 查看详细日志
./manage.sh logs

# 检查配置文件
cat config/config.yaml
⁠2. 无法访问服务
  • 检查防火墙设置
  • 确认端口10084未被占用
  • 检查NAS的网络配置
⁠3. 邮箱验证码接收失败
  • 确认Gmail应用密码正确
  • 确认QQ邮箱IMAP已开启
  • 检查网络连接

⁠更新服务

# 拉取最新代码后执行
./manage.sh update

⁠备份与恢复

⁠备份
./manage.sh backup
⁠恢复
# 停止服务
./manage.sh stop

# 恢复数据
cp -r backup_YYYYMMDD_HHMMSS/data ./
cp -r backup_YYYYMMDD_HHMMSS/config ./

# 启动服务
./manage.sh start

⁠安全建议

  1. 定期更新Docker镜像
  2. 使用强密码
  3. 限制网络访问
  4. 定期备份数据
  5. 监控日志异常

⁠技术支持

如遇问题,请查看:

  1. 容器日志:./manage.sh logs
  2. 系统日志:journalctl -u docker
  3. Docker状态:docker ps -a

Tag summary

Content type

Image

Digest

sha256:db52ece1e…

Size

18.8 MB

Last updated

about 1 year ago

docker pull miemiefeng/vpn-auto-register