aubertg/gmvault-docker

Gmvault Docker镜像

代码状态

概述

该Docker镜像可定期运行Gmvault，支持快速（每日）和完整（每周）两种同步计划，并通过ssmtp发送同步报告。适用于需要定期备份邮件账户数据的场景。

快速启动示例

bash
docker run \
    -v /my/backup/directory:/data \
    -v /my/host/ssmtp.conf:/etc/ssmtp/ssmtp.conf \
    -t \
    -d \
    --name=Gmvault \
    -e GMVAULT_UID=$(id -u myuser) \
    -e GMVAULT_GID=$(id -g mygroup) \
    -e GMVAULT_EMAIL_ADDRESS="myaddress@gmail.com" \
    aubertg/gmvault-docker

首次运行容器

Gmvault需要对要备份的账户进行身份验证。由于Google对邮件数据访问的新安全要求，首次运行容器需完成以下设置步骤：

1. 附加终端到容器。
2. 运行命令：gmvault check ${GMVAULT_EMAIL_ADDRESS}，但不要按Enter，而是按Ctrl+C。此步骤会在数据目录中创建gmvault_defaults.conf，但需先创建自定义Google应用以获取OAuth令牌。
3. 关闭容器。
4. 按照https://github.com/gaubert/gmvault/issues/335#issuecomment-846483036%E7%9A%84%E8%AF%B4%E6%98%8E%E5%88%9B%E5%BB%BA%E6%96%B0%E7%9A%84%E5%AE%A2%E6%88%B7%E7%AB%AFID%E5%92%8C%E5%AF%86%E9%92%A5%EF%BC%9A
   • 不一定需要使用要备份的账户执行此步骤，只要将所有要备份的账户添加为测试用户即可正常工作。
   • 注意根据GMVault版本更新conf_version的重要性。
   • 需运行的最后一条命令是gmvault check --renew-oauth2-tok ${GMVAULT_EMAIL_ADDRESS}，此时需要重新启动容器。
5. 要测试GMVault是否正确设置，可运行/app/backup_quick.sh执行快速同步。

卷

容器需要挂载以下卷才能正常工作：

• /data
  存储OAuth令牌、邮件备份和日志的目录。

• /etc/ssmtp/ssmtp.conf
  用于从Docker容器发送邮件报告的ssmtp配置文件。

  Gmail示例配置：

  # Gmail SMTP服务设置
  mailhub=smtp.gmail.com:587
  hostname=smtp.gmail.com:587
  UseSTARTTLS=YES
  FromLineOverride=YES
  
  # Gmail账户
  root=mygmailaddress@gmail.com
  AuthUser=mygmailaddress@gmail.com
  AuthPass=mypassword
  

环境变量

容器可通过以下环境变量进行配置：

• GMVAULT_EMAIL_ADDRESS（必填）
  要备份的账户***地址。

• GMVAULT_SEND_REPORTS_TO（可选）
  接收报告的***地址，默认为GMVAULT_EMAIL_ADDRESS。

• GMVAULT_UID（可选）
  主机中应拥有创建文件的数值用户ID，默认为9000。

• GMVAULT_GID（可选）
  主机中应拥有创建文件的数值组ID，默认为9000。

• GMVAULT_TIMEZONE（可选）
  时区，默认为America/Los_Angeles。

• GMVAULT_OPTIONS（可选）
  传递给gmvault的额外选项（如-c no）。

• GMVAULT_QUICK_SYNC_SCHEDULE（可选）
  自定义快速同步计划，默认为每日。

• GMVAULT_FULL_SYNC_SCHEDULE（可选）
  自定义完整同步计划，默认为每周。

• GMVAULT_SYNC_ON_STARTUP（可选）
  设置为yes可在容器启动时触发同步，补充正常的 cron 计划。

致谢

• 感谢https://github.com/gaubert%E5%BC%80%E5%8F%91%E4%BA%86https://github.com/gaubert/gmvault%EF%BC%81
• 感谢https://github.com/jdhorne%E5%8F%91%E5%B8%83%E4%BA%86https://github.com/jdhorne/gmvault-docker%EF%BC%81%E5%9C%A8%E6%9E%84%E5%BB%BA%E8%87%AA%E5%B7%B1%E7%9A%84%E9%95%9C%E5%83%8F%E5%89%8D%EF%BC%8C%E6%88%91%E4%BB%8E%E4%BD%A0%E7%9A%84%E6%9E%B6%E6%9E%84%E4%B8%AD%E5%AD%A6%E5%88%B0%E4%BA%86%E5%BE%88%E5%A4%9A%E3%80%82

版权

Copyright (C) 2017-2021 Guillaume Aubert.

许可

本软件以MIT许可发布。详见LICENSE文件。

免责声明

我通过开源许可向您提供本仓库中的代码。由于这是我的个人仓库，您获得的代码许可来自我本人，而非我的雇主（***）。