# edumeet **Repository Path**: wanglg008/edumeet ## Basic Information - **Project Name**: edumeet - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-04-15 - **Last Updated**: 2025-04-28 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ![edumeet logo](/app/public/images/logo.edumeet.svg) **WebRTC meeting service using [mediasoup](https://mediasoup.org).** Official website: [edumeet.org](https://edumeet.org) https://user-images.githubusercontent.com/37835902/152279867-639db9bc-bf78-430f-b96f-d17733527474.mp4 Try it online at [letsmeet.no](https://letsmeet.no) ## Main features | Feature | Description | | ------------- | ------------- | | **A/V streaming** | Share your microphone and camera + additional video stream | | **Video layouts** | Choose between **Democratic** and **Filmstrip** views. More in progress. | | **Screen sharing** | Share your screen to make some presentation right from your desktop | | **File sharing** | Share your files with the peers (torrent solution under the hood) | | **Chat messages** | Text conversation with other participants | | **Local Recording** | Record window/tab/screen content in browser supported formats with room audio and save them (**disabled by default**) | | **Authentication** | Supported types: **OIDC**, **SAML**, **local db (text-based)** | ### Internationalization (22 languages)
Help us with translations:exclamation: #### How to contribute? 1. Continue to translate existing [language file](/app/src/intl/translations) 2. find the _null_ values > "settings.language": null, 3. replace them based on the _en.json_ file > "settings.language": "Select language", 4. If your language is not listed, create a new translation _.json_ file.. > copy en.json to [_"two letter country code"_.json](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) and translate to your languange 5. make a Pull Request, or send us a file by [e-mail](mailto:community@lists.edumeet.org) Thank you in advance!
### Local Recording
See more * Local Recording records the browser window video and audio. From the list of media formats that your browser supports you can select your preferred media format in the settings menu advanced video menu setting. MediaRecorder makes small chucks of recording and these recorded blob chunks temporary stored in IndexedDB, if IndexedDB implemented in your browser. Otherwise it stores blobs in memory in an array of blobs. Local Recording creates a local IndexedDB with the name of the starting timestamp (unix timestamp format) And a storage called chunks. All chunks read in an array and created a final blob that you can download. After blobs array concatenation as a big blob, this big blob saved as file, and finally we delete the temporary local IndexedDB. * Local recording is **disabled** by default. It could be enabled by setting _localRecordingEnabled_ to true in (./app/public/config/config.js) * **WARNING**: Take care that local recording will increase cpu, memory and disk space consumption. **Enough free disk space has to be provided!!!** Keep in mind that Browsers don't allow to use all the disk free capacity! See more info about browsers storage limits: * *
# Installation See here for [Docker](https://github.com/edumeet/edumeet-docker/) or [Ansible](https://github.com/edumeet/edumeet-ansible/) (based on Docker) installation procedures ## Debian & Ubuntu based operating systems (.deb package) * Prerequisites: Installed NodeJS (v16.x) as described in [Manual installation](#manual-installation-build) section. * See [Configuration](#configuration) section for client and server configuration details. * Download from [releases](https://github.com/edumeet/edumeet/releases) assets, or latest job [artifact](https://github.com/edumeet/edumeet/actions?query=workflow%3ADeployer+branch%3Amaster+is%3Asuccess). ```bash # Unzip the file unzip edumeet.zip # Install the package sudo apt install edumeet/edumeet.deb # After package installation, don't forget to edit configuration files. sudo nano /etc/educonf/client-config.js sudo nano /etc/educonf/server-config.js sudo nano /etc/educonf/server-config.yaml # Finally, start the service by (it's enabled by default) sudo systemctl start edumeet ``` ## Manual installation (build) Installation example is based on Debian/Ubuntu Linux operating system. 1. Install [NodeJS (v16.x)](https://github.com/nodesource/distributions) and [Yarn ](https://classic.yarnpkg.com/en/docs/install#debian-stable) package manager - NodeJS (v16.x) [Debian/Ubuntu](https://github.com/nodesource/distributions#deb) ```bash # Using Ubuntu curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - sudo apt-get install -y nodejs # Using Debian, as root curl -fsSL https://deb.nodesource.com/setup_16.x | bash - apt-get install -y nodejs ``` - Yarn package manager: ```bash curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list sudo apt update && sudo apt install yarn ``` 2. Install all required dependencies ```bash sudo apt update && sudo apt install -y curl git python python3-pip build-essential redis openssl libssl-dev pkg-config ``` 3. Clone eduMEET git repository ```bash git clone https://github.com/edumeet/edumeet.git cd edumeet ``` (switch to the "develop" branch to get the latest features) ```bash git checkout develop ``` ### Configuration **eduMEET** will start and run normally with just default settings. If there is no configuration files, it will automatically detect your host IP address, and listen on port 443 (https). In order to change default values (e.g. certificates), or activate features (e.g. authentication), use appropriate configuration file (see below for details). **:warning: Note:** There are separate configuration files for eduMEET application and eduMEET server: **eduMEET application (app)** for: enabling login, change logo or background, adjust A/V parameters, etc... Copy [example](/app/public/config/config.example.js) template and edit values (see all available parameters in [./app/public/config/README.md](/app/public/config/README.md)) ```bash cp app/public/config/config.example.js app/public/config/config.js ``` **eduMEET server** require **:warning:two** configuration files: **config.js**, and **config.{_json_, _yaml_ or _toml_}** (multiple format supported) **1. config.js** for setting authentication methods and user roles. Copy example template and edit values (see additional details in [example](/server/config/config.example.js) file) ```bash cp server/config/config.example.js server/config/config.js ``` **2. config.{_json_, _yaml_ or _toml_}** for configuring: server port, server certificates, [STUN/TURN](#turn-configuration) configuration, monitoring, etc... (See below examples of different configuration styles). [**:point_right: _config.yaml_**](/server/config/config.example.yaml) example: ```yaml listeningPort: 443 tls: key: /opt/edumeet/server/certs/privkey.pem cert: /opt/edumeet/server/certs/cert.pem ``` [**:point_right: _config.json_**](/server/config/config.example.json) example: ```javascript { "listeningPort" : "443", "tls" : { "cert" : "/opt/edumeet/server/certs/cert.pem", "key" : "/opt/edumeet/server/certs/privkey.pem" } } ``` [**:point_right: _config.toml_**](/server/config/config.example.toml) example: ```toml listeningPort = "443" [tls] cert = "/opt/edumeet/server/certs/cert.pem" key = "/opt/edumeet/server/certs/privkey.pem" ``` **:red_circle: IMPORTANT:** Use **only one** type for second configuration file (`yaml` file format is highly recommended) Copy **only one** example template file and edit values (see all available parameters in [./server/config/README.md](/server/config/README.md)) ```bash cp server/config/config.example.yaml server/config/config.yaml OR!!! cp server/config/config.example.json server/config/config.json OR!!! cp server/config/config.example.toml server/config/config.toml ``` **:warning: NOTE:** application and server components **has to be rebuild** if configuration parameter is changed ([see build steps](#manual-installation-build)). Rebuild is not necessary for Docker or Debian (.deb) version, just restart container/service. ### Build **Note:** It is highly recommended to use _yarn_ package manager. ```bash cd app yarn && yarn build cd ../server yarn && yarn build ``` ### Run **Run on server** (as root or with sudo) ```bash # Run the Node.js server application in a terminal: cd server sudo yarn start ``` **Run locally** (for development) * The newest build is always in **develop branch** if you want to make a contribution/pull request use it instead of master branch. ```bash # run a live build from app folder: app$ yarn start # and run server in server folder: server$ yarn start ``` Note: To avoid running server as root, redirects privileged ports with firewall rules: ```bash #adjust ports to your needs sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-ports 8443 sudo iptables -t nat -A OUTPUT -p tcp --dport 443 -o lo -j REDIRECT --to-port 8443 sudo iptables -t nat -A PREROUTING -p tcp --dport 3443 -j REDIRECT --to-ports 8443 sudo iptables -t nat -A OUTPUT -p tcp --dport 3443 -o lo -j REDIRECT --to-port 8443 # make it persistent sudo apt install iptables-persistent sudo iptables-save > /etc/iptables/rules.v4 sudo ip6tables-save > /etc/iptables/rules.v6 ``` * Test your service in a webRTC enabled browser: `https://yourDomainOrIPAdress:3443/roomname` **Run as a service** (systemd) ```bash # Stop your locally running server. Copy systemd-service file `edumeet.service` to `/etc/systemd/system/` and check location path settings: cp edumeet.service /etc/systemd/system/ # modify the install paths, if required sudo edit /etc/systemd/system/edumeet.service # Reload systemd configuration and start service: sudo systemctl daemon-reload sudo systemctl start edumeet # If you want to start edumeet at boot time: sudo systemctl enable edumeet ``` ## Ports and firewall | Port | protocol | description | | ---- | ----------- | ----------- | | 443 | tcp | default https webserver and signaling - adjustable in `server/config/config.yaml`) | | 4443 | tcp | default `yarn start` port for developing with live browser reload, not needed in production environments - adjustable in app/package.json) | | 40000-49999 | udp, tcp | media ports - adjustable in `server/config/config.yaml` | ## Load balanced installation To deploy this as a load balanced cluster, have a look at [HAproxy](/docs/HAproxy.md). ## Learning management integration To integrate with an LMS (e.g. Moodle), have a look at [LTI](LTI/LTI.md). ## TURN configuration If you are part of the GEANT eduGAIN, you can request your turn api key at [https://turn.geant.org/](https://turn.geant.org/) You need an additional [TURN](https://github.com/coturn/coturn)-server for clients located behind restrictive firewalls! Add your server and credentials to `server/config/config.yaml` ## Community-driven support | Type | | | ----------- | ----------- | | Open mailing list | community@lists.edumeet.org | | Subscribe | lists.edumeet.org/sympa/subscribe/community/ | | Open archive | lists.edumeet.org/sympa/arc/community/ | ## Authors * Håvar Aambø Fosstveit * Stefan Otto * Mészáros Mihály * Roman Drozd * Rémai Gábor László * Piotr Pawałowski This started as a fork of the [work](https://github.com/versatica/mediasoup-demo) done by: * Iñaki Baz Castillo [[website](https://inakibaz.me)|[github](https://github.com/ibc/)] ## License MIT License (see `LICENSE.md`) Contributions to this work were made on behalf of the GÉANT project, a project that has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant Agreement No. 731122 (GN4-2). On behalf of GÉANT project, GÉANT Association is the sole owner of the copyright in all material which was developed by a member of the GÉANT project. GÉANT Vereniging (Association) is registered with the Chamber of Commerce in Amsterdam with registration number 40535155 and operates in the UK as a branch of GÉANT Vereniging. Registered office: Hoekenrode 3, 1102BR Amsterdam, The Netherlands. UK branch address: City House, 126-130 Hills Road, Cambridge CB2 1PQ, UK.