Skip to content

Commit

Permalink
bump docusaurus v3
Browse files Browse the repository at this point in the history
  • Loading branch information
@jibon57
jibon57 committed Nov 1, 2023
1 parent 1da27a8 commit 27b5dda
Show file tree
Hide file tree
Showing 14 changed files with 15,175 additions and 203 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20.x

- name: Install dependencies
run: npm install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20.x

- name: Install dependencies
run: npm install
Expand Down
1 change: 0 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
.env.development.local
.env.test.local
.env.production.local
package-lock.json
yarn.lock

npm-debug.log*
Expand Down
4 changes: 2 additions & 2 deletions docs/api/analytics/fetch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ End point: `/analytics/fetch`
| :------------------ | --------------------------- | ---------- | :-------------------------- |
| status | boolean | root | The status of the request |
| msg | string | root | Response message |
| [result](#result) | object<[result](#result)> | root | |
| [result](#result) | object\<[result](#result)> | root | |

### Result

Expand All @@ -42,7 +42,7 @@ End point: `/analytics/fetch`
| from | number | Requested from point |
| limit | number | Requested limit of records |
| order_by | string | Record order |
| analytics_list | Array<[analytics-info](#analytics-info)> | |
| analytics_list | Array\<[analytics-info](#analytics-info)> | |

### Analytics info

Expand Down
4 changes: 2 additions & 2 deletions docs/api/recording/fetch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ End point: `/recording/fetch`
| :------------------ | --------------------------- | ---------- | :-------------------------- |
| status | boolean | root | The status of the request |
| msg | string | root | Response message |
| [result](#result) | object<[result](#result)> | root | |
| [result](#result) | object\<[result](#result)> | root | |

### Result

Expand All @@ -42,7 +42,7 @@ End point: `/recording/fetch`
| from | number | Requested from point |
| limit | number | Requested limit of records |
| order_by | string | Record order |
| [recordings_list](#recording-list) | Array<[recording_list](#recording-list)> | |
| [recordings_list](#recording-list) | Array\<[recording_list](#recording-list)> | |

### Recording list

Expand Down
2 changes: 1 addition & 1 deletion docs/api/room/create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ End point: `/room/create`
| :--------------------- | ------------------------------ | ------------------------- |
| status | boolean | The status of the request |
| msg | string | Response message |
| [roomInfo](#room-info) | object<[roomInfo](#room-info)> | |
| [roomInfo](#room-info) | object\<[roomInfo](#room-info)> | |

### Room Info

Expand Down
4 changes: 2 additions & 2 deletions docs/api/room/fetch-past.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ End point: `/room/fetchPastRooms`
| :------------------ | --------------------------- | ---------- | :-------------------------- |
| status | boolean | root | The status of the request |
| msg | string | root | Response message |
| [result](#result) | object<[result](#result)> | root | |
| [result](#result) | object\<[result](#result)> | root | |

### Result

Expand All @@ -42,7 +42,7 @@ End point: `/room/fetchPastRooms`
| from | number | Requested from point |
| limit | number | Requested limit of records |
| order_by | string | Record order |
| rooms_list | Array<[past-room-info](#past-room-info)> | |
| rooms_list | Array\<[past-room-info](#past-room-info)> | |

### Past Room info

Expand Down
6 changes: 3 additions & 3 deletions docs/api/room/room-info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ End point: `/room/getActiveRoomInfo`
| :-------------- | ----------------------- | ---------- | :-------------------------- |
| status | boolean | root | The status of the request |
| msg | string | root | Response message |
| [room](#room) | object<[room](#room)> | root | |
| [room](#room) | object\<[room](#room)> | root | |

### Room


| Field | Type | Description |
| :--------------------------------------- | ---------------------------------------------- | :------------------------------ |
| [room_info](#room-info) | object<[room_info](#room-info)> | |
| [participants_info](#participant-info) | array<[participant_info](#participant-info)> | Array of current participants |
| [room_info](#room-info) | object\<[room_info](#room-info)> | |
| [participants_info](#participant-info) | array\<[participant_info](#participant-info)> | Array of current participants |

### Room Info

Expand Down
2 changes: 1 addition & 1 deletion docs/api/room/rooms-info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ End point: `/room/getActiveRoomsInfo`
| :----- | ------- | -------- | :---------------------------------------------------------------------------------------- |
| status | boolean | root | The status of the request |
| msg | string | root | Response message |
| rooms | array<[room](/docs/api/room/room-info#room)> | root | Array of Room |
| rooms | array\<[room](/docs/api/room/room-info#room)> | root | Array of Room |
31 changes: 12 additions & 19 deletions docs/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,18 @@ In this article, we'll go over how simple it is to set up your own plugNmeet web

## Requirements

<ol>
<li> You'll need a clean <b>Ubuntu or Debian</b> server with a <b>public IP address</b>. <b>Ubuntu 22.04 LTS</b> recommended.</li>
<li> If your infrastructure is protected by a <b>firewall</b>, please first <a href="/docs/firewall">configure ports & firewall</a> before proceeding.</li>
<li> Ubuntu/Debian server does not come pre-installed with apache or nginx, or else the installation will fail.</li>
<li> <b>Hardware recommendation</b> for server:

It's really difficult to provide an estimate. It will depend on how you intend to use it. If you only intend to use plugNmeet with a few users, a smaller server will suffice. Still adhering to the minimum server requirements for production environment:
<ul>
<li> <b>CPU:</b> At least 4 cores. 8 cores or more, if installed with recorder. <b>Dedicated CPU</b> is recommended.</li>
<li> <b>RAM:</b> At least 4GB; 8GB or more, if installed with recorder.</li>
<li> <b>Storage:</b> Unless a recorder is also being used, plugNmeet doesn't consume much storage. </li>
<li> <b>Connection speed:</b> this is a crucial factor, a bandwidth of at least 100 Mbits/sec or greater.</li>
</ul></li>

<li> You'll need 2 subdomains that point to the public IP address of this Ubuntu/Debian server. One for plugNmeet main URL (example: <b>plugnmeet.example.com</b>); another for TURN server (example: <b>turn.example.com</b>).</li>
<li> A valid email address is also required to
generate a <a href="https://letsencrypt.org/">Let's Encrypt</a> SSL certificate.</li>

</ol>
- You'll need a clean **Ubuntu or Debian** server with a **public IP address**. **Ubuntu 22.04 LTS** recommended.
If your infrastructure is protected by a **firewall**, please first [configure ports & firewall](/docs/firewall) before proceeding.
- Ubuntu/Debian server does not come pre-installed with apache or nginx, or else the installation will fail.
- **Hardware recommendation** for server: It's really difficult to provide an estimate. It will depend on how you intend to use it. If you only intend to use plugNmeet with a few users, a smaller server will suffice. Still adhering to the minimum server requirements for production environment:

- **CPU:** At least 4 cores. 8 cores or more, if installed with recorder. **Dedicated CPU** is recommended.
- **RAM:** At least 4GB; 8GB or more, if installed with recorder.
- **Storage:** Unless a recorder is also being used, plugNmeet doesn't consume much storage.
- **Connection speed:** this is a crucial factor, a bandwidth of at least 100 Mbits/sec or greater.

- You'll need 2 subdomains that point to the public IP address of this Ubuntu/Debian server. One for plugNmeet main URL (example: **plugnmeet.example.com**); another for TURN server (example: **turn.example.com**).
- A valid email address is also required to generate a [Let's Encrypt](https://letsencrypt.org/) SSL certificate.

**_Note:_** If DNS fails for those 2 domains, the installation will be aborted.

Expand Down
159 changes: 0 additions & 159 deletions docusaurus.config.js
View file

This file was deleted.

Loading

0 comments on commit 27b5dda

Please sign in to comment.