easysoft/2fauth repository overview

⁠QuickOn 2FAuth 应用镜像

⁠快速参考

• 通过 渠成软件百宝箱⁠ 一键安装 2FAuth
• Dockerfile 源码⁠
• 2FAuth 源码⁠
• 2FAuth 官网⁠

⁠一、关于 2FAuth

2FAuth⁠ 是一款基于Web、可独立安装的一次性密码生成器（OTP），可替代 Google Authenticator，兼容移动设备与桌面浏览器。

2FAuth官网：https://docs.2fauth.app/⁠

⁠1.1 为什么选择 2FAuth

近年来，双重身份验证（Two-factor authentication，简称2FA）变得非常流行，越来越多的网站都通过二次验证来对账号进行更高级的保护。可以想象未来会有更多的场景来使用二次身份验证。

2FAuth 的目的是简化您使用和管理 2FA 的方式，无论您使用什么设备，都具有简洁且适配的界面。在没有智能手机的情况下在电脑前处理二次验证的请求。2FAuth 就为此诞生，满足您手机与PC端管理2FA的新选择。

此外，作为一个开源和私有部署的应用程序，它可以让控制您的个人安全数据，为您提供隐私和备份的能力（您是否丢失了带有 Google Auth 中所有 2FA 帐户的智能手机？我遇到过 …… 这体验简直太烂了。）

⁠1.2 特性

• 生成密码 2FAuth 的主要目的：为您提供一些全新的 TOTP/HOTP 安全代码，即一次性密码。

• 随时随地工作 它是一个 Web 应用程序，无论您使用什么设备，它都能正常工作。 您只需要一台设备（甚至不是您的设备）和互联网连接。

• 二维码扫描 扫描并解码 二维码 可立即添加 2FA 帐户。 实际上，它可以解码任何二维码，甚至是非 2FA。

• 2FA管理 管理您的 2FA 帐户，使用组对它们进行组织和分类，编辑和删除它们。 您甚至可以在不扫描二维码的情况下手动添加帐户。

• 保护您的数据 2FAuth 代码开源，可私有化部署，通过 WebAuthn 身份验证、OTP 混淆和自动锁定来保护您的数据，最大程度保护您的隐私安全。

⁠二、支持的版本(Tag)

由于版本比较多,这里只列出最新的5个版本,更详细的版本列表请参考:可用版本列表⁠

• latest⁠
• 5.0.2-20240115⁠
• 4.1.0-20230818⁠
• 3.4.2-20230208⁠
• 3.4.1-20221129⁠
• 3.4.0-20221021⁠

⁠三、获取镜像

推荐从 Docker Hub Registry⁠ 拉取我们构建好的官方Docker镜像。

docker pull easysoft/2fauth:latest

如需使用指定的版本，可以拉取一个包含版本标签的镜像，在Docker Hub仓库中查看 可用版本列表⁠

docker pull easysoft/2fauth:[TAG]

⁠四、持久化数据

如果你删除容器，所有的数据都将被删除，下次运行镜像时会重新初始化数据。为了避免数据丢失，你应该为容器提供一个挂在卷，这样可以将数据进行持久化存储。

为了数据持久化，你应该挂载持久化目录：

• /data 持久化数据

如果挂载的目录为空，首次启动会自动初始化相关文件

$ docker run -it \
    -v $PWD/data:/data \
docker pull easysoft/2fauth:latest

或者修改 docker-compose.yml 文件，添加持久化目录配置

services:
  2FAuth:
  ...
    volumes:
      - /path/to/gogs-persistence:/data
  ...

⁠五、环境变量

2FAuth提供了很多可配置的环境变量，详情可参考文档⁠，这里介绍邮件相关的环境变量：

示例:

...
-e MAIL_HOST=smtp.example.com
-e MAIL_PORT=587
-e [email protected]
-e [email protected]
-e MAIL_PASSWORD=password1234

⁠六、运行

⁠6.1 单机Docker-compose方式运行

# 启动服务
make run

# 查看服务状态
make ps

# 查看服务日志
docker-compose logs -f 2fauth

说明:

• 启动成功后，打开浏览器输入 http://<你的IP>:8000 访问管理后台。
• 建议添加https证书，否则部分功能无法正常使用。
• VERSION⁠ 文件中详细的定义了Makefile可以操作的版本。
• docker-compose.yml⁠。

⁠七、版本升级

容器镜像已为版本升级做了特殊处理，当检测数据（数据库/持久化文件）版本与镜像内运行的程序版本不一致时，会进行数据库结构的检查，并自动进行数据库升级操作。

因此，升级版本只需要更换镜像版本号即可：

...
  2fauth:
-    image: easysoft/2fauth:3.3.0-20220916
+    image: easysoft/2fauth:3.4.0-20221021
    container_name: 2fauth
...

更新服务

# 是用新版本镜像更新服务
docker-compose up -d

# 查看服务状态和镜像版本
docker-compose ps