Skip to content

Commit

Permalink
[req-changes] Made requested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
pandafy committed May 24, 2024
1 parent f1c9709 commit d091e6f
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 23 deletions.
4 changes: 2 additions & 2 deletions developer/hacking-openwisp-python-django.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Django Debug Toolbar
The `Django Debug Toolbar <https://django-debug-toolbar.readthedocs.io/>`_
is a configurable set of panels which display various debug information
about the current HTTP request/response and, when clicked, display more
details about the panels content.
details about the panel's content.

It can be installed with:

Expand Down Expand Up @@ -262,7 +262,7 @@ but this is already done in ``settings.py``. Here's what
INTERNAL_IPS = ['127.0.0.1']
To complete the process, the Debug Toolbars URL needs to be added
To complete the process, the Debug Toolbar's URL needs to be added
to the URLconf of ``openwisp-controller`` as shown in `this
<https://django-debug-toolbar.readthedocs.io/en/latest/installation.html>`_
tutorial but this is already present in the last lines of ``urls.py``:
Expand Down
4 changes: 2 additions & 2 deletions general/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Server Side

- `OpenWISP Users <https://github.com/openwisp/openwisp-users>`_:
User management, multi-tenancy, authentication backend,
REST API utilities and classes to implement multi-tenancy..
REST API utilities and classes to implement multi-tenancy.

- `OpenWISP Controller <https://github.com/openwisp/openwisp-controller>`_:
Configuration management and templating,
Expand Down Expand Up @@ -172,7 +172,7 @@ Main Technologies Used
Python
~~~~~~

`Python <https://www.python.org/>`_ it's the main programming language
`Python <https://www.python.org/>`_ is the main programming language
used by the server side application (web admin, API, controller, workers).

In the past OpenWISP was built on Ruby On Rails, but we later switched
Expand Down
4 changes: 2 additions & 2 deletions general/code-of-conduct.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ within our community:
- Sexist, racist, homophobic, transphobic,
ableist or otherwise discriminatory jokes and language.
- Posting or displaying sexually explicit or violent material.
- Posting or threatening to post other peoples personally identifying
- Posting or threatening to post other people's personally identifying
information ("doxing").
- Personal insults, particularly those related to gender, sexual
orientation, race, religion, or disability.
- Inappropriate photography or recording.
- Inappropriate physical contact. You should have someones consent
- Inappropriate physical contact. You should have someone's consent
before touching them.
- Unwelcome sexual attention. This includes, sexualized comments
or jokes; inappropriate touching, groping, and unwelcomed sexual
Expand Down
2 changes: 1 addition & 1 deletion general/press.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Interview for `GARRTV <https://www.garr.tv>`_ by Davide Guerri
Blog Posts
----------

- `How Bottom-up Broadband will overcome the ‘last mile problem
- `How Bottom-up Broadband will overcome the ‘last mile' problem
<https://blog.p2pfoundation.net/how-bottom-up-broadband-will-overcome-
the-last-mile-problem/2013/07/23>`_
- `netjsonconfig: convert NetJSON to OpenWRT UCI
Expand Down
20 changes: 14 additions & 6 deletions tutorials/demo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ This firmware can help you quickly get started and test
the core features of OpenWISP Cloud.

If you prefer to use your existing firmware,
please refer to the alternative instructions by reading
:ref:`the alternative firmware instructions
please refer to the :ref:`the alternative firmware instructions
<alternative_firmware_instructions>`.

1. Downloading the firmware
Expand All @@ -75,9 +74,8 @@ You can `Flash the firmware via web UI
or via `other means available on OpenWrt
<https://openwrt.org/docs/guide-user/installation/generic.flashing>`_.

Make sure not to keep settings as shown in
(supply the ``-n`` command line option to sysupgrade, for the web UI
there is a specific checkbox).
Make sure not to keep settings: supply the ``-n`` command line option to
sysupgrade, for the web UI there is a specific checkbox.

.. _alternative_firmware_instructions:

Expand Down Expand Up @@ -185,7 +183,7 @@ connected to the internet, then it will automatically register and appear
in the list of available devices for the demo organization.
You will then be able to locate the device by its MAC address,
as shown in the screenshot above, or by its name if you have changed
it from OpenWrt to something else.
it from "OpenWrt" to something else.

At this point, the device should have already downloaded and applied
the configuration. After a few minutes the management tunnel will be
Expand Down Expand Up @@ -268,3 +266,13 @@ on the tab *Contact support* as indicated in the screenshot below.

.. image:: ../images/demo/contact-support.png
:target: ../_images/contact-support.png

Next steps
----------

- :doc:`Open and/or WPA protected WiFi Access Point SSID
<./wifi-access-point>`
- :doc:`WiFi Hotspot, Captive Portal (Public WiFi), Social Login
<./hotspot>`
- :doc:`How to Set Up a Wireless Mesh Network
<./mesh>`
6 changes: 4 additions & 2 deletions tutorials/hotspot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ through the public internet, ensuring security, privacy, and
mitigating potential legal risks associated with exposing
users' personal information to malicious actors.

Enable Captive Portal Template
------------------------------

.. image:: ../images/demo/captive-portal-demo.png
:target: ../_images/captive-portal-demo.png
Expand Down Expand Up @@ -96,7 +98,7 @@ following screenshot:
This page communicates that the user can now use the internet
provided by the hotspot, it also provides the following features:

- It shows a list of the users sessions, including the start time,
- It shows a list of the user's sessions, including the start time,
stop time, duration, traffic consumed (download and upload),
and the MAC address of the device that accessed the WiFi service.
- It allows the account password and phone number (if SMS verification is
Expand Down Expand Up @@ -254,7 +256,7 @@ Follow these steps to try the *paid WiFi subscription* feature:

- Sign up for one of the non-free plans.
- Enter your real email address and dummy personal information.
- Click Proceed with the payment.
- Click "Proceed with the payment."
- Enter the following paypal credentials:
``[email protected]`` / ``tester123`` and click on
"start session".
Expand Down
14 changes: 7 additions & 7 deletions user/configure-device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Refer to the instructions described in
2. Flash OpenWRT on a device
----------------------------

If you have a network device which is compatible with OpenWRT, follow the
If you have a network device which is compatible with OpenWRT, follow the
instructions in the `official OpenWRT flashing guide
<https://openwrt.org/docs/guide-user/installation/generic.flashing>`_.

Expand Down Expand Up @@ -63,7 +63,7 @@ clipboard, then run the following commands on your OpenWrt device:
opkg update
opkg install ./<file-just-downloaded>
If youre running at least OpenWRT 19.07, you can install openwisp-config
If you're running at least OpenWRT 19.07, you can install openwisp-config
from the official OpenWRT packages:

.. code-block:: bash
Expand All @@ -84,7 +84,7 @@ controller. To do that, edit the config file located at

You will see the default config file, as shown below.
If your instance lacks some of the lines shown in the example below,
please add them.
please add them.

.. code-block:: text
Expand Down Expand Up @@ -117,10 +117,10 @@ If your instance lacks some of the lines shown in the example below,
Uncomment and change the following fields:

- ``url``: the hostname of your OpenWISP2 controller. For example, if you
- ``url``: the hostname of your OpenWISP controller. For example, if you
are hosting your OpenWISP server locally and you set the IP Address to
192.168.56.2, the url would be ``https://192.168.56.2``.
- ``verify_ssl``: set to ``'0'`` if your controllers SSL certificate is
"192.168.56.2", the url would be ``https://192.168.56.2``.
- ``verify_ssl``: set to ``'0'`` if your controller's SSL certificate is
self-signed; in production you will need a valid SSL certificate to
keep your instance secure
- ``shared_secret``: you can retrieve this from the OpenWISP2 admin
Expand All @@ -146,7 +146,7 @@ Save the file and start openwisp-config:
/etc/init.d/openwisp_config restart
Your OpenWRT instance should register itself to your OpenWISP2 controller.
Your OpenWRT instance should register itself to your OpenWISP controller.
Check the devices menu on the admin panel to make sure your OpenWRT
device is registered.

Expand Down
2 changes: 1 addition & 1 deletion user/monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ In this scenario, the following requirements are needed:
If the OpenWISP server is connected to a network infrastructure
which allows it to reach the devices via pre-existing tunneling or
Intranet solutions (eg: MPLS, SD-WAN), then setting up a VPN server
is not needed, as long as theres a dedicated interface on OpenWrt
is not needed, as long as there's a dedicated interface on OpenWrt
which has an IP address assigned to it and which is reachable from
the OpenWISP server.

Expand Down

0 comments on commit d091e6f

Please sign in to comment.