diff --git a/.gitattributes b/.gitattributes index 94f480d..6313b56 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -* text=auto eol=lf \ No newline at end of file +* text=auto eol=lf diff --git a/.gitignore b/.gitignore index bba95a6..ecb7515 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,4 @@ community/minio/ community/mongo/ pro/egress/ pro/minio/ -pro/mongo/ \ No newline at end of file +pro/mongo/ diff --git a/README.md b/README.md index 678c6c5..1e2e1b5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # OpenVidu Local Deployment -Docker compose to run OpenVidu locally for development purposes +Docker Compose files to run OpenVidu locally for development purposes. ## Requirements On **Windows** and **MacOS**: @@ -82,4 +82,4 @@ cd openvidu-local-deployment/pro ```sh docker compose up -``` \ No newline at end of file +``` diff --git a/community/.env b/community/.env index e718637..dbd5872 100644 --- a/community/.env +++ b/community/.env @@ -1,17 +1,16 @@ -# Configure here the private IP of your machine -# It is used by the Media Server to announce it self -# and to configure LAN_MODE ip address +# Configure here the private IP of your machine. +# It is used by the Media Server to announce itself +# and to configure the LAN_MODE IP address. LAN_PRIVATE_IP= # Expose OpenVidu with HTTPS. USE_HTTPS=true -# If true, you can access OpenVidu through your LAN -# If true, USE_HTTPS must be true +# If true, you can access OpenVidu through your LAN. +# If true, USE_HTTPS must also be true. LAN_MODE=true - # LiveKit API Key and Secret. LIVEKIT_API_KEY=devkey LIVEKIT_API_SECRET=secret diff --git a/community/custom-layout/index.html b/community/custom-layout/index.html index fbb8350..5e3cbd0 100644 --- a/community/custom-layout/index.html +++ b/community/custom-layout/index.html @@ -6,6 +6,6 @@ Recording custom layout - Create here your custom layout + Create here your custom layout. diff --git a/community/egress.yaml b/community/egress.yaml index 97ca26b..5c5d740 100644 --- a/community/egress.yaml +++ b/community/egress.yaml @@ -9,10 +9,10 @@ api_secret: secret ws_url: ws://openvidu:7880 health_port: 9091 -# files will be moved here when uploads fail. +# Files will be moved here when uploads fail. backup_storage: /home/egress/backup_storage -# Storage for recordings +# Storage for recordings. s3: access_key: minioadmin secret: minioadmin @@ -22,9 +22,9 @@ s3: bucket: openvidu force_path_style: true -# CPU cost for each type of Egress operation -# Default is setted for unlimited operations -# Change these values according to your needs +# CPU cost for each type of Egress operation. +# Defaults are set for unlimited operations. +# Change these values according to your needs. cpu_cost: max_cpu_utilization: 0.99 room_composite_cpu_cost: 0.01 diff --git a/community/scripts/ready-check.sh b/community/scripts/ready-check.sh index 994c256..ff57f0a 100644 --- a/community/scripts/ready-check.sh +++ b/community/scripts/ready-check.sh @@ -48,7 +48,7 @@ echo '=========================================' echo '🎉 OpenVidu is ready! 🎉' echo '=========================================' echo '' -echo 'OpenVidu Server && LiveKit Server URLs:' +echo 'OpenVidu Server & LiveKit Server URLs:' echo '' echo ' - From this machine:' echo '' diff --git a/community/scripts/setup.sh b/community/scripts/setup.sh index 1c270b8..ed9a439 100644 --- a/community/scripts/setup.sh +++ b/community/scripts/setup.sh @@ -3,14 +3,14 @@ if [ -z "$LAN_PRIVATE_IP" ]; then echo '------------------------' echo '' - echo 'LAN_PRIVATE_IP is required in .env file' - echo 'Depending on your OS, you can run the following command to get your LAN private IP:' + echo 'LAN_PRIVATE_IP is required in the .env file.' + echo 'Depending on your OS, you can run the following command to set your LAN private IP:' echo '' echo ' - Linux: ./configure_lan_private_ip_linux.sh' echo ' - MacOS: ./configure_lan_private_ip_macos.sh' echo ' - Windows: .\configure_lan_private_ip_windows.bat' echo '' - echo 'The script will automatically update the .env file with the LAN_PRIVATE_IP' + echo 'The script will automatically update the .env file with the LAN_PRIVATE_IP.' echo 'If it can'\''t be found, you can manually set it in the .env file' echo '------------------------' exit 1 @@ -30,4 +30,4 @@ chown 1001:1001 /minio /minio/data chown 1001:1001 /mongo /mongo/data chown 1001:1001 /egress chown 1001:1001 /egress/home -chown 1001:1001 /egress/home/egress \ No newline at end of file +chown 1001:1001 /egress/home/egress diff --git a/pro/.env b/pro/.env index e718637..dbd5872 100644 --- a/pro/.env +++ b/pro/.env @@ -1,17 +1,16 @@ -# Configure here the private IP of your machine -# It is used by the Media Server to announce it self -# and to configure LAN_MODE ip address +# Configure here the private IP of your machine. +# It is used by the Media Server to announce itself +# and to configure the LAN_MODE IP address. LAN_PRIVATE_IP= # Expose OpenVidu with HTTPS. USE_HTTPS=true -# If true, you can access OpenVidu through your LAN -# If true, USE_HTTPS must be true +# If true, you can access OpenVidu through your LAN. +# If true, USE_HTTPS must also be true. LAN_MODE=true - # LiveKit API Key and Secret. LIVEKIT_API_KEY=devkey LIVEKIT_API_SECRET=secret diff --git a/pro/egress.yaml b/pro/egress.yaml index 97ca26b..5c5d740 100644 --- a/pro/egress.yaml +++ b/pro/egress.yaml @@ -9,10 +9,10 @@ api_secret: secret ws_url: ws://openvidu:7880 health_port: 9091 -# files will be moved here when uploads fail. +# Files will be moved here when uploads fail. backup_storage: /home/egress/backup_storage -# Storage for recordings +# Storage for recordings. s3: access_key: minioadmin secret: minioadmin @@ -22,9 +22,9 @@ s3: bucket: openvidu force_path_style: true -# CPU cost for each type of Egress operation -# Default is setted for unlimited operations -# Change these values according to your needs +# CPU cost for each type of Egress operation. +# Defaults are set for unlimited operations. +# Change these values according to your needs. cpu_cost: max_cpu_utilization: 0.99 room_composite_cpu_cost: 0.01 diff --git a/pro/scripts/ready-check.sh b/pro/scripts/ready-check.sh index 994c256..ff57f0a 100644 --- a/pro/scripts/ready-check.sh +++ b/pro/scripts/ready-check.sh @@ -48,7 +48,7 @@ echo '=========================================' echo '🎉 OpenVidu is ready! 🎉' echo '=========================================' echo '' -echo 'OpenVidu Server && LiveKit Server URLs:' +echo 'OpenVidu Server & LiveKit Server URLs:' echo '' echo ' - From this machine:' echo '' diff --git a/pro/scripts/setup.sh b/pro/scripts/setup.sh index 1c270b8..ed9a439 100644 --- a/pro/scripts/setup.sh +++ b/pro/scripts/setup.sh @@ -3,14 +3,14 @@ if [ -z "$LAN_PRIVATE_IP" ]; then echo '------------------------' echo '' - echo 'LAN_PRIVATE_IP is required in .env file' - echo 'Depending on your OS, you can run the following command to get your LAN private IP:' + echo 'LAN_PRIVATE_IP is required in the .env file.' + echo 'Depending on your OS, you can run the following command to set your LAN private IP:' echo '' echo ' - Linux: ./configure_lan_private_ip_linux.sh' echo ' - MacOS: ./configure_lan_private_ip_macos.sh' echo ' - Windows: .\configure_lan_private_ip_windows.bat' echo '' - echo 'The script will automatically update the .env file with the LAN_PRIVATE_IP' + echo 'The script will automatically update the .env file with the LAN_PRIVATE_IP.' echo 'If it can'\''t be found, you can manually set it in the .env file' echo '------------------------' exit 1 @@ -30,4 +30,4 @@ chown 1001:1001 /minio /minio/data chown 1001:1001 /mongo /mongo/data chown 1001:1001 /egress chown 1001:1001 /egress/home -chown 1001:1001 /egress/home/egress \ No newline at end of file +chown 1001:1001 /egress/home/egress