Comunic
/
ComunicAPI
mirror of https://github.com/pierre42100/ComunicAPI
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
473 Commits 1 Branch 6 Tags 547 KiB
PHP 99.9%
Go to file
Pierre Hubert 19c2ff321e Fix typo 2020-04-29 16:41:52 +02:00
3rdparty Fix old content encoding issue 2019-04-26 14:28:12 +02:00
RestControllers Fix typo 2020-01-01 15:01:44 +01:00
bin Added a script to clean calls on dev machine 2019-01-26 09:28:03 +01:00
classes Fix typo 2019-12-26 13:25:54 +01:00
config Calls configuration inlucdes the maximum number of members per call. 2019-02-02 08:19:12 +01:00
functions Added incognito mode 2019-01-11 12:03:59 +01:00
helpers Setup API requests limit system. 2018-08-20 13:45:50 +02:00
tests/classes/models Can tests for BaseUniqueObject 2018-07-12 14:10:41 +02:00
.gitignore Can easily overwrite website configuration 2018-05-07 18:59:15 +02:00
.htaccess Connexion to database 2017-05-17 14:01:36 +02:00
LICENSE Added license 2017-05-17 13:49:02 +02:00
README.md Automatically clean calls. 2019-01-26 08:40:29 +01:00
db_struct.sql Fix typo 2020-04-29 16:41:52 +02:00
index.php Setup API requests limit system. 2018-08-20 13:45:50 +02:00
init.php Can easily overwrite website configuration 2018-05-07 18:59:15 +02:00

README.md

The Comunic API

This project is the main Comunic RestAPI. It assures data backend support.

(c) Pierre HUBERT since 2017

Crons required for Comunic

Calls cron

There is a cron to automatically cleanup old conversation. Ideally this cron should be executed every 30 seconds. The file to execute is bin/clean_calls

Use calls in Comunic

To use calls in Comunic, you need a WebRTCSignalExchangerServer, a small signal exchanging server written using NodeJS. You also need to modify your configuration file located at config/overwrite.php by copying and pasting commented configuration located at config/calls.php and make it fit your needs.

Add API clients

In order to easily add clients to the API, a script has been created. bin/add_client [name] [token] Note : The name of the client must be unique, and the token should the strongest as possible