Skip to content

Commit 0ad0f4a

Browse files
Merge branch 'master' into amarantmeida-patch-4
2 parents e2c5371 + 385aa3c commit 0ad0f4a

File tree

14 files changed

+332
-61
lines changed

14 files changed

+332
-61
lines changed

docs/guides/clustering-and-scaling/kubernetes/kubernetes-services/installing-ams-on-aws-eks.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,95 +13,105 @@ You need to have the [AWS CLI software](https://docs.aws.amazon.com/cli/latest/u
1313

1414
## Step 1: Navigate to EKS Service
1515

16-
After logging into AWS, search for the **EKS** service and find the **Elastic Kubernetes Service,** then click the **Add Cluster > Create** button.
16+
After logging into AWS, search for the **EKS** service and find the **Elastic Kubernetes Service,** then click the **Create Cluster** button and Select **Custom Configuration**.
1717

18-
![image.png](@site/static/img/aws-eks/aws-eks-1.png)
18+
![image.png](https://github.com/user-attachments/assets/5100a760-00a0-41c0-899f-0eeadafd63bc)
1919

2020
* * *
2121

2222
## Step 2: Name the Kubernetes Cluster
2323

24-
After setting a name for the cluster, the Kubernetes version and Cluster Service Role should be selected. You can follow this link to create a [Cluster Service Role](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html).
24+
After setting a name for the cluster, Cluster IAM Role should be selected. Then choose the Kubernetes version. You can follow this link to create a [Cluster Service Role](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html).
25+
26+
27+
![image.png](https://github.com/user-attachments/assets/8d39835b-8ebf-4df4-ab69-ff88d19fdc1b)
2528

26-
![image.png](@site/static/img/aws-eks/aws-eks-2.png)
2729

2830
* * *
2931

3032
## Step 3: Configure Networking
3133

32-
In this section, subnets under VPC and VPC should be selected and a security group should be created.
34+
In this section, subnets under VPC should be selected and a security group should be created.
35+
36+
![image.png](https://github.com/user-attachments/assets/731ff942-e566-457c-95b7-de640f02fe09)
3337

34-
![image.png](@site/static/img/aws-eks/aws-eks-3.png)
3538

3639
* * *
3740

3841
## Step 4: Optionally Setup Logging
3942

4043
You can activate the following options for logging.
4144

42-
![image.png](@site/static/img/aws-eks/aws-eks-4.png)
45+
![image.png](https://github.com/user-attachments/assets/cc62d1d8-3cd1-4f2d-b9a3-eebcd1f87190)
46+
4347

4448
* * *
4549

4650
## Step 5: Select add-ons
4751

4852
Follow this step with default selections.
4953

50-
![image.png](@site/static/img/aws-eks/aws-eks-5.png)
54+
![image.png](https://github.com/user-attachments/assets/f553f9bd-34f0-4455-8c4f-1e3c96481d49)
55+
5156

5257
* * *
5358

54-
## Step 6: Select add-ons
59+
## Step 6: Configure add-on Settings
5560

5661
Follow this step with default selections.
5762

58-
![image.png](@site/static/img/aws-eks/aws-eks-6.png)
63+
![image.png](https://github.com/user-attachments/assets/0e5b9c7b-3e0c-42e5-a2a5-3720936ea96e)
64+
5965

6066
* * *
6167

6268
## Step 7: Create the Cluster
6369

6470
Let’s confirm the configurations have been set correctly and create the cluster by clicking the **Create** button.
6571

66-
![image.png](@site/static/img/aws-eks/aws-eks-7.png)
72+
73+
6774

6875
* * *
6976

7077
## Step 8: Create a Node Group
7178

7279
When your cluster’s status is changed from pending to active, click on the **Configuration > Compute** tab and click on the **Add Node Group** button.
7380

74-
![image.png](@site/static/img/aws-eks/aws-eks-8-1.png)
81+
![image.png](https://github.com/user-attachments/assets/b650ca44-b77d-4568-975e-28cd2ee124f2)
82+
7583

7684
* * *
7785

7886
Type your node name and create the [Node IAM Role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html).
7987

80-
![image.png](@site/static/img/aws-eks/aws-eks-8-2.png)
88+
![image.png](https://github.com/user-attachments/assets/f0e20712-6e8f-4ed3-ae60-a07f626290ab)
89+
8190

8291
* * *
8392

8493
## Step 9: Scaling Configure
8594

8695
Click on the **Next** button after you configure the scaling of the **AMI type, Capacity type, Instance type, Disk and Node Group**.
8796

88-
![image.png](@site/static/img/aws-eks/aws-eks-9.png)
97+
![image.png](https://github.com/user-attachments/assets/0d969172-ea61-4404-a1e4-7e1e37de7379)
98+
8999

90100
* * *
91101

92102
## Step 10: Select Subnets
93103

94104
Select your subnets and click on the **Next** button.
95105

96-
![image.png](@site/static/img/aws-eks/aws-eks-10.png)
106+
![image.png](https://github.com/user-attachments/assets/d3c3f032-9043-452f-81ac-9112670b849a)
107+
97108

98109
* * *
99110

100111
## Step 11: Create the Node Pool
101112

102113
Finally, after checking the configurations, create the Node Pool by clicking on the **Create** button.
103114

104-
![image.png](@site/static/img/aws-eks/aws-eks-11.png)
105115

106116
* * *
107117

docs/guides/developing-antmedia-server/circle-component-usage.md

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,65 @@ title: Circle App Component Usage
33
description: Embedding Circle Conference Application into webpage
44
keywords: [Conference Application, Circle App, component usage, Ant Media Server Documentation, Ant Media Server Tutorials]
55
sidebar_position: 5
6-
76
---
87

98
# Circle App Component Usage
109

11-
Circle is a self-hosted, open source video conferencing software solution built by Ant Media. It can be deployed anywhere, both locally or in the cloud.
10+
[Circle](https://github.com/ant-media/conference-call-application) is a self-hosted, open source video conferencing solution built by Ant Media that can be deployed anywhere.
11+
12+
Locally or in the cloud. It delivers high quality video with ultra-low latency and supports up to 200 participants per room. If you're concerned about **privacy** or operating behind a **firewall**, this is the ideal solution.
13+
14+
This guide shows you how to integrate Circle's frontend component into your existing web application, allowing you to embed a complete video conferencing interface directly into your webpage so users can join conferences without leaving your app.
15+
16+
17+
## Prerequisites
18+
19+
- **Ant Media Enterprise Edition**
20+
- **Node.js**: v20 LTS version
21+
- **NPM**: v9 or higher
1222

13-
It offers the highest quality with the lowest latency, and it can accommodate up to 200 participants. If you are concerned about Privacy or being behind a firewall, this is the best solution for you.
23+
## Integration Steps
1424

15-
This documentation will explain how you can integrate the Circle application into any existing webpage.
25+
1. Clone the [conference-call-application](https://github.com/ant-media/conference-call-application) repository:
26+
```bash
27+
git clone https://github.com/ant-media/conference-call-application.git
28+
```
1629

30+
2. Navigate to the react directory and install dependencies:
31+
```bash
32+
cd conference-call-application/react
33+
npm install --legacy-peer-deps
34+
```
1735

36+
3. Build the application:
37+
```bash
38+
npm run build
39+
```
1840

19-
1. Clone [conference-call-application](https://github.com/ant-media/conference-call-application) repository.
20-
2. Install Node v20 LTS version and NPM v9
21-
3. Open terminal and go to react folder
22-
4. Run ```npm install``` command
23-
5. Run ```npm run build``` command
24-
6. Go to build folder inside react folder
25-
7. Copy static folder, into your web application's path
26-
8. Open the HTML page that you wanted to add Circle App.
27-
9. Add CSS and JS files that we copy from conference-call-application/react/build folder into HTML header. NOTE: File names will change after every build process.
41+
4. Copy static assets:
42+
- Go to the `build` folder inside the `react` directory
43+
- Copy the entire `static` folder to your web application's public path
2844

29-
```html
30-
<script defer="defer" src="./static/js/main.9c1bebc8.js"></script>
31-
<link href="./static/css/main.24ed3d1e.css" rel="stylesheet" />
32-
```
45+
5. Include CSS and JS files in your HTML header:
46+
```html
47+
<script defer="defer" src="./static/js/main.9c1bebc8.js"></script>
48+
<link href="./static/css/main.24ed3d1e.css" rel="stylesheet" />
49+
```
50+
**Note**: File names change with each build. Check the actual filenames in your build folder.
3351

34-
10. Add following div element into the section that you wanted to add Circle App
52+
6. Add the Circle component container to your webpage:
53+
```html
54+
<div id="root"
55+
data-room-name="<room_name>"
56+
data-websocket-url="wss://<ip_address>:<port>/<application_name>/websocket"
57+
style="background-color: #001D1A; box-sizing: border-box; height: 480px; width: 640px; position: relative;">
58+
</div>
59+
```
3560

36-
```html
37-
<div id="root" data-room-name="<room_name>" data-websocket-url="wss://<ip_address>:<port>/<application_name>/websocket" style="background-color: #001D1A; box-sizing: border-box; height: 480; width: 640; position: relative;"></div>
38-
```
61+
7. Configure the parameters:
62+
- Replace `<room_name>` with your desired room identifier
63+
- Replace `<ip_address>` with your Ant Media Server IP address
64+
- Replace `<port>` with your server port (typically 5443 for HTTPS)
65+
- Replace `<application_name>` with your application name
3966

40-
11. Replace `room_name`, `ip_address`, `port` and `application_name` variables and it's ready to use.
67+
That's it! The Circle conference component will now render within your application, allowing users to join video conferences directly from your webpage.
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Install with Docker Compose
3+
description: AMS Docker Compose Installation
4+
keywords: [Docker, Docker Compose, Ant Media Server Documentation, Ant Media Server Tutorials]
5+
sidebar_position: 7
6+
---
7+
8+
To install the Ant Media Server standalone server using Docker Compose, follow the below step-by-step process.
9+
10+
## 1. Download Docker File and Docker Compose File
11+
12+
```bash
13+
wget https://raw.githubusercontent.com/ant-media/Scripts/master/docker/docker-compose.yml
14+
wget https://raw.githubusercontent.com/ant-media/Scripts/master/docker/Dockerfile_Process -O Dockerfile
15+
```
16+
17+
## 2. Build Docker Image
18+
19+
Download and save the Ant Media Server ZIP file in the same directory as the Dockerfile and Docker Compose file. Then run the docker compose build command from the command line.
20+
21+
The AMS image will be created with name `antmedia-antmedia`.
22+
23+
#### Enterprise Edition:
24+
25+
You can get the AMS Enterprise Edition Zip file from your [Ant Media account](https://antmedia.io) after purchasing the license.
26+
27+
For example, if the zip file name is `ant-media-server-enterprise-2.14.0-20250513_1544.zip`
28+
29+
```bash
30+
docker-compose build --build-arg AntMediaServer=ant-media-server-enterprise-2.14.0-20250513_1544.zip
31+
```
32+
33+
#### Community Edition:
34+
35+
You can get the AMS Community Edition Zip file from the Ant Media Server [GitHub release page](https://github.com/ant-media/Ant-Media-Server/releases).
36+
37+
For example, if the zip file name is `ant-media-server-community-2.14.0.zip`
38+
39+
```bash
40+
docker-compose build --build-arg AntMediaServer=ant-media-server-community-2.14.0.zip
41+
```
42+
43+
## 3. Run Docker Container
44+
45+
Now we have a Docker image with Ant Media Server. Run the Docker container with the below command:
46+
47+
```bash
48+
docker-compose up -d
49+
```
50+
51+
:::info
52+
By default, it uses the host network ports to reach but for example, in Mac OS, the⁣ `network=host` does not work so you can define the ports in the YML file.
53+
:::
54+
55+
```yml
56+
version: "3.9"
57+
services:
58+
antmedia:
59+
build:
60+
context: ./
61+
dockerfile: ./Dockerfile
62+
container_name: antmedia
63+
restart: unless-stopped
64+
entrypoint: /usr/local/antmedia/start.sh
65+
ports:
66+
- "5080:5080"
67+
- "1935:1935"
68+
```
69+
70+
## 4. Volume
71+
72+
**Optional:** If you would like to mount an existing volume, simply uncomment the below lines in the original yml file.
73+
74+
:::info
75+
Please make sure that the indentation/alignment of the YML file content is correct; otherwise, it will cause issues
76+
:::
77+
78+
```bash
79+
network_mode: host
80+
volumes:
81+
- antmedia_vol:/usr/local/antmedia/
82+
volumes:
83+
antmedia_vol:
84+
external: true
85+
name:
86+
antmedia_volume
87+
```
88+
89+
After making the changes, run the same docker compose up command to run the container.
90+
91+
## AMS Dashboard
92+
93+
After the Docker container starts, reach out to `http://localhost:5080` or `http://host-IP:5080` to access the Ant Media Server dashboard.
94+
95+
![](@site/static/img/docker-installation.webp)
96+
97+
Check out [here](https://antmedia.io/docs/guides/publish-live-stream/webrtc/) to publish a WebRTC stream for testing.

0 commit comments

Comments
 (0)