Skip to content

安装指南

Hmily edited this page Jul 21, 2025 · 8 revisions

📦 StreamCap 安装指南

🌟 普通用户

StreamCap 提供了多种版本的安装包,以满足不同用户的需求。以下是选择适合你的版本的指南。

🎯 选择适合你的安装包

Windows 用户

  • StreamCap_xxx_Win_x64.zip
    • 包含 FFmpeg:此版本包含预编译的 FFmpeg,适合大多数用户。如果你不确定是否已经安装了 FFmpeg,建议下载此版本。
  • StreamCap_xxx_Win_x64_noFF.zip
    • 不包含 FFmpeg:如果你的系统已经安装了 FFmpeg,并且配置了环境变量,可以选择此版本。此版本不包含 FFmpeg,可以减少安装包大小。

macOS 用户

  • StreamCap_xxx_mac_universal.dmg
    • 包含 FFmpeg:此版本包含预编译的 FFmpeg,适合大多数用户。如果你不确定是否已经安装了 FFmpeg,建议下载此版本。
  • StreamCap_xxx_mac_universal_noFF.dmg
    • 不包含 FFmpeg:如果你的系统已经安装了 FFmpeg,并且配置了环境变量,可以选择此版本。此版本不包含 FFmpeg,可以减少安装包大小。

📝 说明:初次运行启动较慢,请耐心等待界面初始化。

🚀 运行程序

Windows 用户

  1. 下载完成后,解压 .zip 压缩包。
  2. 双击 StreamCap.exe 文件即可启动程序。

macOS 用户

  1. 下载完成后,双击 .dmg 文件。
  2. 将里面的 StreamCap.app 包拖进右边的应用文件夹。
  3. 在应用启动台找到并打开安装的程序。

🔧 遇到问题

如果 macOS 用户启动程序时,提示 "StreamCap" 已损坏无法打开,你应该将它移到废纸篓,可以按照以下步骤解决:

  1. 在终端输入以下命令并回车,随后会提示输入密码,输入开机密码后回车:

    sudo spctl --master-disable

    按照上述步骤操作完成后,打开「系统设置」-「隐私与安全性」-「安全性」,修改为「任何来源」,然后尝试再次打开已损坏的应用。如果显示「Apple无法验证“StreamCap.app”是否 包含可能危害Mac安全或泄漏隐私的恶意软件。」此时再回到「隐私与安全性」-「安全性」设置,会出现一个「仍要打开」按钮,点击后继续点击「仍要打开」即可。

  2. 对于macOS 15以下的系统,仍然提示“已损坏”,继续输入以下命令并按回车:

    sudo xattr -rd com.apple.quarantine /Applications/StreamCap.app
  3. 再次尝试打开提示损坏的StreamCap应用程序。


😼 高级用户指南

如果你需要从源代码运行 StreamCap,请参考以下步骤:

🛠️ 从源代码运行

1. 克隆项目代码

git clone https://github.com/ihmily/StreamCap.git
cd StreamCap

2. 安装依赖

必须安装的核心依赖
# 正式版
pip install -i https://pypi.org/simple streamget

# 或者 安装开发版(最新代码)
pip install git+https://github.com/ihmily/streamget.git
  • 核心依赖是项目运行的基础,无论你选择运行客户端还是 Web 端,都必须安装。
根据需求选择的依赖
  • 安装桌面端依赖(用于本地客户端运行):

    pip install -r requirements.txt
  • 安装 Web 端依赖(用于 Web 端运行):

    pip install -r requirements-web.txt

重要说明

  • 核心依赖是必须安装的,无论你选择运行客户端还是 Web 端。
  • 如果你需要运行桌面端功能,请安装桌面端依赖;如果需要运行 Web 端功能,请安装 Web 端依赖。两者根据你的使用场景选择其一。

3. 运行程序

客户端运行(仅支持 Windows/macOS)
python main.py
Web 端运行
  • 默认运行在本地 6006 端口:

    python main.py --web
  • 自定义运行主机和端口:

    python main.py --web --host 0.0.0.0 --port 8000
  • 使用 .env 文件配置:

    • 复制 .env.example 文件到 .env

      cp .env.example .env
    • 修改 .env 文件中的默认配置。

4. 安装 FFmpeg

  • 自动安装 FFmpeg

    • 程序启动后会自动弹出组件安装界面,其中包含 FFmpeg。如果自动安装成功,您无需手动安装。
  • 手动安装 FFmpeg(如果自动安装失败):

    • 如果自动安装失败,或者您需要手动安装,请访问 FFmpeg 官方下载页面 下载并安装。
    • 确保 FFmpeg 的可执行文件路径已添加到系统的环境变量中。

🐋容器运行

本机无需Python环境运行,在运行命令之前,请确保您的机器上安装了 DockerDocker Compose

1.快速启动

最简单方法是使用docker compose运行,进入项目根目录后,只需简单执行以下命令(确保已经存在.env文件):

docker compose up

可选 -d 在后台运行。注意容器内时区问题,默认使用的是 Asia/Shanghai ,如需修改可以在.env文件配置。

2.停止容器实例

docker compose stop

3.构建镜像(可选)

Docker仓库中的镜像的代码版本不一定是最新的,如有需要运行本仓库主分支最新代码,可以本地自定义构建

docker build -t streamcap .

📝 注意事项

  • FFmpeg 的重要性:StreamCap 依赖 FFmpeg 来处理视频流。如果你选择下载不包含 FFmpeg 的版本,请确保你的系统中已经正确安装了 FFmpeg,并且配置了环境变量。
  • 环境变量配置:如果你的系统已安装 FFmpeg,但未配置环境变量,程序可能无法正常运行。请确保 FFmpeg 的可执行文件路径已添加到系统的环境变量中。
  • 版本兼容性:请确保你的操作系统版本与下载的安装包版本兼容。

🤝 贡献指南

欢迎任何人参与 StreamCap 的开发和改进!如果你遇到任何问题,或者有改进建议,请随时在 GitHub Issues 提交问题或建议。