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
de8c908d
Commit
de8c908d
authored
9 years ago
by
ruben
Committed by
Matthias Schiffer
9 years ago
Browse files
Options
Downloads
Patches
Plain Diff
docs: grammar and formatting enhanced in site.conf
parent
5ecb8a73
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/user/site.rst
+15
-13
15 additions, 13 deletions
docs/user/site.rst
with
15 additions
and
13 deletions
docs/user/site.rst
+
15
−
13
View file @
de8c908d
...
@@ -95,14 +95,16 @@ wifi24 : optional
...
@@ -95,14 +95,16 @@ wifi24 : optional
This will only affect new installations.
This will only affect new installations.
Upgrades will not changed the disabled state.
Upgrades will not changed the disabled state.
``ap`` requires a single parameter, a string, named ``ssid`` which sets the interface's ESSID.
``ap`` requires a single parameter, a string, named ``ssid`` which sets the
interface's ESSID.
``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id.
``mesh`` requires a single parameter, a string, named ``id`` which sets the mesh id.
``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC).
``ibss`` requires two parametersr: ``ssid`` (a string) and ``bssid`` (a MAC).
An optional parameter ``vlan`` (integer) is supported.
An optional parameter ``vlan`` (integer) is supported.
Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for setting the default multicast datarate.
Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for
setting the default multicast datarate.
::
::
wifi24 = {
wifi24 = {
...
@@ -156,10 +158,10 @@ fastd_mesh_vpn
...
@@ -156,10 +158,10 @@ fastd_mesh_vpn
The `enabled` option can be set to true to enable the VPN by default.
The `enabled` option can be set to true to enable the VPN by default.
If `configurable` is `false` or unset, the method list will be replaced on updates
If `configurable` is
set to
`false` or unset, the method list will be replaced on updates
with the list
in
the site configuration. Setting `configurable` to `true` will allow the user to
with the list
from
the site configuration. Setting `configurable` to `true` will allow the user to
add the method ``null`` to the
front
of the method list or remove ``null`` from it,
add the method ``null`` to the
beginning
of the method list or remove ``null`` from it,
and make this change survive updates. Setting
s
configurable is necessary for the
and make this change survive updates. Setting
`
configurable
`
is necessary for the
package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration.
package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration.
In any case, the ``null`` method should always be the first method in the list
In any case, the ``null`` method should always be the first method in the list
...
@@ -169,8 +171,8 @@ fastd_mesh_vpn
...
@@ -169,8 +171,8 @@ fastd_mesh_vpn
fastd_mesh_vpn = {
fastd_mesh_vpn = {
methods = {'salsa2012+umac'},
methods = {'salsa2012+umac'},
-- enabled = true,
-- enabled = true,
-- configurable = true,
-- configurable = true,
mtu = 1280,
mtu = 1280,
groups = {
groups = {
backbone = {
backbone = {
...
@@ -225,9 +227,9 @@ autoupdater : package
...
@@ -225,9 +227,9 @@ autoupdater : package
}
}
roles : optional
roles : optional
Optional role definitions.
With this n
odes will announce their role inside the mesh.
Optional role definitions.
N
odes will announce their role inside the mesh.
In the backend this adds the facility
to distinguish between normal, backbone and
This will allow in the backend
to distinguish between normal, backbone and
service nodes or even gateways (if they advertise th
e
role
, also
). It is up to
service nodes or even gateways (if they advertise th
at
role). It is up to
the community which roles to define. See the section below as an example.
the community which roles to define. See the section below as an example.
``default`` takes the default role which is set initially. This value should be
``default`` takes the default role which is set initially. This value should be
part of ``list``. If you want node owners to change the role via config mode add
part of ``list``. If you want node owners to change the role via config mode add
...
@@ -279,7 +281,7 @@ The ``site.mk`` is a Makefile which should define constants
...
@@ -279,7 +281,7 @@ The ``site.mk`` is a Makefile which should define constants
involved in the build process of Gluon.
involved in the build process of Gluon.
GLUON_SITE_PACKAGES
GLUON_SITE_PACKAGES
Defines a list of packages which should installed
in
addition
Defines a list of packages which should
be
installed addition
ally
to the ``gluon-core`` package.
to the ``gluon-core`` package.
GLUON_RELEASE
GLUON_RELEASE
...
@@ -290,7 +292,7 @@ GLUON_PRIORITY
...
@@ -290,7 +292,7 @@ GLUON_PRIORITY
for more information).
for more information).
GLUON_LANGS
GLUON_LANGS
List of languages (as two-letter-codes) to include
for
the web interface. Should always contain
List of languages (as two-letter-codes) to
be
include
d in
the web interface. Should always contain
``en``.
``en``.
.. _site-config-mode-texts:
.. _site-config-mode-texts:
...
...
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