Skip to content

README.md

Latest commit

 

History

History
126 lines (88 loc) · 3.29 KB

README.md

File metadata and controls

126 lines (88 loc) · 3.29 KB
Frappe Meet Logo

Frappe Meet

Simple, High Quality Video Conferencing

Frappe Meet screenshot

Warning

Frappe Meet is in beta and there might be few bugs!

Frappe Meet

Frappe Meet is a video conferencing app built with simplicity, quality, and reliability in mind.

Key Features

  • High-quality meetings: Low-latency, scalable multi-party video with adaptive streaming.
  • Meeting Management: Create meetings and control meeting access for guests, participants, or hosts.
  • Multimedia features: Features like background effects, noise suppression, and push-to-talk elevate the meeting experience.

Under the Hood

  • Mediasoup: Cutting Edge WebRTC Video Conferencing.
  • Frappe Framework: A full-stack web application framework.
  • Frappe UI: A Vue-based UI library, to provide a modern user interface.

Self-Hosting

Deploying Frappe Meet on your own server is quick and easy using our automated Docker Compose setup. For complete instructions, check out the Self-Hosting Guide.

Local Development

Prerequisites

Step 1: Set up the Backend

  1. In your frappe-bench directory, run the following commands in separate terminal sessions:

    # Terminal 1 - Start the Frappe server
cd frappe-bench
bench start

  2. Open a new terminal session for the remaining setup:

    cd frappe-bench
bench new-site meet.localhost
bench get-app meet
bench --site meet.localhost install-app meet
bench --site meet.localhost add-to-hosts
bench --site meet.localhost browse --user Administrator

Step 2: Set up the Frontend

  1. Open a new terminal session and navigate to the meet app:

    cd frappe-bench/apps/meet

  2. Install frontend dependencies and start the dev server:

    cd frontend
yarn install
yarn dev

Step 3: Set up the SFU Server

  1. Open a new terminal session and navigate to the SFU server:

    cd frappe-bench/apps/meet/sfu-server

  2. Copy the example environment file and configure it:

    cp .env.example .env

    Edit .env and set:

    • JWT_SECRET — must match sfu_secret in your Frappe site config

  3. Set the matching secret in Frappe site config:

    cd frappe-bench
bench --site meet.localhost set-config sfu_secret "your_secret"

  4. Install dependencies and start the SFU server:

    cd frappe-bench/apps/meet/sfu-server
yarn install
yarn dev

License

AGPL-3.0
⚡