neoris/openvidu-local-deployment
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor grammar changes in comments and user-facing messages

Browse Source
This commit is contained in:
Juan Navarro 2024-05-30 13:40:02 +02:00
parent d1d124f99b
commit 58d50db061
No known key found for this signature in database
12 changed files with 35 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored
View File

@ -1 +1 @@
* text=auto eol=lf * text=auto eol=lf

2
.gitignore vendored
View File

@ -3,4 +3,4 @@ community/minio/
community/mongo/ community/mongo/
pro/egress/ pro/egress/
pro/minio/ pro/minio/
pro/mongo/ pro/mongo/

4
README.md
View File

@ -1,5 +1,5 @@
# OpenVidu Local Deployment # OpenVidu Local Deployment
Docker compose to run OpenVidu locally for development purposes Docker Compose files to run OpenVidu locally for development purposes.
## Requirements ## Requirements
On **Windows** and **MacOS**: On **Windows** and **MacOS**:
@ -82,4 +82,4 @@ cd openvidu-local-deployment/pro
```sh ```sh
docker compose up docker compose up
``` ```

11
community/.env
View File

@ -1,17 +1,16 @@
# Configure here the private IP of your machine # Configure here the private IP of your machine.
# It is used by the Media Server to announce it self # It is used by the Media Server to announce itself
# and to configure LAN_MODE ip address # and to configure the LAN_MODE IP address.
LAN_PRIVATE_IP= LAN_PRIVATE_IP=
# Expose OpenVidu with HTTPS. # Expose OpenVidu with HTTPS.
USE_HTTPS=true USE_HTTPS=true
# If true, you can access OpenVidu through your LAN # If true, you can access OpenVidu through your LAN.
# If true, USE_HTTPS must be true # If true, USE_HTTPS must also be true.
LAN_MODE=true LAN_MODE=true
# LiveKit API Key and Secret. # LiveKit API Key and Secret.
LIVEKIT_API_KEY=devkey LIVEKIT_API_KEY=devkey
LIVEKIT_API_SECRET=secret LIVEKIT_API_SECRET=secret

2
community/custom-layout/index.html
View File

@ -6,6 +6,6 @@
<title>Recording custom layout</title> <title>Recording custom layout</title>
</head> </head>
<body> <body>
Create here your custom layout Create here your custom layout.
</body> </body>
</html> </html>

10
community/egress.yaml
View File

@ -9,10 +9,10 @@ api_secret: secret
ws_url: ws://openvidu:7880 ws_url: ws://openvidu:7880
health_port: 9091 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 backup_storage: /home/egress/backup_storage
# Storage for recordings # Storage for recordings.
s3: s3:
access_key: minioadmin access_key: minioadmin
secret: minioadmin secret: minioadmin
@ -22,9 +22,9 @@ s3:
bucket: openvidu bucket: openvidu
force_path_style: true force_path_style: true
# CPU cost for each type of Egress operation # CPU cost for each type of Egress operation.
# Default is setted for unlimited operations # Defaults are set for unlimited operations.
# Change these values according to your needs # Change these values according to your needs.
cpu_cost: cpu_cost:
max_cpu_utilization: 0.99 max_cpu_utilization: 0.99
room_composite_cpu_cost: 0.01 room_composite_cpu_cost: 0.01

2
community/scripts/ready-check.sh
View File

@ -48,7 +48,7 @@ echo '========================================='
echo '🎉 OpenVidu is ready! 🎉' echo '🎉 OpenVidu is ready! 🎉'
echo '=========================================' echo '========================================='
echo '' echo ''
echo 'OpenVidu Server && LiveKit Server URLs:' echo 'OpenVidu Server & LiveKit Server URLs:'
echo '' echo ''
echo ' - From this machine:' echo ' - From this machine:'
echo '' echo ''

8
community/scripts/setup.sh
View File

@ -3,14 +3,14 @@
if [ -z "$LAN_PRIVATE_IP" ]; then if [ -z "$LAN_PRIVATE_IP" ]; then
echo '------------------------' echo '------------------------'
echo '' echo ''
echo 'LAN_PRIVATE_IP is required in .env file' echo 'LAN_PRIVATE_IP is required in the .env file.'
echo 'Depending on your OS, you can run the following command to get your LAN private IP:' echo 'Depending on your OS, you can run the following command to set your LAN private IP:'
echo '' echo ''
echo ' - Linux: ./configure_lan_private_ip_linux.sh' echo ' - Linux: ./configure_lan_private_ip_linux.sh'
echo ' - MacOS: ./configure_lan_private_ip_macos.sh' echo ' - MacOS: ./configure_lan_private_ip_macos.sh'
echo ' - Windows: .\configure_lan_private_ip_windows.bat' echo ' - Windows: .\configure_lan_private_ip_windows.bat'
echo '' 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 'If it can'\''t be found, you can manually set it in the .env file'
echo '------------------------' echo '------------------------'
exit 1 exit 1
@ -30,4 +30,4 @@ chown 1001:1001 /minio /minio/data
chown 1001:1001 /mongo /mongo/data chown 1001:1001 /mongo /mongo/data
chown 1001:1001 /egress chown 1001:1001 /egress
chown 1001:1001 /egress/home chown 1001:1001 /egress/home
chown 1001:1001 /egress/home/egress chown 1001:1001 /egress/home/egress

11
pro/.env
View File

@ -1,17 +1,16 @@
# Configure here the private IP of your machine # Configure here the private IP of your machine.
# It is used by the Media Server to announce it self # It is used by the Media Server to announce itself
# and to configure LAN_MODE ip address # and to configure the LAN_MODE IP address.
LAN_PRIVATE_IP= LAN_PRIVATE_IP=
# Expose OpenVidu with HTTPS. # Expose OpenVidu with HTTPS.
USE_HTTPS=true USE_HTTPS=true
# If true, you can access OpenVidu through your LAN # If true, you can access OpenVidu through your LAN.
# If true, USE_HTTPS must be true # If true, USE_HTTPS must also be true.
LAN_MODE=true LAN_MODE=true
# LiveKit API Key and Secret. # LiveKit API Key and Secret.
LIVEKIT_API_KEY=devkey LIVEKIT_API_KEY=devkey
LIVEKIT_API_SECRET=secret LIVEKIT_API_SECRET=secret

10
pro/egress.yaml
View File

@ -9,10 +9,10 @@ api_secret: secret
ws_url: ws://openvidu:7880 ws_url: ws://openvidu:7880
health_port: 9091 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 backup_storage: /home/egress/backup_storage
# Storage for recordings # Storage for recordings.
s3: s3:
access_key: minioadmin access_key: minioadmin
secret: minioadmin secret: minioadmin
@ -22,9 +22,9 @@ s3:
bucket: openvidu bucket: openvidu
force_path_style: true force_path_style: true
# CPU cost for each type of Egress operation # CPU cost for each type of Egress operation.
# Default is setted for unlimited operations # Defaults are set for unlimited operations.
# Change these values according to your needs # Change these values according to your needs.
cpu_cost: cpu_cost:
max_cpu_utilization: 0.99 max_cpu_utilization: 0.99
room_composite_cpu_cost: 0.01 room_composite_cpu_cost: 0.01

2
pro/scripts/ready-check.sh
View File

@ -48,7 +48,7 @@ echo '========================================='
echo '🎉 OpenVidu is ready! 🎉' echo '🎉 OpenVidu is ready! 🎉'
echo '=========================================' echo '========================================='
echo '' echo ''
echo 'OpenVidu Server && LiveKit Server URLs:' echo 'OpenVidu Server & LiveKit Server URLs:'
echo '' echo ''
echo ' - From this machine:' echo ' - From this machine:'
echo '' echo ''

8
pro/scripts/setup.sh
View File

@ -3,14 +3,14 @@
if [ -z "$LAN_PRIVATE_IP" ]; then if [ -z "$LAN_PRIVATE_IP" ]; then
echo '------------------------' echo '------------------------'
echo '' echo ''
echo 'LAN_PRIVATE_IP is required in .env file' echo 'LAN_PRIVATE_IP is required in the .env file.'
echo 'Depending on your OS, you can run the following command to get your LAN private IP:' echo 'Depending on your OS, you can run the following command to set your LAN private IP:'
echo '' echo ''
echo ' - Linux: ./configure_lan_private_ip_linux.sh' echo ' - Linux: ./configure_lan_private_ip_linux.sh'
echo ' - MacOS: ./configure_lan_private_ip_macos.sh' echo ' - MacOS: ./configure_lan_private_ip_macos.sh'
echo ' - Windows: .\configure_lan_private_ip_windows.bat' echo ' - Windows: .\configure_lan_private_ip_windows.bat'
echo '' 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 'If it can'\''t be found, you can manually set it in the .env file'
echo '------------------------' echo '------------------------'
exit 1 exit 1
@ -30,4 +30,4 @@ chown 1001:1001 /minio /minio/data
chown 1001:1001 /mongo /mongo/data chown 1001:1001 /mongo /mongo/data
chown 1001:1001 /egress chown 1001:1001 /egress
chown 1001:1001 /egress/home chown 1001:1001 /egress/home
chown 1001:1001 /egress/home/egress chown 1001:1001 /egress/home/egress