Safemobile/mediasoup
21
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

LINXD-2842: Update README

Browse Source
This commit is contained in:
Sergiu Toma 2025-03-04 17:01:54 +02:00
parent fc39d5bead
commit fc250c248e
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -9,17 +9,22 @@
### Development ### Development
##### To start in development mode you must: ##### To start in development mode you must:
1. Install the dependencies `npm install`. 1. Install the dependencies `npm install`.
2. Go to the linx-devops project and run the `create_certificate_for_domain.sh` script from `private-system-trusted-cert`, it expects an ip/domain as the first argument. 2. Go to the `linx-devops/scaling-tools/private-system-truste-cert` project and generate a new server certificate and key:
ex: `sh create_certificate_for_domain.sh 192.168.1.199`
(Use your private IP-address) sh create_certificate_for_domain.sh 192.168.1.110 #local IP
# generates files
nginx-selfsigned.crt
device.key
3. You need to update the Video Server in the provisioning to point to your private IP. ex: https://192.168.1.199:3000 3. You need to update the Video Server in the provisioning to point to your private IP. ex: https://192.168.1.199:3000
4. The generated files must be moved to server/ssl and renamed as follows: 4. The generated files must be moved to server/ssl and renamed as follows:
- device.key -> key.pem
- nginx-selfsigned.crt -> cert.pem cp device.key {mediasoup_project}/server/ssl/key.pem
cp nginx-selfsigned.crt {mediosup_project}/server/ssl/cert.pem
5. Go to https://dev.linx.safemobile.com/dispatcher/resources/help/LINXHelp.html#safemobile-certificate-import and import the certificate for your system type 5. Go to https://dev.linx.safemobile.com/dispatcher/resources/help/LINXHelp.html#safemobile-certificate-import and import the certificate for your system type
@ -33,22 +38,22 @@
##### To start in production mode you must: ##### To start in production mode you must:
1. Install the dependencies `npm install`. 1. Install the dependencies `npm install`.
2. Run the `npm start:prod` command to start the server in production mode. 2. Run the `npm start:prod` command to start the server in production mode.
(To connect to the terminal, use `pm2 log video-server`) (To connect to the terminal, use `pm2 log video-server`)
### Web client ### Web client
- The server will start by default on port 3000, and the ssl certificates will have to be configured - The server will start by default on port 3000, and the ssl certificates will have to be configured
- The web client can be accessed using the /sfu path - The web client can be accessed using the /sfu path
ex: https://HOST/sfu/?assetId=1&&accountId=1&producer=true&dest_asset_id=75&assetName=Adi ex: https://HOST/sfu/?assetId=1&&accountId=1&producer=true&dest_asset_id=75&assetName=Adi
assetId = asset id of the unit on which you are doing the test assetId = asset id of the unit on which you are doing the test
accountId = account id of the unit on which you are doing the test accountId = account id of the unit on which you are doing the test
producer = it will always be true because you are the producer producer = it will always be true because you are the producer
(it's possible to put false, but then you have to have another client with producer true) (it's possible to put false, but then you have to have another client with producer true)
assetName = asset name of the unit on which you are doing the test assetName = asset name of the unit on which you are doing the test
dest_asset_id= the addressee with whom the call is made dest_asset_id= the addressee with whom the call is made
- To make a call using this client, you need a microphone and permission to use it - To make a call using this client, you need a microphone and permission to use it
- For any changes related to the client, the command `npm run watch' will have to be used to generate the bundle.js used by the web client - For any changes related to the client, the command `npm run watch' will have to be used to generate the bundle.js used by the web client
### Demo project ### Demo project
The demo project used initially and then modified for our needs `https://github.com/jamalag/mediasoup2` The demo project used initially and then modified for our needs `https://github.com/jamalag/mediasoup2`