Skip to content

README.md

Latest commit

 

History

History
83 lines (63 loc) · 3.62 KB

README.md

File metadata and controls

83 lines (63 loc) · 3.62 KB

MingSec Local Setup

This guide walks you through setting up the local MingSec system.

MingSec currently only runs on Windows, but it may be used on Mac/Linux with some adjustments.

Prerequisites

  • Python 3.8 or higher
  • A Dropbox account (if you don’t already have one)
  • (Recommended) GitBash (Some bash commands will look different if you are not using GitBash)
  • (Optional) A Linux device for a second camera
  • (Optional) Firebase account for notifications (if using the Kotlin notification app)

Installation Instructions

1. Create a Virtual Environment

Create and activate a virtual environment for Python:

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
venv\Scripts\activate

2. Install Required Dependencies

Install the required Python packages from requirements.txt:

pip install -r requirements.txt

3. Create a Dropbox Application

  1. Sign in to your Dropbox account.
  2. Create a new Dropbox app by following the instructions here.
  3. Note down the following credentials:
    • APP_KEY
    • APP_SECRET
    • REFRESH_TOKEN
  4. (Optional) If you plan to use separate credentials for read/write operations, create another app with appropriate permissions.
    • If you decide to use one application, use the same credentials for both apps in the .env file

4. Configure Environment Variables

Generate a .env file in the local folder with the following command:

winpty python dot_env_generator.py

Then, open the .env file and replace the placeholder values with your own credentials, including the Dropbox APP_KEY, APP_SECRET, and REFRESH_TOKEN.

5. (Optional) Copy to an External Linux Device

If you’re using a second camera connected to a Linux device, copy the external folder from your MingSec project directory to the target device. You can place the folder wherever is convenient, but make sure to update the EXTERNAL_DEVICE_PATH in your .env file to reflect the correct location. If you're not using a second camera, you can skip this step.

6. (Optional) Setup Firebase for Kotlin Notifications

  1. Create a Firebase project in the Firebase Console.
  • For help with setting up a Firebase project, click here
  1. Generate the service-account-file.json file for your project:
  • Go to the Firebase Console: Open your web browser and navigate to the Firebase Console.
  • Select your project: From the project list, select the project for which you need the service account file.
  • Open Project Settings: Click on the gear icon next to "Project Overview" in the top left corner and select "Project settings" from the dropdown menu.
  • Navigate to Service Accounts: In the Project settings, click on the "Service accounts" tab.
  • Generate a new private key:
    • Click the "Generate new private key" button.
    • A confirmation dialog will appear. Click "Generate Key".
  • Download the JSON file: The JSON file containing your service account credentials will be downloaded to your computer.
  1. Rename this file to ming_sec_firebase.json and save it in the Local folder (the same folder as main.py).
  2. Open the .env file and update the FIREBASE_PROJECT_ID (You can find your project id in the ming_sec_firebase.json file)

You can get the NOTIFICATION_DEVICE_TOKEN from the Kotlin app later.

Start MingSec

Run the following command to start MingSec:

winpty python main.py