Skip to content

Commit

Permalink
[docs] Updated links to docs + other minor fixes
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
nemesifier committed Aug 30, 2024
1 parent 489ac53 commit baf4ff4
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 29 deletions.
38 changes: 19 additions & 19 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,62 +59,62 @@ Features
- Allowed freeradius authorize with email or phone number
- Allowed the usage of subnets in
`OPENWISP_RADIUS_FREERADIUS_ALLOWED_HOSTS
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-freeradius-allowed-hosts>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#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
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-optional-registration-fields>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-optional-registration-fields>`_
- Allow to disable registration API via the
`OPENWISP_RADIUS_REGISTRATION_API_ENABLED setting or the admin interface
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-registration-api-enabled>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-registration-api-enabled>`_
- Added `throttling of API requests
<https://openwisp-radius.readthedocs.io/en/latest/user/api.html#api-throttling>`_
<Read https://openwisp.io/docs/dev/radius/user/api.html#api-throttling>`_
- Added `OPENWISP_RADIUS_API_BASEURL setting
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-api-baseurl>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-api-baseurl>`_
- Add identity verification feature, configurable via the
`OPENWISP_RADIUS_NEEDS_IDENTITY_VERIFICATION or via admin interface
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-needs-identity-verification>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-needs-identity-verification>`_
- Added utilities for implementing `new registration and identity
verification methods
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#adding-support-for-more-registration-verification-methods>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#adding-support-for-more-registration-verification-methods>`_
- Added `captive portal mock views
<https://openwisp-radius.readthedocs.io/en/latest/developer/captive_portal_mock.html>`_
<Read https://openwisp.io/docs/dev/radius/developer/captive_portal_mock.html>`_
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)
<https://openwisp-radius.readthedocs.io/en/latest/user/saml.html>`_
<Read https://openwisp.io/docs/dev/radius/user/saml.html>`_
- Added management command and celery task to `delete unverified users
<https://openwisp-radius.readthedocs.io/en/latest/user/management_commands.html#delete-unverified-users>`_
<Read https://openwisp.io/docs/dev/radius/user/management_commands.html#delete-unverified-users>`_
- Added translations of user facing API responses in Italian, German,
Slovenian and Furlan
- Added `Convert RADIUS accounting CALLED-STATION-ID feature
<https://openwisp-radius.readthedocs.io/en/latest/user/management_commands.html#convert-called-station-id>`_,
<Read https://openwisp.io/docs/dev/radius/user/management_commands.html#convert-called-station-id>`_,
celery task and management command, with the possibility of triggering
it on accounting creation (see
`OPENWISP_RADIUS_CONVERT_CALLED_STATION_ON_CREATE
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-convert-called-station-on-create>`_)
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-convert-called-station-on-create>`_)
- Added an `equivalent of the FreeRADIUS sqlcounter feature to the REST
API
<https://openwisp-radius.readthedocs.io/en/latest/user/enforcing_limits.html#how-limits-are-enforced-counters>`_
<Read https://openwisp.io/docs/dev/radius/user/enforcing_limits.html#how-limits-are-enforced-counters>`_
- Added emission of django signal to FreeRADIUS accounting view:
`radius_accounting_success
<https://openwisp-radius.readthedocs.io/en/latest/developer/signals.html#radius-accounting-success>`_
<Read https://openwisp.io/docs/dev/radius/developer/signals.html#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
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-saml-registration-enabled>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-saml-registration-enabled>`_
- `OPENWISP_RADIUS_SOCIAL_REGISTRATION_ENABLED
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-social-registration-enabled>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-social-registration-enabled>`_

- Added setting to avoid updating username from SAML:
`OPENWISP_RADIUS_SAML_UPDATES_PRE_EXISTING_USERNAME
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-saml-updates-pre-existing-username>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-saml-updates-pre-existing-username>`_

Changes
~~~~~~~
Expand Down Expand Up @@ -152,7 +152,7 @@ Other changes

- Moved AccountingView to freeradius endpoints
- Relaxed default values for the `SMS token settings
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#sms-token-related-settings>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#sms-token-related-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
Expand All @@ -168,7 +168,7 @@ Other changes
- Added validation check to prevent invalid username in batch user
creation
- Allowed to set the `Password Reset URL setting
<https://openwisp-radius.readthedocs.io/en/latest/user/settings.html#openwisp-radius-password-reset-urls>`_
<Read https://openwisp.io/docs/dev/radius/user/settings.html#openwisp-radius-password-reset-urls>`_
via the admin interface
- Added soft limits to celery tasks for background operations
- Generalized the implementation of the fallback model fields which allow
Expand Down
4 changes: 2 additions & 2 deletions docs/deploy/freeradius.rst
Original file line number Diff line number Diff line change
Expand Up @@ -381,8 +381,8 @@ ensure the ``authorize`` section of your site as follows contains the
.. _radius_debugging:

Debugging
---------
Debugging & Troubleshooting
---------------------------

In this section we will explain how to debug your freeradius instance.

Expand Down
6 changes: 3 additions & 3 deletions docs/deploy/freeradius_wpa_enterprise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Prerequisites
Execute the steps explained in the following sections of the
:doc:`freeradius guide for captive portal authentication <freeradius>`:

- How to install freeradius 3
- Enable the configured modules
- Configure the REST module
- How to install freeradius 3
- Enable the configured modules
- Configure the REST module

Then proceed with the rest of the document.

Expand Down
4 changes: 2 additions & 2 deletions docs/developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Developer Docs

Other useful resources:

- :doc:`../user/rest-api`
- :doc:`../user/settings`
- :doc:`../user/rest-api`
- :doc:`../user/settings`
2 changes: 2 additions & 0 deletions docs/developer/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ completes successfully, just before the response is returned.
The ``view`` argument can also be used to access the ``request`` object
i.e. ``view.request``.

.. _radius_captive_portal_mock_views:

Captive portal mock views
-------------------------

Expand Down
2 changes: 2 additions & 0 deletions docs/user/rest-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,8 @@ stop_time Stop time (less or equal to)
is_open If stop_time is null
================== ================================

.. _radius_user_api_endpoints:

User API Endpoints
------------------

Expand Down
2 changes: 1 addition & 1 deletion openwisp_radius/admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ class RadiusBatchAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
'giving out the credentials.'
),
'documentation_url': (
'https://openwisp-radius.readthedocs.io/en/latest/user/importing_users.html'
'Read https://openwisp.io/docs/dev/radius/user/importing_users.html'
),
}

Expand Down
2 changes: 1 addition & 1 deletion openwisp_radius/base/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if 'csvfile' in self.fields:
docs_link = (
'https://openwisp-radius.readthedocs.io/en/latest'
'Read https://openwisp.io/docs/dev/radius'
'/user/importing_users.html'
)
help_text = f"Refer to the <b><u><a href='{docs_link}'>docs</a></u></b> \
Expand Down
2 changes: 1 addition & 1 deletion openwisp_radius/tests/test_admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ 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-radius.readthedocs.io/en/latest'
'Read https://openwisp.io/docs/dev/radius'
'/user/importing_users.html'
)
self.assertContains(response, docs_link)
Expand Down

0 comments on commit baf4ff4

Please sign in to comment.