Envisaged 项目常见问题解决方案

Envisaged 项目常见问题解决方案

Envisaged Envisaged - Effortless Gource Visualizations with Docker 项目地址: https://gitcode.com/gh_mirrors/en/Envisaged

1. 项目基础介绍和主要编程语言

Envisaged 是一个基于 Docker 的 Gource 可视化工具。Gource 是一个用来展示 Git 仓库历史变化的命令行工具，Envisaged 将其与 FFmpeg 结合，生成高清视频（最高支持 4K 60fps）来展示仓库的发展进程。该项目的目的是让数据可视化变得更加简单，无需复杂的配置即可在任何机器上运行，包括标准的 EC2 实例或其他 VPS。Envisaged 项目主要使用 Dockerfile 进行容器化，使用 Shell 脚本进行配置和操作，主要的编程语言是 Python（用于生成 Dockerfile 和脚本）。

2. 新手常见问题及解决步骤

问题一：如何运行 Envisaged 容器生成视频？

问题描述： 新手用户不知道如何启动 Envisaged 容器，以及如何生成视频。

解决步骤：

1. 确保已安装 Docker 环境。
2. 使用以下命令运行 Envisaged 容器，以默认设置生成 Docker 仓库的视频：

   docker run --rm -p 8080:80 --name envisaged
   

3. 视频生成后，可以通过浏览器访问 http://localhost:8080/ 观看。

问题二：如何指定不同的 Git 仓库进行可视化？

问题描述： 用户想要可视化自己的 Git 仓库，但不知道如何指定仓库 URL。

解决步骤：

1. 在运行容器时，使用 -e 参数指定 GIT_URL 环境变量，值为你的 Git 仓库 URL。

   docker run --rm -p 8080:80 --name envisaged -e GIT_URL=你的仓库URL
   

2. 确保你的 Git 仓库是公开的，或者使用私人仓库时已正确设置认证。

问题三：如何自定义视频的样式？

问题描述： 用户想要修改视频的样式，例如添加边框或者更改输出格式。

解决步骤：

1. Envisaged 使用“模板”脚本来生成特定的样式。如果想要运行带有边框的视频，可以不进行任何修改，因为默认的模板就是 border。
2. 如果想要正常运行 Gource 输出，不添加任何边框，可以在运行容器时添加 -e TEMPLATE=none 参数：

   docker run --rm -p 8080:80 --name envisaged -e TEMPLATE=none
   

3. 如果需要进一步的定制，可以修改容器内的 template 脚本或者创建自己的脚本，然后挂载到容器中。

Envisaged Envisaged - Effortless Gource Visualizations with Docker 项目地址: https://gitcode.com/gh_mirrors/en/Envisaged