Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
FFS Gluon
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
firmware
FFS Gluon
Commits
fe1b887f
Commit
fe1b887f
authored
8 years ago
by
Matthias Schiffer
Browse files
Options
Downloads
Patches
Plain Diff
docs: user/site: fix formatting of definition list
Newer versions of Sphinx would break lines at the colons.
parent
9260a8fa
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/user/site.rst
+12
-12
12 additions, 12 deletions
docs/user/site.rst
with
12 additions
and
12 deletions
docs/user/site.rst
+
12
−
12
View file @
fe1b887f
...
...
@@ -49,7 +49,7 @@ ntp_server
This NTP servers must be reachable via IPv6 from the nodes. If you don't want to set an IPv6 address
explicitly, but use a hostname (which is recommended), see also the :ref:`FAQ <faq-dns>`.
opkg : optional
opkg
\
: optional
``opkg`` package manager configuration.
There are two optional fields in the ``opkg`` section:
...
...
@@ -75,7 +75,7 @@ opkg : optional
- ``%GV`` is replaced by the Gluon version
- ``%GR`` is replaced by the Gluon release (as specified in ``site.mk``)
regdom : optional
regdom
\
: optional
The wireless regulatory domain responsible for your area, e.g.:
::
...
...
@@ -83,7 +83,7 @@ regdom : optional
Setting ``regdom`` in mandatory if ``wifi24`` or ``wifi5`` is defined.
wifi24 : optional
wifi24
\
: optional
WLAN configuration for 2.4 GHz devices.
``channel`` must be set to a valid wireless channel for your radio.
...
...
@@ -126,10 +126,10 @@ wifi24 : optional
},
},
wifi5 : optional
wifi5
\
: optional
Same as `wifi24` but for the 5Ghz radio.
next_node : package
next_node
\
: package
Configuration of the local node feature of Gluon
::
...
...
@@ -139,7 +139,7 @@ next_node : package
mac = 'ca:ff:ee:ba:be:00'
}
mesh : optional
mesh
\
: optional
Options specific to routing protocols.
At the moment, only the ``batman_adv`` routing protocol has such options:
...
...
@@ -223,13 +223,13 @@ fastd_mesh_vpn
},
}
mesh_on_wan : optional
mesh_on_wan
\
: optional
Enables the mesh on the WAN port (``true`` or ``false``).
mesh_on_lan : optional
mesh_on_lan
\
: optional
Enables the mesh on the LAN port (``true`` or ``false``).
autoupdater : package
autoupdater
\
: package
Configuration for the autoupdater feature of Gluon.
::
...
...
@@ -255,7 +255,7 @@ autoupdater : package
All configured mirrors must be reachable from the nodes via IPv6. If you don't want to set an IPv6 address
explicitly, but use a hostname (which is recommended), see also the :ref:`FAQ <faq-dns>`.
roles : optional
roles
\
: optional
Optional role definitions. Nodes will announce their role inside the mesh.
This will allow in the backend to distinguish between normal, backbone and
service nodes or even gateways (if they advertise that role). It is up to
...
...
@@ -279,7 +279,7 @@ roles : optional
},
},
setup_mode : package
setup_mode
\
: package
Allows skipping setup mode (config mode) at first boot when attribute
``skip`` is set to ``true``. This is optional and may be left out.
::
...
...
@@ -288,7 +288,7 @@ setup_mode : package
skip = true,
},
legacy : package
legacy
\
: package
Configuration for the legacy upgrade path.
This is only required in communities upgrading from Lübeck's LFF-0.3.x.
::
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment