Skip to content

Local Deployment 🔧

Run locally

Just want to try it out? Jump to the section 《Remote Deployment

Requirements

  • Operating System: Windows10+, MacOS 11+, Debian12+
  • Supported Architectures: windows.x86_64, linux.x86_64, darwin_x86_64
  • Recommended Minimum: CPU 4 cores or more, Memory 8GB or more, GPU is optional, supports cpu or cuda

Prerequisites

  • Ensure your network is functioning properly, and VPN should be set to global traffic mode
  • Do not install Conda in Chinese paths or paths with spaces to avoid unexpected issues

TIP

For virtual environment setup, see 《Preparation

Installation Steps

1. Clone the repository

bash
git clone https://github.com/xiesx123/CreatorBox.git

2. Virtual environment

  • Create a virtual environment
bash
conda create --name creatorbox python=3.11.11
  • Activate the virtual environment
bash
conda activate creatorbox

3. Install dependencies

  • Optional
bash
pip install -r src/support/third_party/cosyvoice/requirements.txt
pip install -r src/support/third_party/f5_tts/requirements.txt
  • Required *
bash
pip install -r requirements.txt

4. Start and Run

bash
python run.py start

Note

  • 1、For Windows systems, double-click run.bat to run.

  • 2、If the download is slow, you may need to change the mirror source:

bash
pip config set install.trusted-host pypi.tuna.tsinghua.edu.cn
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple/
pip config list

Access the Interface

  • Local access: http://127.0.0.1:8000

  • Internal access: http://172.18.0.1:8000 (actual address may vary) 👇

    log
     _____                _            ______
    /  __ \              | |           | ___ \
    | /  \/_ __ ___  __ _| |_ ___  _ __| |_/ / _____  __
    | |   | '__/ _ \/ _` | __/ _ \| '__| ___ \/ _ \ \/ /
    | \__/\ | |  __/ (_| | || (_) | |  | |_/ / (_) >  < 
     \____/_|  \___|\__,_|\__\___/|_|  \____/ \___/_/\_\   v1.0.8
    
    2025-03-27 11:34:52.458 | INFO 1496 task.py:18 - Startup Scheduler 2 Job Completed.
    2025-03-27 11:34:52.458 | INFO 1496 main.py:84 - Started CreatorBox Run Debug Success (3.16 seconds)
    2025-03-27 11:34:52.459 | INFO 1496 main.py:85 - http://172.18.0.1:8000