Installation on Linux

pre install checklist ensure you have at least 16gb of ram you may run int issues running the full development setup with less clone the repository to a location whose path contains no spaces install node js 22 (versions earlier than 22 are not guaranteed to work) install python >=3 6, pip https //pypi org/project/pip/ , c++, and other build tools see the https //mediasoup org/documentation/v3/mediasoup/installation/ for full details install docker optionally if you're not using docker, install mariadb, redis and minio manually and update repo's env local accordingly you should now be ready to follow the quick start /#quick start instructions clone the repository a lot has changed during development, and our monorepo has gotten quite large to avoid cloning everything, use this command git clone https //github com/ir engine/ir engine depth 1 ensure you are running node 22 the engine to date has only been confirmed to work with node 22 x earlier or later major versions are not guaranteed to work properly the best way to install and manage node js versions is by using a version manager install nvm https //github com/nvm sh/nvm install node js 22 with nvm install 22 (optional) make node js 22 your default node version with nvm alias default 22 note polyglot https //github com/asdf vm/asdf can also be used for managing node versions please check the output of node version before running the engine if you are using a node version below 22, please update or nothing will work you will know that you are having issues if you try to install packages at root with npm install and you get package dependency errors docker is your friend you don't need to use docker https //docs docker com/ , but it will make your life much easier if you don't wish to use docker, you will need to setup mariadb and redis on your machine you can find credentials in /scripts/docker compose yml quick start if you are lucky, this will just work however, you may encounter some issues make sure you are running node 22, and check your dependencies cd path/to/ir engine cp env local default env local npm install npm run dev docker npm run dev reinit npm run dev now run ir engine in your browser by navigating to https //localhost 3000/location/default https //localhost 3000/location/default accept certificates step 4 accept the certificates when accessing the ir engine for the first time, browsers block access due to self signed certificates this prevents you from accessing the admin panel and the editor to bypass this, manually accept the certificates open developer tools chrome/edge click the three dot menu → more tools → developer tools shortcut press ctrl+shift+i or f12 navigate to the console tab identify certificate related errors check for network request errors related to websocket connections ( wss\ // urls) https requests to localhost the following addresses require certificate approval https //localhost 3030 – api server https //localhost 8642 – file server bypass the security warning open these urls directly in your browser https //localhost 3030 https //localhost 3030https //localhost 8642 https //localhost 8642 a "your connection is not private" warning appears click advanced → proceed to localhost (unsafe) reload the engine’s website why bypassing security warnings? browsers block connections to self signed certificates by default to protect users from potentially unsafe sites for local development, it's safe to bypass these warnings, but only if you trust the source—like your own machine or your team's local environment once completed, the ir engine’s admin panel and editor will be fully accessible 🚀 admin system and user setup you can administrate many features from the admin panel found at the /admin route of your deployment eg https //localhost 3000/admin when working in a local deployment to give administration rights to a user open any page in your ir engine deployment open the user menu (icon at the top right of the screen) click on show api key copy that key to your clipboard (note there is an icon to the right of this box for this purpose) open a terminal and go to the folder where etherealengine was cloned run the command npm run make user admin id={copied user id} where copied user id is the key you just copied on the previous step example npm run make user admin id=c06b0210 453e 11ec afc3 c57a57eeb1ac image test user admin privileges by going to the /admin route of your deployment advanced installation and troubleshooting if you run into any trouble with the quick start instructions please make sure you've followed the mediasoup installation instructions https //mediasoup org/documentation/v3/mediasoup/installation/ check your os specific instructions installing on windows (10+) /windowsinstalling on mac os x /macosxinstallation troubleshooting /advanced/troubleshootingadvanced setup /advancedvite dev server is stalling https //vitejs dev/guide/troubleshooting html#dev server