StreamCap offers multiple versions of installation packages to meet the needs of different users. Here’s a guide to choosing the right version for you.

• StreamCap_xxx_Win_x64.zip
  • Includes FFmpeg: This version includes precompiled FFmpeg and is suitable for most users. If you are unsure whether FFmpeg is already installed on your system, it is recommended to download this version.
• StreamCap_xxx_Win_x64_noFF.zip
  • Excludes FFmpeg: If your system already has FFmpeg installed and the environment variables are configured, you can choose this version. This version does not include FFmpeg, which reduces the size of the installation package.

• StreamCap_xxx_mac_universal.dmg
  • Includes FFmpeg: This version includes precompiled FFmpeg and is suitable for most users. If you are unsure whether FFmpeg is already installed on your system, it is recommended to download this version.
• StreamCap_xxx_mac_universal_noFF.dmg
  • Excludes FFmpeg: If your system already has FFmpeg installed and the environment variables are configured, you can choose this version. This version does not include FFmpeg, which reduces the size of the installation package.

📝 Note: The initial startup may be slower, so please be patient while the interface initializes.

1. After downloading, extract the .zip file.
2. Double-click the StreamCap.exe file to launch the program.

1. After downloading, double-click the .dmg file.
2. Drag the StreamCap.app package into the Applications folder on the right.
3. Open the installed program from the Applications folder.

🔧 Troubleshooting:

If macOS users encounter an error message saying "StreamCap" is damaged and can't be opened. You should move it to the Trash, please follow these steps to resolve the issue:

1. Open the Terminal and enter the following command, then press Enter. You will be prompted to enter your password. After entering the password, press Enter again:

   sudo spctl --master-disable

   After completing the above steps, open System Settings > Privacy & Security > Security, and change the setting to "Allow apps downloaded from: Anywhere". Then, try to open the damaged application again. If a message appears saying "Apple cannot verify that "StreamCap.app" does not contain malware that may harm your Mac or compromise your privacy.", go back to System Settings > Privacy & Security > Security. A "Open Anyway" button will appear. Click it and continue clicking "Open Anyway" to proceed.

2. For macOS versions below 15, if the application still shows the "damaged" message, enter the following command in the Terminal and press Enter:

   sudo xattr -rd com.apple.quarantine /Applications/StreamCap.app

3. Try to open the damaged StreamCap application again.

If you need to run StreamCap from the source code, please follow the steps below:

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

pip install -i https://pypi.org/simple streamget

# Or install the development version (latest code)
pip install git+https://github.com/ihmily/streamget.git

• Core dependencies are essential for the project to run, regardless of whether you are running the client or the web version.

• Install Desktop Dependencies (for local client operation):

  pip install -r requirements.txt

• Install Web Dependencies (for web operation):

  pip install -r requirements-web.txt

Important Notes:

• Core dependencies are mandatory, regardless of whether you are running the client or the web version.
• If you need to run desktop functionality, install desktop dependencies; if you need to run web functionality, install web dependencies. Choose one based on your use case.

python main.py

• Default operation on local port 6006:

  python main.py --web

• Custom host and port:

  python main.py --web --host 0.0.0.0 --port 8000

• Using the .env file for configuration:

  • Copy the .env.example file to .env:

    cp .env.example .env

  • Modify the default settings in the .env file.

• Automatic FFmpeg Installation:
  • The program will automatically prompt you to install FFmpeg when it starts. If the automatic installation is successful, no further action is required.
• Manual FFmpeg Installation (if automatic installation fails):
  • If automatic installation fails or you prefer to install manually, visit the FFmpeg Official Download Page to download and install.
  • Ensure the FFmpeg executable path is added to the system environment variables.

No Python environment is required on your local machine. Before running the commands, ensure that your machine has Docker and Docker Compose installed.

1.Quick Start

The simplest method is to use docker compose. Navigate to the project root directory and execute the following command (ensure the .env file exists):

docker compose up

You can use the -d option to run in the background. Note that the container uses the Asia/Shanghai timezone by default; you can modify this in the .env file if needed.

2.Stopping Container Instances

docker compose stop

3.Building Images (Optional)

If you need to run the latest code from the main branch of this repository, you can build a custom image locally:

docker build -t streamcap .

• Importance of FFmpeg: StreamCap relies on FFmpeg to process video streams. If you choose a version that does not include FFmpeg, please ensure that FFmpeg is correctly installed on your system and the environment variables are configured.
• Environment Variable Configuration: If FFmpeg is installed on your system but the environment variables are not set, the program may not run properly. Please ensure that the path to the FFmpeg executable is added to your system's environment variables.
• Version Compatibility: Ensure that your operating system version is compatible with the downloaded installation package version.

We welcome anyone to participate in the development and improvement of StreamCap! If you encounter any issues or have suggestions for improvement, please feel free to submit them on GitHub Issues.