Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marwa-benhassine committed Jul 11, 2023
1 parent a71c971 commit 38ca4d3
Show file tree
Hide file tree
Showing 79 changed files with 548 additions and 9 deletions.
4 changes: 2 additions & 2 deletions bbbeasy-backend/app/config/default.ini
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ view.default = website
log.keep = 14

; BigBlueButton
bbb.shared_secret = unsecure_shared_secret_to_change_immediately
bbb.server = unsecure_server_to_change_immediately
bbb.shared_secret =qo3ek2Ft1p8tuyFiLciTWXFGeTyxwkZ6XWqz6IiQMR8
bbb.server =https://bbb.riadvice.ovh/bigbluebutton/

webapps.allowed =

Expand Down
109 changes: 109 additions & 0 deletions bbbeasy-docs/guides/administrator-guide/Install step.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Install steps

`Tip` : If this is your first time using BBBeasy , it's primordially that you create an administrator account first in order to be able to use the application
The BBBeasy project work great in the browser .

# Administrator account
The administrator account consists of three steps :

__The first step__

* Create an administrator Account

__The second step__

* Fill the organization and branding fields

__The third step__

* Configure the BigBlueButton room settings

### Step 1 : Administrator Account
To create an administrator account , Please follow these steps

>1. Enter the Username(The username is used only once )
>2. Enter your Email(Your email must be personal and unique)
>3. Create Password (Type a GDPR compatible password during installation)
>4. Click on the Next button
![Admin](/img/admin.png)

## Step 2: Organization and branding

___Organization and branding are the best things for creating , design, and general look-and-feel of a company's branding___

`To identify the Organisation , you must fill in these fields `

1. Organisation name
2. Organisation website
3. Platform name
4. Terms of use URL
5. Privacy Policy URL

` Branding is very distinctive in that it defines logo,Brand color,Default font size,Border radius and Wireframe style to create organization and branding these fields must be filled out`
1. Upload the logo in the filed designated for the logo
2. Brand color
3. Default font size (increase or decrease the default font size)
4. Border radius
5. Wireframe style
6. Click on the Next button
![Organisation & Branding](/img/Organisation_branding_step2.png)


## Step3 BigBlueButton rooms settings :

BigBlueButton settings is the console to enable or disable BigBlueButton room settings .
Some of the key features of BBBeasy include :
* Audio,
* Branding
* Breakout Rooms
* General
* Guest policy
* Language
* Layout
* Learning Dashboard
* Lock Settings
* Recording
* Screenshare
* Security (Password for moderator & Password for attendee)
* Presentations with interactive and multi-share whiteboard capabilities – such as a pointer, zooming and drawing,
public and private chat,
* Breakout rooms,
* User Experience
* Webcams
* ZcaleRight

**An overview of some BigBlueButton room settings** :

1. Duration: set the duration of the meeting
2. Maximum participants: Maximum numbers of users that can join the room
3. Anyone can start the meeting: Anyone can start the room even he's not the room's owner
4. Join all as moderators: All the users join the meeting as Moderators
5. Allow only logged users: Only the logged in users will be able to join the room
>You can easily join a BigBlueButton meeting by opening the room link and click on the join button via a browser on your laptop or mobile phone.
## Finish
After enable/ disable the BigBlueButton room settings , Click on the' Finish' button .the application will be installed and you will be able to use the application

![Bigbluebutton room setting](/img/BigBlueButton_room_setting.png)
![Install](/img/Finish.png)





















2 changes: 2 additions & 0 deletions bbbeasy-docs/guides/administrator-guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ It is important to understand that BBBEasy installation have 2 stesp:
1. Install in the server: install of the packages by the system administrator.
2. Install from the web browser: configuration settings meant for creating the administrator account, branding and configuration of the presets.

**[Install](./Install step.md)**

### Server install

Installing BBBEasy happens through a single command line.
Expand Down
12 changes: 12 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Administration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Administration
The administration settings section is related to the registration method of users .The settings are set by default to inactive during the install , then we can modify them depending on the client requirements

___Edit the administration settings___

`To Edit the administration settings, you must follow the following steps`

1. Go to the Administration page.
2. Enable or disable the settings then save the changes .
3. The administration settings will be saved.

![Users](/img/administration.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

## Edit BigBlueButton rooms settings :

After already have the application installed , you can customize the BigBlueButton Room settings through the BigBlueButton view

`To Edit BigBlueButton room settings`

1. Go to the BigBlueButton page under the settings menu
2. Select one group from the preset setting groups
3. Enable/disable the BigBlueButton room settings needed for use then confirm the changes
4. The BigBlueButton room settings group will be updated with success


![Audio](/img/Audio.png)



















15 changes: 15 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Branding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Organization and branding

You can customize the organization and branding information after the install , during using the application


___Update the Organization & Branding settings ___

`To Edit the Organisation and branding settings , you must follow these steps `

1. Go to the Organization and branding page.
2. Edit the organization or branding settings then submit the changes.
3. the organization and branding settings will be saved.


![Organisation & Branding](/img/edit_branding.png)
27 changes: 27 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Details rooms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@

## Rooms Details

Room details on contains the entire room details (room informations , room presentations , room recordings)



___Room details___

1. Go to the Rooms page
2. Choose a room and click on it to access to the room details page

___Room Recordings section___

The room recordings contains all the recordings related to the specified room
This section after the end of the meeting

___Room presentations section___

In the room presentations section , you can upload the desired documents for the room before starting it .
This section is available in case of the preupload setting is active on its related preset

![Room details](/img/details_room.png)




34 changes: 34 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Labels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## labels
Labels are used to distinguish the rooms and facilitate rooms identification by using different labels

___New Labels___

`To create a new label , click on Create a new label and populate the fileds`
1. Go on labels page
2. Click on the New label button
3. Fill the Create Label form and submit the form

![labels](/img/new_labels.png)
![labels](/img/labels.png)

___Edit Label___

`To Edit labels , you must follow the following steps`

1. Go to the labels page
2. Choose a label from the list and click on the edit button
3. Edit the label details then click on save button
4. The changes will be saved successfully

![labels](/img/Edit_labels.png)

___Delete labels___

`To delete labels , you must follow the following steps`

1. Go to the labels page
2. Choose a label from the list and click on the delete button
3. Confirm deletion
4. The label will be deleted .

![labels](/img/delete_label.png)
13 changes: 13 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Login


___Login___


`To access to your account , just follow these steps`

1. Open your browser, navigate to **[BBBeasy](https://meet.riadvice.ovh/)**
2. Click the login button
3. Enter your Email address and password , the click the login button

![login](/img/login.png)
59 changes: 59 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Presets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
## Configuration Presets:

A preset is a set of configuration settings for BigBlueButton .
This means that if you create a rooms and give it a particular configuration, it will maintain the same during the session. You can also create multiple configurations presets and assign different presets to different rooms.


___New Presets___

`To create a new preset, follow these setps`
1. Go to the presets page
2. Click on the New preset button
3. Enter the preset name then click on the Create button
4. A new preset will be created with the default preset settings
![presets](/img/new_preset.png)

![presets](/img/presets.png)

___Rename Presets___

`To Rename presets , you must follow the following steps`

1. Go to the Presets page
2. Choose a preset from the preset cards and click on the rename button
3. Rename the preset then click on the save button
4. The preset name will be changed successfully

![rename preset](/img/rename_preset.png)

___Edit the Preset settings___

`To Edit the preset settings , you must follow the following steps`

1. Go to the Presets page
2. Choose a preset from the preset cards and choose a preset configuration group (Audio,Branding)
3. Edit the preset settings details then click on the save button
4. The preset settings will be changed successfully

![edit preset settings](/img/edit_preset_settings.png)

___Copy the Preset___

`To Copy the preset , you must follow the following steps`

1. Go to the Presets page
2. Choose preset from the preset cards then click on copy option
3. The preset will be copied successfully with its preset settings

![copy preset](/img/copy_preset.png)

___Delete Presets___

`To delete Presets , you must follow the following steps`

1. Go to the Presets page
2. Choose a preset from the preset cards and click on the delete option
3. Confirm deletion
4. The preset will be deleted .

![delete preset](/img/delete_presete.png)
15 changes: 15 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Profile

The profile page includes all your account details(Username,Email,Profile picture).
Also you can edit your profile informations

___Edit Profile___


`To Edit your profile informations , just follow these steps`

1. Go to the avatar profile in the right corner, a menu be appeared , then click on profile
2. Edit your profile information , then enter your current password for confirmation and submit the form
3. your profile will be modified successfully

![profile](/img/profile.png)
34 changes: 34 additions & 0 deletions bbbeasy-docs/guides/user-guide/introduction/Recordings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Recordings

The recording section represents all the meeting recordings and all the sharing options.

___Recordings page ___

` To Go the recordings page , you must follow the following steps`

1. Go to the Recordings page.
2. You will find all the recording meetings

![Recordings](/img/save_recordings.png)

___ Edit Recording___

`To Edit Recording Name , you must follow the following steps`

1. Go to the Recordings page
2. Choose a Recording from the list and click on the edit button
3. Edit the Recording Name then click on the save button
4. The changes will be saved successfully

![Recordings](/img/Edit_Recordings.png)

___Delete Recording___

`To delete Recording , you must follow the following steps`

1. Go to the Recordings page
2. Choose a Recording from the list and click on the delete button
3. Confirm deletion
4. The Recording will be deleted .

![Recordings](/img/delete_recordings.png)
Loading

0 comments on commit 38ca4d3

Please sign in to comment.