Official website: edumeet.org

Try it online at letsmeet.no

See here for Docker or Ansible (based on Docker) installation procedures

• Prerequisites: Installed NodeJS (v16.x) as described in Manual installation section.
• See Configuration section for client and server configuration details.
• Download from releases assets, or latest job artifact.

# 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

Installation example is based on Debian/Ubuntu Linux operating system.

1. Install NodeJS (v16.x) and Yarn package manager

• NodeJS (v16.x) Debian/Ubuntu

# 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:

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

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

git clone https://github.com/edumeet/edumeet.git
cd edumeet

(switch to the "develop" branch to get the latest features)

git checkout develop 

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).

⚠️ 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 template and edit values (see all available parameters in ./app/public/config/README.md)

cp app/public/config/config.example.js app/public/config/config.js

eduMEET server require ⚠️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 file)

cp server/config/config.example.js server/config/config.js

2. config.{json, yaml or toml} for configuring: server port, server certificates, STUN/TURN configuration, monitoring, etc... (See below examples of different configuration styles).

👉 config.yaml example:

    listeningPort: 443
    tls:
        key:  /opt/edumeet/server/certs/privkey.pem
        cert: /opt/edumeet/server/certs/cert.pem

👉 config.json example:

    {
        "listeningPort" : "443",
        "tls" : {
            "cert" : "/opt/edumeet/server/certs/cert.pem",
            "key"  : "/opt/edumeet/server/certs/privkey.pem"
        }
    }

👉 config.toml example:

    listeningPort = "443"

    [tls]
    cert = "/opt/edumeet/server/certs/cert.pem"
    key = "/opt/edumeet/server/certs/privkey.pem"

🔴 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)

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

⚠️ NOTE: application and server components has to be rebuild if configuration parameter is changed (see build steps). Rebuild is not necessary for Docker or Debian (.deb) version, just restart container/service.

Note: It is highly recommended to use yarn package manager.

cd app
yarn && yarn build

cd ../server
yarn && yarn build

Run on server (as root or with sudo)

# 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.

# 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:

#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)

# 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

To deploy this as a load balanced cluster, have a look at HAproxy.

To integrate with an LMS (e.g. Moodle), have a look at LTI.

If you are part of the GEANT eduGAIN, you can request your turn api key at https://turn.geant.org/

You need an additional TURN-server for clients located behind restrictive firewalls! Add your server and credentials to server/config/config.yaml

• 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 done by:

• Iñaki Baz Castillo [website|github]

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.