Skip to content

Deploy on Google Colab 🚀

Google Colab

Free, convenient, and hassle-free, ideal for users with limited device performance. Highly recommended~

Want to try local deployment? Jump to the 《Local Installation》 section.

What is Colab?

With Colaboratory (short for Colab), you can write and execute Python code in your browser, and:

  • No configuration required
  • Free GPU usage
  • Easy sharing

Whether you are a student, data scientist, or AI researcher, Colab can help you work more efficiently. You can watch Introduction to Colab or Colab Features You May Have Missed to learn more, or get started below!

WARNING

Note: Requires VPN access.

Installation Steps

1. Clone and Download

bash
# Default directory
%cd /content

# Remove files
%rm -rf /content/CreatorBox/

# Clone repository
!git clone https://github.com/xiesx123/CreatorBox.git

# Install dependencies
!pip install --use-deprecated=legacy-resolver -r /content/CreatorBox/src/support/third_party/cosyvoice/requirements.txt
!pip install --use-deprecated=legacy-resolver -r /content/CreatorBox/requirements.txt

# Install software
!pip install pyngrok
!curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \
  | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \
  && echo "deb https://ngrok-agent.s3.amazonaws.com buster main" \
  | sudo tee /etc/apt/sources.list.d/ngrok.list \
  && sudo apt update \
  && sudo apt install ngrok \
  && sudo apt install rubberband-cli \
  && sudo apt install jq

2. Environment Variables

TIP

For environment variable configuration, see the 《Preparation》 section.

3. Start and Run

bash
# Working directory
%cd /content/CreatorBox

# Clear logs
%rm -rf logs run.out

# Kill process
!kill -9 $(lsof -t -i:80)

# Start application without tunneling
# !nohup python run.py start -p 80 > run.out 2>&1 & 

# Start application with tunneling `-nh is your Host address`
!nohup python run.py start -p 80 -nh 'toucan-real-informally.ngrok-free.app' --ngrok > run.out 2>&1 &

4. Verify Startup

bash
# Check if started successfully
!curl -s http://127.0.0.1:80/app/version | jq .
bash
# Check if proxy is working
!curl -s https://toucan-real-informally.ngrok-free.app/app/version | jq .
response.json
json
{
  "code": 0,
  "message": "success",
  "data": {
  "title": "CreatorBox",
  "description": "🚀🎬灵活、高效、可扩展,专属视频剪辑配音工具箱,释放创作潜力",
  "version": "1.0.7",
  "debug": true
  }
}

Real-time Logs

bash
!tail -f /content/CreatorBox/run.out

As shown in the figure, successful output indicates successful startup.

log
_____                _            ______
/  __ \              | |           | ___ \
| /  \/_ __ ___  __ _| |_ ___  _ __| |_/ / _____  __
| |   | '__/ _ \/ _` | __/ _ \| '__| ___ \/ _ \ \/ /
| \__/\ | |  __/ (_| | || (_) | |  | |_/ / (_) >  < 
\____/_|  \___|\__,_|\__\___/|_|  \____/ \___/_/\_\   v1.0.7

2025-04-08 11:34:52.458 | INFO 1496 task.py:18 - Startup Scheduler 1 Job Completed.
2025-04-08 11:34:52.458 | INFO 1496 main.py:84 - Started CreatorBox Run Debug Success (6.16 seconds)
2025-04-08 11:34:52.459 | INFO 1496 main.py:85 - http://172.18.0.1:8000

TIP

Colab can only execute one cell at a time. After successful startup, you can view real-time logs.

Internal and External Tunneling

log
To be added

INFO

If the above error occurs during startup, go to the Ngrok Dashboard at https://dashboard.ngrok.com/agents.

Stop the running proxy and re-execute step 3 above.