lfajardo
/
cloud_bbb
mirror of https://github.com/sualko/cloud_bbb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #300 from arawa/doc/readme_and_project_files 

docs: readme, screenshots and project files.
pull/302/head
Thibaut 2024-10-25 15:10:21 +02:00 committed by GitHub
parent 2dfa811937 e5b069c565
commit 33f6701713
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 55 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/FUNDING.yml vendored
View File

@ -1,3 +0,0 @@
# These are supported funding model platforms
ko_fi: sualko

14
.github/contributing.md vendored
View File

@ -28,12 +28,13 @@ feature request and follow the guidelines below:
Every code contribution is considered valuable, independent from there size and Every code contribution is considered valuable, independent from there size and
small changes can also be contributed directly via Github: small changes can also be contributed directly via Github:
1. Browse to the desired file via 1. Browse to the desired file via [Github].
[Github](https://github.com/sualko/cloud_bbb/).
2. Click on the :pencil2: on the top right corner of the file. 2. Click on the :pencil2: on the top right corner of the file.
3. Make your changes. 3. Make your changes.
4. Add a meaning full commit message, prefixed with either `fix:` or `feat:` 4. Add a meaning full commit message, prefixed with either `fix:` or `feat:`
(e.g. `fix: room recordings`). (e.g. `fix: room recordings`).<br/>
*type must be one of 'l10n', 'release', 'build', 'ci', 'chore', 'docs', 'feat'
, 'fix', 'perf', 'refactor', 'revert', 'style', 'test', 'example'*
5. Submit your changes. 5. Submit your changes.
If you want to contribute larger changes, we recommend the following approach If you want to contribute larger changes, we recommend the following approach
@ -62,8 +63,7 @@ If you like to sponsor a specific feature, bug fix or the project in general you
can also contact any maintainer of this application to support open source can also contact any maintainer of this application to support open source
development. development.
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/sualko) [Github]: https://github.com/littleredbutton/cloud_bbb/
[open a new issue]: https://github.com/littleredbutton/cloud_bbb/issues
[open a new issue]: https://github.com/sualko/cloud_bbb/issues
[Conventional Commits]: https://www.conventionalcommits.org [Conventional Commits]: https://www.conventionalcommits.org
[Nextclouds Transifex]: https://www.transifex.com/nextcloud/nextcloud/ [Nextclouds Transifex]: https://app.transifex.com/nextcloud/nextcloud/bbb/

3
CODE_OF_CONDUCT.md
View File

@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at klaus@jsxc.org. All reported by contacting the project team at cloud_bbb@arawa.fr or web form [contact]. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an incident.
@ -71,6 +71,7 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
[contact]: https://www.arawa.fr/contact/
For answers to common questions about this code of conduct, see For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq https://www.contributor-covenant.org/faq

56
README.md
View File

@ -1,20 +1,18 @@
# BigBlueButton™ integration for Nextcloud # BigBlueButton™ integration for Nextcloud
![Static analysis](https://github.com/sualko/cloud_bbb/workflows/Static%20analysis/badge.svg) ![Static analysis](https://github.com/littleredbutton/cloud_bbb/workflows/Static%20analysis/badge.svg)
![PHP Tests](https://github.com/sualko/cloud_bbb/workflows/PHP%20Tests/badge.svg) ![PHP Tests](https://github.com/littleredbutton/cloud_bbb/workflows/PHP%20Tests/badge.svg)
![Lint](https://github.com/sualko/cloud_bbb/workflows/Lint/badge.svg) ![Lint](https://github.com/littleredbutton/cloud_bbb/workflows/Lint/badge.svg)
![Downloads](https://img.shields.io/github/downloads/sualko/cloud_bbb/total.svg) ![Downloads](https://img.shields.io/github/downloads/littleredbutton/cloud_bbb/total.svg)
![GitHub release](https://img.shields.io/github/release/sualko/cloud_bbb.svg) ![GitHub release](https://img.shields.io/github/release/littleredbutton/cloud_bbb.svg)
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/sualko)
This app allows to create meetings with an external installation of [BigBlueButton](https://bigbluebutton.org). This app allows to create meetings with an external installation of [BigBlueButton](https://bigbluebutton.org).
:clap: Developer wanted! If you have time it would be awesome if you could help to enhance this application. :clap: Contributors are welcome! If you have time it would be awesome if you could help to enhance this application.
__This app uses BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.__ __This app uses BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.__
![Screenshot configuration](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-configuration.png) ![Screenshot configuration](https://github.com/littleredbutton/cloud_bbb/raw/master/docs/screenshot-configuration.png)
## :heart_eyes: Features ## :heart_eyes: Features
This integration provides the following features: This integration provides the following features:
@ -37,7 +35,7 @@ To install it change into your Nextcloud's apps directory:
Then run: Then run:
git clone https://github.com/sualko/cloud_bbb.git bbb git clone https://github.com/littleredbutton/cloud_bbb.git bbb
Then install the dependencies using: Then install the dependencies using:
@ -61,7 +59,7 @@ $ sudo bbb-conf --secret
Enter these values in the additional settings section on the admin Enter these values in the additional settings section on the admin
configuration page of your Nextcloud instance. configuration page of your Nextcloud instance.
![Screenshot admin section](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-admin.png) ![Screenshot admin section](https://github.com/littleredbutton/cloud_bbb/raw/master/docs/screenshot-admin.png)
### Manual configuration (for experts) ### Manual configuration (for experts)
If you prefer not to use the web interface for configuration, you will find all If you prefer not to use the web interface for configuration, you will find all
@ -123,14 +121,11 @@ command (example use: `./occ bbb:clear-avatar-cache`).
Go to the BigBlueButton section inside your personal settings page and enter a Go to the BigBlueButton section inside your personal settings page and enter a
room name. That's it. You can now distribute the room url. room name. That's it. You can now distribute the room url.
### Enter a room from files ### Share a room
Use the ... menu and select the desired BBB configuration to enter the room. Edit your room configuration and select groups or users you wish to share your room with. You can define the access level for your shared room (admin, moderator or simple user).
Beware that if the room is already running the presentation will **not** be
updated. Entering a room with a defined presentation works only if link shares
are enabled and do not require authentication. See [#1](https://github.com/sualko/cloud_bbb/issues/1)
for details.
![Screenshot file browser](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-file-browser.png)
![Screenshot sharing room](https://github.com/littleredbutton/cloud_bbb/raw/master/docs/screenshot-config-share.png)
## :notebook: Notes ## :notebook: Notes
- By using the [Link Editor](https://apps.nextcloud.com/apps/files_linkeditor) - By using the [Link Editor](https://apps.nextcloud.com/apps/files_linkeditor)
@ -140,7 +135,7 @@ for details.
- Before installing, make sure your BBB is running correctly - Before installing, make sure your BBB is running correctly
- If the room doesn't appear in the ... menu of files, a browser/cache reload - If the room doesn't appear in the ... menu of files, a browser/cache reload
might help might help
- To share an audio (mp3) or video (mp4) file with your audience follow these steps (more info in [#148](https://github.com/sualko/cloud_bbb/issues/148#issuecomment-827338650)): - To share an audio (mp3) or video (mp4) file with your audience follow these steps (more info in [#148](https://github.com/littleredbutton/cloud_bbb/issues/148#issuecomment-827338650)):
- create a public share of the exact file - create a public share of the exact file
- copy the location of the share from the share information screen into your clipboard - copy the location of the share from the share information screen into your clipboard
- open big blue button, press the plus icon in the lower left corner - open big blue button, press the plus icon in the lower left corner
@ -152,22 +147,23 @@ for details.
Writing such an application is a lot of work and therefore we are specially Writing such an application is a lot of work and therefore we are specially
thankful for people and organisations who are sponsoring features or bug fixes: thankful for people and organisations who are sponsoring features or bug fixes:
- [Arawa](https://arawa.fr/) Share moderators and users ([#281]), Bug fixes, UX audit
- [Medienwerkstatt Minden-Lübbecke e.V.](https://www.medienwerkstatt.org) manage recordings ([#19]) - [Medienwerkstatt Minden-Lübbecke e.V.](https://www.medienwerkstatt.org) manage recordings ([#19])
- [Deutscher Bundesjugendring](https://www.dbjr.de) version [0.4.0], version [0.5.0] - [Deutscher Bundesjugendring](https://www.dbjr.de) version [0.4.0], version [0.5.0]
- [Graz University of Technology](https://www.tugraz.at) form action ([#47]), navigation entry ([#31]), restrictions ([#43], [#53]), circles ([#61]) - [Graz University of Technology](https://www.tugraz.at) form action ([#47]), navigation entry ([#31]), restrictions ([#43], [#53]), circles ([#61])
- [Arawa](https://www.arawa.fr) UX audit - [Niedersächsisches Landesinstitut für schulische Qualitätsentwicklung - Netzwerk Medienberatung](https://nlq.niedersachsen.de/) moderator url, UX improvements
- [Niedersächsisches Landesinstitut für schulische Qualitätsentwicklung – Netzwerk Medienberatung](https://nlq.niedersachsen.de/) moderator url, UX improvements
- [Integrierte Gesamtschule Lengede](http://www.igs-lengede.de/) theme, join options - [Integrierte Gesamtschule Lengede](http://www.igs-lengede.de/) theme, join options
If you are looking for other ways to contribute to this project, you are welcome If you are looking for other ways to contribute to this project, you are welcome
to look at our [contributor guidelines]. Every contribution is valuable :tada:. to look at our [contributor guidelines]. Every contribution is valuable :tada:.
[contributor guidelines]: https://github.com/sualko/cloud_bbb/blob/master/.github/contributing.md [contributor guidelines]: https://github.com/littleredbutton/cloud_bbb/blob/master/.github/contributing.md
[#19]: https://github.com/sualko/cloud_bbb/issues/19 [#19]: https://github.com/littleredbutton/cloud_bbb/issues/19
[#47]: https://github.com/sualko/cloud_bbb/issues/47 [#47]: https://github.com/littleredbutton/cloud_bbb/issues/47
[#31]: https://github.com/sualko/cloud_bbb/issues/31 [#31]: https://github.com/littleredbutton/cloud_bbb/issues/31
[#43]: https://github.com/sualko/cloud_bbb/issues/43 [#43]: https://github.com/littleredbutton/cloud_bbb/issues/43
[#53]: https://github.com/sualko/cloud_bbb/issues/53 [#53]: https://github.com/littleredbutton/cloud_bbb/issues/53
[#61]: https://github.com/sualko/cloud_bbb/issues/61 [#61]: https://github.com/littleredbutton/cloud_bbb/issues/61
[0.4.0]: https://github.com/sualko/cloud_bbb/releases/tag/v0.4.0 [#281]: https://github.com/littleredbutton/cloud_bbb/pull/281
[0.5.0]: https://github.com/sualko/cloud_bbb/releases/tag/v0.5.0 [0.4.0]: https://github.com/littleredbutton/cloud_bbb/releases/tag/v0.4.0
[0.5.0]: https://github.com/littleredbutton/cloud_bbb/releases/tag/v0.5.0

23
appinfo/info.xml
View File

@ -14,17 +14,18 @@
* **Restrictions** Restrict room creation to certain groups * **Restrictions** Restrict room creation to certain groups
* **Activities** Get an overview of your room activities * **Activities** Get an overview of your room activities
Quick start guide and further information in our [readme](https://github.com/sualko/cloud_bbb). Quick start guide and further information in our [readme](https://github.com/littleredbutton/cloud_bbb).
Do you like this application? Give something back to the open source community and checkout our Do you like this application? Give something back to the open source community and checkout our
[ways to contribute](https://github.com/sualko/cloud_bbb/blob/master/.github/contributing.md). [ways to contribute](https://github.com/littleredbutton/cloud_bbb/blob/master/.github/contributing.md).
Developer wanted! If you have time it would be awesome if you could help to enhance this application. Contributors are welcome! If you have time it would be awesome if you could help to enhance this application.
*This app integrates BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.* *This app integrates BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.*
]]></description> ]]></description>
<version>2.7.2</version> <version>2.7.2</version>
<licence>agpl</licence> <licence>agpl</licence>
<author mail="klaus@jsxc.org">Klaus Herberth</author> <author mail="cloud_bbb@arawa.fr" homepage="https://arawa.fr/">Arawa</author>
<author>Klaus Herberth</author>
<namespace>BigBlueButton</namespace> <namespace>BigBlueButton</namespace>
<types> <types>
<prevent_group_restriction/> <prevent_group_restriction/>
@ -32,13 +33,13 @@ Developer wanted! If you have time it would be awesome if you could help to enha
<category>social</category> <category>social</category>
<category>multimedia</category> <category>multimedia</category>
<category>integration</category> <category>integration</category>
<website>https://github.com/sualko/cloud_bbb/</website> <website>https://github.com/littleredbutton/cloud_bbb/</website>
<bugs>https://github.com/sualko/cloud_bbb/issues</bugs> <bugs>https://github.com/littleredbutton/cloud_bbb/issues</bugs>
<repository>https://github.com/sualko/cloud_bbb/</repository> <repository>https://github.com/littleredbutton/cloud_bbb/</repository>
<screenshot>https://raw.githubusercontent.com/sualko/cloud_bbb/master/docs/screenshot-file-browser.png</screenshot> <screenshot>https://raw.githubusercontent.com/littleredbutton/cloud_bbb/master/docs/screenshot-configuration.png</screenshot>
<screenshot>https://raw.githubusercontent.com/sualko/cloud_bbb/master/docs/screenshot-configuration.png</screenshot> <screenshot>https://raw.githubusercontent.com/littleredbutton/cloud_bbb/master/docs/screenshot-configuration2.png</screenshot>
<screenshot>https://raw.githubusercontent.com/sualko/cloud_bbb/master/docs/screenshot-configuration2.png</screenshot> <screenshot>https://raw.githubusercontent.com/littleredbutton/cloud_bbb/master/docs/screenshot-join.png</screenshot>
<screenshot>https://raw.githubusercontent.com/sualko/cloud_bbb/master/docs/screenshot-join.png</screenshot> <screenshot>https://raw.githubusercontent.com/littleredbutton/cloud_bbb/master/docs/screenshot-config-share.png</screenshot>
<dependencies> <dependencies>
<lib>curl</lib> <lib>curl</lib>
<lib>mbstring</lib> <lib>mbstring</lib>

5
composer.json
View File

@ -1,12 +1,11 @@
{ {
"name": "sualko/bigbluebutton", "name": "littleredbutton/bigbluebutton",
"description": "Nextcloud Integration for BigBlueButton", "description": "Nextcloud Integration for BigBlueButton",
"type": "project", "type": "project",
"license": "AGPL", "license": "AGPL",
"authors": [ "authors": [
{ {
"name": "Klaus Herberth", "name": "Klaus Herberth"
"email": "klaus@jsxc.org"
} }
], ],
"require": { "require": {

BIN
docs/screenshot-config-share.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/screenshot-configuration.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 89 KiB

10
package.json
View File

@ -1,16 +1,16 @@
{ {
"name": "@sualko/cloud_bbb", "name": "@littleredbutton/cloud_bbb",
"description": "Nextcloud Integration for BigBlueButton", "description": "Nextcloud Integration for BigBlueButton",
"version": "2.7.2", "version": "2.7.2",
"author": "Klaus Herberth <klaus@jsxc.org>", "author": "Klaus Herberth",
"bugs": { "bugs": {
"url": "https://github.com/sualko/cloud_bbb/issues" "url": "https://github.com/littleredbutton/cloud_bbb/issues"
}, },
"repository": { "repository": {
"url": "https://github.com/sualko/cloud_bbb", "url": "https://github.com/littleredbutton/cloud_bbb",
"type": "git" "type": "git"
}, },
"homepage": "https://github.com/sualko/cloud_bbb", "homepage": "https://github.com/littleredbutton/cloud_bbb",
"license": "agpl", "license": "agpl",
"private": true, "private": true,
"scripts": { "scripts": {