Skip to content

Commit 35067c8

Browse files
committed
[docs] Default to LEDE 17.01
1 parent 4094a03 commit 35067c8

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.rst

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ openwisp-config
1010

1111
------------
1212

13-
OpenWRT/LEDE configuration agent for the new `OpenWISP2 Controller <https://github.com/openwisp/ansible-openwisp2>`_.
13+
`LEDE <https://lede-project.org/>`_ / `OpenWRT <https://openwrt.org/>`_ configuration agent for the new
14+
`OpenWISP 2 Controller <https://github.com/openwisp/ansible-openwisp2>`_.
1415

1516
.. image:: http://netjsonconfig.openwisp.org/en/latest/_images/openwisp.org.svg
1617
:target: http://openwisp.org
@@ -42,7 +43,7 @@ For a list of the latest built images, take a look at `downloads.openwisp.org
4243
<http://downloads.openwisp.org/openwisp-config/>`_.
4344

4445
**If you need to compile the package yourself**, see `Compiling openwisp-config`_
45-
and `Compiling a custom OpenWRT / LEDE image`_.
46+
and `Compiling a custom LEDE / OpenWRT image`_.
4647

4748
Once installed *openwisp-config* needs to be configured (see `Configuration options`_)
4849
and then started with::
@@ -88,7 +89,7 @@ When the registration is completed, the agent will automatically set ``uuid`` an
8889
in ``/etc/config/openwisp``.
8990

9091
To enable this feature by default on your firmware images, follow the procedure described in
91-
`Compiling a custom OpenWRT / LEDE image`_.
92+
`Compiling a custom LEDE / OpenWRT image`_.
9293

9394
Consistent key generation
9495
-------------------------
@@ -187,8 +188,8 @@ The following procedure illustrates how to compile all the *openwisp-config* var
187188

188189
.. code-block:: shell
189190
190-
git clone https://github.com/openwrt/openwrt.git
191-
cd openwrt
191+
git clone git://git.lede-project.org/source.git lede
192+
cd lede
192193
193194
# configure feeds
194195
cp feeds.conf.default feeds.conf
@@ -214,8 +215,8 @@ you will need to select the *openwisp-config* variant by going to ``Administrati
214215

215216
.. code-block:: shell
216217
217-
git clone git://git.openwrt.org/openwrt.git
218-
cd openwrt
218+
git clone git://git.lede-project.org/source.git lede
219+
cd lede
219220
220221
# configure feeds
221222
cp feeds.conf.default feeds.conf
@@ -224,38 +225,40 @@ you will need to select the *openwisp-config* variant by going to ``Administrati
224225
./scripts/feeds install -a
225226
make menuconfig
226227
# go to Administration > openwisp and select the variant you need interactively
228+
make -j1 V=s
227229
228-
Compiling a custom OpenWRT / LEDE image
229-
-------------------------------------
230+
Compiling a custom LEDE / OpenWRT image
231+
---------------------------------------
230232

231233
If you are managing many devices and customizing your ``openwisp-config`` configuration by hand on
232-
each new device, you should switch to using a custom OpenWRT/LEDE firmware image that includes
234+
each new device, you should switch to using a custom LEDE / OpenWRT firmware image that includes
233235
``openwisp-config`` and its precompiled configuration file, this strategy has a few important benefits:
234236

235237
* you can save yourself the effort of installing and configuring ``openwisp-config`` con each device
236238
* you can enable `Automatic registration`_ by setting ``shared_secret``,
237239
hence saving extra time and effort to register each device on the controller app
238240
* if you happen to reset the firmware to initial settings, these precompiled settings will be restored as well
239241

240-
The following procedure illustrates how to compile a custom OpenWRT image with a precompiled minimal
241-
``/etc/config/openwisp`` file:
242+
The following procedure illustrates how to compile a custom `LEDE 17.01 <https://lede-project.org>`_
243+
image with a precompiled minimal ``/etc/config/openwisp`` configuration file:
242244

243245
.. code-block:: shell
244246
245-
git clone https://github.com/openwrt/openwrt.git
246-
cd openwrt
247+
git clone git://git.lede-project.org/source.git lede
248+
cd lede
249+
git checkout lede-17.01
247250
248251
# include precompiled file
249252
mkdir -p files/etc/config
250253
cat <<EOF > files/etc/config/openwisp
251254
config controller 'http'
252-
# change the values of the following 2 options
253-
option url 'openwisp2.mydomain.com'
254-
option shared_secret 'mysharedsecret'
255-
list unmanaged 'system.@led'
256-
list unmanaged 'network.loopback'
257-
list unmanaged 'network.@switch'
258-
list unmanaged 'network.@switch_vlan'
255+
# change the values of the following 2 options
256+
option url 'openwisp2.mydomain.com'
257+
option shared_secret 'mysharedsecret'
258+
list unmanaged 'system.@led'
259+
list unmanaged 'network.loopback'
260+
list unmanaged 'network.@switch'
261+
list unmanaged 'network.@switch_vlan'
259262
EOF
260263
261264
# configure feeds

0 commit comments

Comments
 (0)