CCTV YOLO

Introduction

Welcome to the CCTV YOLO! This project offers realtime object detection through HTTP protocol and cloudflare tunneling:

These predictions are based on yolov3-tiny trained on comprehensive coco datasets.

Getting Started

To get started with CCTV YOLO, follow these steps:

Prerequisites

Before using CCTV YOLO, ensure you have the following in requirements.txt and Python ≥ 3.9.5.

Installation

To install the CCTV YOLO, follow these steps:

1. Create a Virtual Environment:

   • On Windows:

     python -m venv .venv

   • On Linux:

     python3 -m venv .venv

2. Activate the Virtual Environment:

   • On Windows:

     .venv\Scripts\activate

   • On Linux:

     source .venv/bin/activate

3. Install Dependencies:

   pip install -r requirements.txt

4. Copy Environment Variables:

   cp .env.example .env
   

   Modify the values in the .env file according to your API configuration!

Start Server

Or you can just setup all and start the server directly according your operating systems.

• On Windows:

  ./start-server-windows.bat

• On Linux:

  ./start-server-linux.sh

About Cloudflared Tunneling

It's just optional feature where your CCTV+YOLO is hosted to the internet for free, here is you can setup the tunnel authentication through this DOC. Therefore you can retrieve information about your CF authentication so that you can put it into .env file.

Note: If you cloned this repo, you don't need download or install cloudflared since it's already downloaded in binary preinstalled in bin/ folder.

Support

If you encounter any issues or have questions, reach out to our support team at [email protected]

Contributing

We welcome contributions! Whether it's bug reports, feature requests, or code contributions.

License

CCTV YOLO is licensed under the MIT License - see the LICENSE file for details.