From a78b04e0a21d3991553b53afdf01da36db82bb82 Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Thu, 28 Nov 2024 14:53:02 -0300 Subject: [PATCH] [docs] Updated links to docs [skip ci] --- CHANGES.rst | 58 ++++++++++++++--------------- README.rst | 18 ++++----- openwisp_radius/admin.py | 2 +- openwisp_radius/base/forms.py | 2 +- openwisp_radius/tests/test_admin.py | 2 +- 5 files changed, 41 insertions(+), 41 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index e9be5142..5e88d17c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,32 +8,32 @@ Features ~~~~~~~~ - Added integration with `OpenWISP Monitoring - `_ to + `_ to collect and visualize metrics for user-signups and RADIUS traffic. - Added support for `Change of Authorization (CoA) - `_. + `_. - Added `MonthlyTrafficCounter - `_ + `_ and `MonthlySubscriptionTrafficCounter - `_. + `_. - Added API endpoint to fetch user's latest PhoneToken status. - Added `OPENWISP_RADIUS_SMS_COOLDOWN - `_ + `_ to configure cooldown time for requesting a new PhoneToken. - Extended ``OPENWISP_USERS_EXPORT_USERS_COMMAND_CONFIG`` to include registration method and verification status. - Added MAC address authentication for roaming users. - Added `OPENWISP_RADIUS_SMS_MESSAGE_TEMPLATE - `_ + `_ setting to customize SMS messages. - Added `OPENWISP_RADIUS_USER_ADMIN_RADIUSTOKEN_INLINE - `_ + `_ setting to display RadiusTokenInline in UserAdmin. - Added `OPENWISP_RADIUS_UNVERIFY_INACTIVE_USERS - `_ + `_ setting to unverify users after a defined period of inactivity. - Added `OPENWISP_RADIUS_DELETE_INACTIVE_USERS - `_ + `_ setting to delete inactive users after a specified period. - Added API endpoint to return user's RADIUS usage. - Supported password expiration feature from openwisp-users. @@ -51,7 +51,7 @@ Backward incompatible changes - Renamed ``delete_old_users`` command to ``delete_old_radiusbatch_users``. - The `OPENWISP_RADIUS_BATCH_DELETE_EXPIRED - `_ + `_ setting now expects days instead of months. Deprecation warnings @@ -162,62 +162,62 @@ Features - Allowed freeradius authorize with email or phone number - Allowed the usage of subnets in `OPENWISP_RADIUS_FREERADIUS_ALLOWED_HOSTS - `_ + `_ - Made the fields containing personal data of users which are exposed in the registration API configurable (allowed, mandatory, disabled) via the `OPENWISP_RADIUS_OPTIONAL_REGISTRATION_FIELDS setting or the admin interface - `_ + `_ - Allow to disable registration API via the `OPENWISP_RADIUS_REGISTRATION_API_ENABLED setting or the admin interface - `_ + `_ - Added `throttling of API requests - `_ + `_ - Added `OPENWISP_RADIUS_API_BASEURL setting - `_ + `_ - Add identity verification feature, configurable via the `OPENWISP_RADIUS_NEEDS_IDENTITY_VERIFICATION or via admin interface - `_ + `_ - Added utilities for implementing `new registration and identity verification methods - `_ + `_ - Added `captive portal mock views - `_ + `_ to ease development and debugging - Add possibility to filter users by registration method in the admin interface - Added SAML registration method to implement `captive portal authentication via Single Sign On (SSO) - `_ + `_ - Added management command and celery task to `delete unverified users - `_ + `_ - Added translations of user facing API responses in Italian, German, Slovenian and Furlan - Added `Convert RADIUS accounting CALLED-STATION-ID feature - `_, + `_, celery task and management command, with the possibility of triggering it on accounting creation (see `OPENWISP_RADIUS_CONVERT_CALLED_STATION_ON_CREATE - `_) + `_) - Added an `equivalent of the FreeRADIUS sqlcounter feature to the REST API - `_ + `_ - Added emission of django signal to FreeRADIUS accounting view: `radius_accounting_success - `_ + `_ - Added possibility to send email to the user an they start a new radius accounting session - Added organization level settings and related admin interface functionality to enable/disable SAML and social login: - `OPENWISP_RADIUS_SAML_REGISTRATION_ENABLED - `_ + `_ - `OPENWISP_RADIUS_SOCIAL_REGISTRATION_ENABLED - `_ + `_ - Added setting to avoid updating username from SAML: `OPENWISP_RADIUS_SAML_UPDATES_PRE_EXISTING_USERNAME - `_ + `_ Changes ~~~~~~~ @@ -255,7 +255,7 @@ Other changes - Moved AccountingView to freeradius endpoints - Relaxed default values for the `SMS token settings - `_ + `_ - Switched to new navigation menu and new OpenWISP theme - Allowed users to sign up to multiple organizations - Update username when phone number is changed if username is equal to the @@ -271,7 +271,7 @@ Other changes - Added validation check to prevent invalid username in batch user creation - Allowed to set the `Password Reset URL setting - `_ + `_ via the admin interface - Added soft limits to celery tasks for background operations - Generalized the implementation of the fallback model fields which allow diff --git a/README.rst b/README.rst index 403d5b0f..2232c150 100644 --- a/README.rst +++ b/README.rst @@ -36,30 +36,30 @@ openwisp-radius **OpenWISP RADIUS** provides a web interface to a `freeradius `_ database, a rich `REST HTTP API -`_ and features +`_ and features like `user self registration -`_, `SMS +`_, `SMS verification -`_, +`_, `import of users from CSV files -`_, +`_, `generation of new users for events -`_, +`_, `social login -`_, and much +`_, and much more. It can be used as a standalone application or integrated with the rest of `OpenWISP `_. It can also be used as a `base system or framework on top of which custom tailored solutions can be built -`_. +`_. Documentation ------------- -- `Usage documentation `_ +- `Usage documentation `_ - `Developer documentation - `_ + `_ Contributing ------------ diff --git a/openwisp_radius/admin.py b/openwisp_radius/admin.py index 73984bdd..5c548ad0 100644 --- a/openwisp_radius/admin.py +++ b/openwisp_radius/admin.py @@ -371,7 +371,7 @@ class RadiusBatchAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin): 'giving out the credentials.' ), 'documentation_url': ( - 'https://openwisp.io/docs/dev/radius/user/importing_users.html' + 'https://openwisp.io/docs/stable/radius/user/importing_users.html' ), } diff --git a/openwisp_radius/base/forms.py b/openwisp_radius/base/forms.py index 64ac54a6..d6d28637 100644 --- a/openwisp_radius/base/forms.py +++ b/openwisp_radius/base/forms.py @@ -46,7 +46,7 @@ def clean(self): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) if 'csvfile' in self.fields: - docs_link = 'https://openwisp.io/docs/dev/radius/user/importing_users.html' + docs_link = 'https://openwisp.io/docs/stable/radius/user/importing_users.html' help_text = f"Refer to the docs \ for more details on importing users from a CSV" self.fields['csvfile'].help_text = help_text diff --git a/openwisp_radius/tests/test_admin.py b/openwisp_radius/tests/test_admin.py index 772a45b2..9c3bdbd2 100644 --- a/openwisp_radius/tests/test_admin.py +++ b/openwisp_radius/tests/test_admin.py @@ -406,7 +406,7 @@ def test_delete_selected_batches_action_perms(self): def test_radius_batch_csv_help_text(self): add_url = reverse(f'admin:{self.app_label}_radiusbatch_add') response = self.client.get(add_url) - docs_link = 'https://openwisp.io/docs/dev/radius/user/importing_users.html' + docs_link = 'https://openwisp.io/docs/stable/radius/user/importing_users.html' self.assertContains(response, docs_link) def test_radiususergroup_inline_user(self):