Fix #54 Disable Flexisip socket/pipe related unstable features

Complete the documentation
Disable related API endpoints
Edit the README
Bump the package number
This commit is contained in:
Timothée Jaussoin 2022-11-03 15:36:41 +01:00
parent 4292277037
commit a79b144795
6 changed files with 20 additions and 8 deletions

View file

@ -244,6 +244,8 @@ You can also seed the tables with test accounts for the liblinphone test suite w
## Sending SIP messages from the API
**The messaging related features are considered instable and are not available**
The `POST /api/messages` endpoint allows you to send messages on the SIP network. It call internally `linphone-daemon` to do so. To be able to use it you should follow the following steps:
1. Launch the `linphone-daemon` with a UNIX socket path, this will create a socket file in `/tmp` (the file will be `/tmp/lp` for the following line).

View file

@ -22,7 +22,8 @@ return [
'newsletter_registration_address' => env('NEWSLETTER_REGISTRATION_ADDRESS', ''),
'phone_authentication' => env('PHONE_AUTHENTICATION', true),
'public_registration' => env('PUBLIC_REGISTRATION', true),
'devices_management' => env('DEVICES_MANAGEMENT', false),
// See https://gitlab.linphone.org/BC/public/flexisip-account-manager/-/issues/54
'devices_management' => false, //env('DEVICES_MANAGEMENT', false),
'web_panel' => env('WEB_PANEL', true),
'proxy_registrar_address' => env('ACCOUNT_PROXY_REGISTRAR_ADDRESS', 'sip.domain.com'),
@ -41,7 +42,8 @@ return [
*/
'flexisip_proxy_pid' => env('APP_FLEXISIP_PROXY_PID', '/var/run/flexisip-proxy.pid'),
'flexisip_pusher_path' => env('APP_FLEXISIP_PUSHER_PATH', null),
'linphone_daemon_unix_pipe' => env('APP_LINPHONE_DAEMON_UNIX_PATH', null),
// See https://gitlab.linphone.org/BC/public/flexisip-account-manager/-/issues/54
'linphone_daemon_unix_pipe' => null, // env('APP_LINPHONE_DAEMON_UNIX_PATH', null),
/**
* Account provisioning

View file

@ -64,6 +64,8 @@ Your account can be deleted from the panel using the @if (config('app.web_panel'
## Devices management
**The devices related features are considered instable and are not available**
@if (config('app.devices_management') == false)
*The feature is not enabled on this instance.*
@endif

View file

@ -311,6 +311,8 @@ Return the updated account
## Accounts devices
**The devices related features are considered instable and are not available**
### `GET /accounts/me/devices`
<span class="badge badge-info">User</span>
Return the user registered devices.
@ -417,6 +419,8 @@ Remove a a type from the account.
## Messages
**The messaging related features are considered instable and are not available**
### `POST /messages`
<span class="badge badge-warning">Admin</span>
Send a message over SIP.

View file

@ -65,8 +65,9 @@ Route::group(['middleware' => ['auth.digest_or_key']], function () {
Route::post('accounts/me/phone/request', 'Api\AccountPhoneController@requestUpdate');
Route::post('accounts/me/phone', 'Api\AccountPhoneController@update');
Route::get('accounts/me/devices', 'Api\DeviceController@index');
Route::delete('accounts/me/devices/{uuid}', 'Api\DeviceController@destroy');
// See https://gitlab.linphone.org/BC/public/flexisip-account-manager/-/issues/54
//Route::get('accounts/me/devices', 'Api\DeviceController@index');
//Route::delete('accounts/me/devices/{uuid}', 'Api\DeviceController@destroy');
Route::post('accounts/me/email/request', 'Api\EmailController@requestUpdate');
Route::post('accounts/me/password', 'Api\PasswordController@update');
@ -75,9 +76,10 @@ Route::group(['middleware' => ['auth.digest_or_key']], function () {
Route::get('accounts/me/contacts', 'Api\AccountContactController@index');
Route::group(['middleware' => ['auth.admin']], function () {
if (!empty(config('app.linphone_daemon_unix_pipe'))) {
Route::post('messages', 'Api\MessageController@send');
}
// See https://gitlab.linphone.org/BC/public/flexisip-account-manager/-/issues/54
//if (!empty(config('app.linphone_daemon_unix_pipe'))) {
// Route::post('messages', 'Api\MessageController@send');
//}
// Accounts
Route::get('accounts/{id}/activate', 'Api\Admin\AccountController@activate');

View file

@ -8,7 +8,7 @@
#%define _datadir %{_datarootdir}
#%define _docdir %{_datadir}/doc
%define build_number 163
%define build_number 164
%define var_dir /var/opt/belledonne-communications
%define opt_dir /opt/belledonne-communications/share/flexisip-account-manager