mirror of
https://gitlab.linphone.org/BC/public/flexisip-account-manager.git
synced 2026-01-17 10:08:05 +00:00
Complete the documentation page
Fix the XMLRPC with simpler information regarding the OVH SMS API Update the dependencies
This commit is contained in:
Timothée Jaussoin
parent
7a17897193
commit
97fca6422b
4 changed files with 34 additions and 32 deletions
22
README.md
22
README.md
|
|
@ -79,25 +79,11 @@ php /opt/belledonne-communications/share/flexisip-account-manager/tools/create_t
|
|||
|
||||
### 5. Install OVH SMS gateway dependency (optionnal)
|
||||
|
||||
To install OVH SMS PHP API create a `composer.json` file in `/opt/belledonne-communications/`:
|
||||
Download and install [composer](https://getcomposer.org/download/) or use the one already provided by your OS.
|
||||
Then install the `php-ovh-sms` library in the `flexisip-account-manager` directory.
|
||||
|
||||
```bash
|
||||
cat > /opt/belledonne-communications/share/flexisip-account-manager/composer.json << EOF
|
||||
{
|
||||
"name": "XMLRPC SMS API",
|
||||
"description": "XMLRPC SMS API",
|
||||
"require": { "ovh/php-ovh-sms": "dev-master" }
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
Then download and install [composer](https://getcomposer.org/download/).
|
||||
|
||||
Finally start composer:
|
||||
|
||||
```bash
|
||||
cd /opt/belledonne-communications/share/flexisip-account-manager/ && composer install
|
||||
```
|
||||
cd /opt/belledonne-communications/share/flexisip-account-manager/
|
||||
php composer.phar require ovh/php-ovh-sms
|
||||
|
||||
### 4. Configure the API
|
||||
------------------------------
|
||||
|
|
|
|||
24
flexiapi/composer.lock
generated
24
flexiapi/composer.lock
generated
|
|
@ -1039,16 +1039,16 @@
|
|||
},
|
||||
{
|
||||
"name": "fideloper/proxy",
|
||||
"version": "4.4.1",
|
||||
"version": "4.4.2",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/fideloper/TrustedProxy.git",
|
||||
"reference": "c073b2bd04d1c90e04dc1b787662b558dd65ade0"
|
||||
"reference": "a751f2bc86dd8e6cfef12dc0cbdada82f5a18750"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/fideloper/TrustedProxy/zipball/c073b2bd04d1c90e04dc1b787662b558dd65ade0",
|
||||
"reference": "c073b2bd04d1c90e04dc1b787662b558dd65ade0",
|
||||
"url": "https://api.github.com/repos/fideloper/TrustedProxy/zipball/a751f2bc86dd8e6cfef12dc0cbdada82f5a18750",
|
||||
"reference": "a751f2bc86dd8e6cfef12dc0cbdada82f5a18750",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
|
|
@ -1058,7 +1058,7 @@
|
|||
"require-dev": {
|
||||
"illuminate/http": "^5.0|^6.0|^7.0|^8.0|^9.0",
|
||||
"mockery/mockery": "^1.0",
|
||||
"phpunit/phpunit": "^6.0"
|
||||
"phpunit/phpunit": "^8.5.8|^9.3.3"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
|
|
@ -1091,9 +1091,9 @@
|
|||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/fideloper/TrustedProxy/issues",
|
||||
"source": "https://github.com/fideloper/TrustedProxy/tree/4.4.1"
|
||||
"source": "https://github.com/fideloper/TrustedProxy/tree/4.4.2"
|
||||
},
|
||||
"time": "2020-10-22T13:48:01+00:00"
|
||||
"time": "2022-02-09T13:33:34+00:00"
|
||||
},
|
||||
{
|
||||
"name": "graham-campbell/result-type",
|
||||
|
|
@ -1468,16 +1468,16 @@
|
|||
},
|
||||
{
|
||||
"name": "laravel/framework",
|
||||
"version": "v8.83.18",
|
||||
"version": "v8.83.19",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/laravel/framework.git",
|
||||
"reference": "db8188e9cc8359a5c6706fa9d9f55aad7f235077"
|
||||
"reference": "4264f2ee12330bdb1be050998f58ba7271236395"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/laravel/framework/zipball/db8188e9cc8359a5c6706fa9d9f55aad7f235077",
|
||||
"reference": "db8188e9cc8359a5c6706fa9d9f55aad7f235077",
|
||||
"url": "https://api.github.com/repos/laravel/framework/zipball/4264f2ee12330bdb1be050998f58ba7271236395",
|
||||
"reference": "4264f2ee12330bdb1be050998f58ba7271236395",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
|
|
@ -1637,7 +1637,7 @@
|
|||
"issues": "https://github.com/laravel/framework/issues",
|
||||
"source": "https://github.com/laravel/framework"
|
||||
},
|
||||
"time": "2022-06-28T14:30:38+00:00"
|
||||
"time": "2022-07-13T13:23:09+00:00"
|
||||
},
|
||||
{
|
||||
"name": "laravel/serializable-closure",
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The application is connected to the Flexisip server and directly interact with i
|
|||
|
||||
# Registration
|
||||
|
||||
Registration can be achieve using two methods if they are correctly configured and enabled by your administrator.
|
||||
Registration can be achieve using several methods if they are correctly configured and enabled by your administrator.
|
||||
|
||||
## Email Registration
|
||||
|
||||
|
|
@ -18,6 +18,10 @@ You can @if (config('app.web_panel') && config('app.public_registration')) [crea
|
|||
|
||||
Once completed a confirmation email containing a unique link will be sent to the address. This link is used to activate your account, allowing you to finish the setup.
|
||||
|
||||
## Account Creation Token Registration
|
||||
|
||||
Allow the creation of an account using a previously generated Account Creation Token.
|
||||
|
||||
## Phone Registration
|
||||
|
||||
@if (!config('app.phone_authentication'))
|
||||
|
|
@ -38,6 +42,10 @@ To authenticate please fill in the username or phone number and password you pro
|
|||
|
||||
If you forgot your password or didn't configured it, you can always recover your account using the recover password forms, using your @if (config('app.web_panel')) [email address]({{ route('account.login_email') }}) @else email address @endif or @if (config('app.web_panel') && config('app.phone_authentication')) [phone number]({{ route('account.login_phone') }}) @else phone number (not enabled) @endif. Once authenticated you will then be able to change your password.
|
||||
|
||||
## Code based authentication
|
||||
|
||||
[{{ $app_name }}]({{ route('account.home') }}) allows you to authenticate a new device using an already authenticated one. This can be done by generating a QRCode from the authenticated device and flash it on the un-authenticated one (or the other way around).
|
||||
|
||||
# Account panel
|
||||
|
||||
Once authenticated you will get access to @if (config('app.web_panel')) [your account panel]({{ route('account.panel') }}) @else your account panel @endif.
|
||||
|
|
@ -92,6 +100,14 @@ Administrators can create and edit accounts directly from the admin panel. Durin
|
|||
|
||||
The deletion of an account is definitive, all the database related data (password, aliases…) will be destroyed after the deletion.
|
||||
|
||||
### Attach the account to an External Account
|
||||
|
||||
@if (config('app.consume_external_account_on_create') == false)
|
||||
*The feature is not enabled on this instance.*
|
||||
@endif
|
||||
|
||||
It is possible to import external accounts in the application. If this feature is enabled those External Accounts can be attached during the account creation process or afterward using the Account page dedicated button.
|
||||
|
||||
### Create, edit and delete account types
|
||||
|
||||
An adminisator can create, edit and delete account types. Those can be used to categorize accounts in clients, they are often used for Internet of Things related devices.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
#%define _datadir %{_datarootdir}
|
||||
#%define _docdir %{_datadir}/doc
|
||||
|
||||
%define build_number 143
|
||||
%define build_number 144
|
||||
%define var_dir /var/opt/belledonne-communications
|
||||
%define opt_dir /opt/belledonne-communications/share/flexisip-account-manager
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue