diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c3a0dd..48de210 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ v1.7 - Fix FLEXIAPI-232 Add provisioning email + important redesign of the contacts page - Fix FLEXIAPI-287 Refactor the emails templates - Fix FLEXIAPI-286 Send an account_recovery_token using a push notification and protect the account recovery using phone page with the account_recovery_token +- Fix FLEXIAPI-293 Remove the (long) outdated general documentation v1.6 ---- diff --git a/flexiapi/app/Http/Controllers/Account/AccountController.php b/flexiapi/app/Http/Controllers/Account/AccountController.php index 01ca377..3373600 100644 --- a/flexiapi/app/Http/Controllers/Account/AccountController.php +++ b/flexiapi/app/Http/Controllers/Account/AccountController.php @@ -28,13 +28,6 @@ use App\Services\AccountService; class AccountController extends Controller { - public function documentation(Request $request) - { - return view('account.documentation', [ - 'documentation' => markdownDocumentationView('account.documentation_markdown') - ]); - } - public function blocked(Request $request) { return view('account.blocked'); diff --git a/flexiapi/resources/views/about.blade.php b/flexiapi/resources/views/about.blade.php index b2b85ca..8a14bc1 100644 --- a/flexiapi/resources/views/about.blade.php +++ b/flexiapi/resources/views/about.blade.php @@ -13,7 +13,7 @@

Terms and Conditions and Privacy policy

-

API Documentation, Provisioning Documentation and General Documentation

+

API Documentation and Provisioning Documentation

GNU General Public Licence v3.0 (Licence)

diff --git a/flexiapi/resources/views/account/documentation.blade.php b/flexiapi/resources/views/account/documentation.blade.php deleted file mode 100644 index 4434565..0000000 --- a/flexiapi/resources/views/account/documentation.blade.php +++ /dev/null @@ -1,8 +0,0 @@ -@extends('layouts.main', ['welcome' => true]) - -@section('content') -
- {{-- This view is only a wrapper for the markdown page --}} - {!! $documentation !!} -
-@endsection \ No newline at end of file diff --git a/flexiapi/resources/views/account/documentation_markdown.blade.php b/flexiapi/resources/views/account/documentation_markdown.blade.php deleted file mode 100644 index 10cdaf9..0000000 --- a/flexiapi/resources/views/account/documentation_markdown.blade.php +++ /dev/null @@ -1,97 +0,0 @@ -# Introduction - -[{{ $app_name }}]({{ route('account.home') }}) is a tool that is completing some features around the Flexisip server. - -The application is connected to the Flexisip server and directly interact with it to offer a web interface providing those features. - -# Registration - -Registration can be achieve using several methods if they are correctly configured and enabled by your administrator. - -## Email Registration - -You can create an account using an email address. The form requires you to provide an username and your email address. - -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 enabled you can also create an account using a phone number. You can also add an optional nickname to personnalize your SIP address. If not, your phone number will be used as a username. - -Once submitted, you will be asked to provide a unique pin code received by SMS to the phone number used during the registration. - -## Password completion - -Once activated {{ $app_name }} will ask your to provide a password to finish your account setup. - -# Authentication - -To authenticate please fill in the username or phone number and password you provided during the registration phase. - -If you forgot your password or didn't configured it, you can always recover your account using the recover password forms, using your email address or phone number. 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 your account panel. - -## Generate an API Key - -You will be able to generate an API Key allowing you to use the {{ $app_name }} API with the API Key authentication mechanism. Check the related [API Documentation]({{ route('api') }}) to know more about this feature. - -## Change your email address - -You can change your email address from the panel. A confirmation email containing a unique link will be sent to validate the new one. - -## Change your password - -Your password can also be changed from the password change form. You can enable SHA-256 encrypted password when changing it (required for some clients). - -## Delete your account - -Your account can be deleted from the panel using the account deletion form. You must re-enter your full SIP address to confirm the deletion. - -## Devices management - -From the devices management panel an admin will be able to list and delete the devices attached to a SIP account. - -# Admin panel - -This panel is only accessible to admin accounts. - -## Accounts administration - -From the accounts administration panel an administrator will be able to list, create, show, edit and and delete accounts from the attached Flexisip server. - -### Display a user account - -Each user, identified by a unique number can be managed from the panel. The account can be activated or deactivated (see the Registration section for more information about activation). - -You can also set an account as an administrator. The account will then have the same accesses and authorizations as you. - -Finally the account page allows you to provision the account, using a QR Code or a unique link that can be shared with the contact. - -The provisioning link can be generated and refreshed from this page as well. If the provisiong link is renewed, the old one will be unavailable. - -### Create and edit an account - -Administrators can create and edit accounts directly from the admin panel. During the edition they can assign contacts (other accounts available in the local database), actions and types the same way it can be done in the [API]({{ route('api') }}). - -### Delete an account - -The deletion of an account is definitive, all the database related data (password…) will be destroyed after the deletion. - -### 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. - -## Statistics - -The statistics panel show different statistics recorder by the Account Manager, they can be explored, filtered and exported. \ No newline at end of file diff --git a/flexiapi/routes/web.php b/flexiapi/routes/web.php index c990d5d..682cd9d 100644 --- a/flexiapi/routes/web.php +++ b/flexiapi/routes/web.php @@ -49,7 +49,6 @@ use App\Http\Controllers\Admin\StatisticsController; use Illuminate\Support\Facades\Route; Route::redirect('/', 'login')->name('account.home'); -Route::get('documentation', 'Account\AccountController@documentation')->name('account.documentation'); Route::get('about', 'AboutController@about')->name('about'); Route::middleware(['web_panel_enabled', 'space.check'])->group(function () {