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
12a2442a
Commit
12a2442a
authored
10 years ago
by
Matthias Schiffer
Browse files
Options
Downloads
Patches
Plain Diff
Documentation cleanup
parent
a15ad8fe
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/conf.py
+1
-1
1 addition, 1 deletion
docs/conf.py
docs/features/announce.rst
+4
-4
4 additions, 4 deletions
docs/features/announce.rst
docs/index.rst
+0
-10
0 additions, 10 deletions
docs/index.rst
docs/user/site.rst
+13
-0
13 additions, 0 deletions
docs/user/site.rst
with
18 additions
and
15 deletions
docs/conf.py
+
1
−
1
View file @
12a2442a
...
...
@@ -130,7 +130,7 @@ pygments_style = 'sphinx'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path
=
[
'
_static
'
]
#
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
...
...
This diff is collapsed.
Click to expand it.
docs/features/announce.rst
+
4
−
4
View file @
12a2442a
...
...
@@ -29,7 +29,7 @@ There are two packages responsible for distribution of the information. For
one, information is distributed across the mesh using alfred_. Information
between neighbouring nodes is exchanged using `gluon-announced`.
.. alfred: http://www.open-mesh.org/projects/alfred
..
_
alfred: http://www.open-mesh.org/projects/alfred
alfred (mesh bound)
~~~~~~~~~~~~~~~~~~~
...
...
@@ -41,7 +41,7 @@ retrieve the data you'll need both a local alfred daemon and alfred-json_
installed. Please note that at least one alfred daemon is required to run as
`master`.
.. alfred-json: https://github.com/tcatm/alfred-json
..
_
alfred-json: https://github.com/tcatm/alfred-json
`nodeinfo` is distributed as alfred datatype `158`, while `statistics` uses
`159`. Both are compressed using GZip (alfred-json can handle the decompression).
...
...
@@ -84,11 +84,11 @@ In order to retrieve statistics data you could run:
"node_id": "90f6523eb950",
"loadavg": 0.34000000000000002
}
}
}
You can find more information about alfred in its README_.
.. README
_
: http://www.open-mesh.org/projects/alfred/repository/revisions/master/entry/README
..
_
README: http://www.open-mesh.org/projects/alfred/repository/revisions/master/entry/README
gluon-announced
~~~~~~~~~~~~~~~
...
...
This diff is collapsed.
Click to expand it.
docs/index.rst
+
0
−
10
View file @
12a2442a
...
...
@@ -21,11 +21,9 @@ User Documentation
:maxdepth: 2
user/getting_started
user/features
user/site
user/builds
user/faq
user/admin
Features
--------
...
...
@@ -33,12 +31,7 @@ Features
.. toctree::
:maxdepth: 2
features/site-repo
features/configmode
features/dns
features/ntp
features/fastd
features/batman-adv
features/autoupdater
features/mesh-on-wan
features/announce
...
...
@@ -50,9 +43,6 @@ Developer Documentation
:maxdepth: 2
dev/basics
dev/architecture
dev/repositories
dev/packages
Indices and tables
==================
...
...
This diff is collapsed.
Click to expand it.
docs/user/site.rst
+
13
−
0
View file @
12a2442a
...
...
@@ -24,34 +24,41 @@ site_code
prefix4
The IPv4 Subnet of your community mesh network in CIDR notation, e.g.
::
prefix4 = '10.111.111.0/18'
prefix6
The IPv6 subnet of your community mesh network, e.g.
::
prefix6 = 'fdca::ffee:babe:1::/64'
timezone
The timezone of your community live in, e.g.
::
-- Europe/Berlin
timezone = 'CET-1CEST,M3.5.0,M10.5.0/3'
ntp_server
List of NTP servers available in your community or used by your community, e.g.:
::
ntp_servers = {'1.ntp.services.ffeh','2.tnp.services.ffeh'}
opkg_repo : optional
Overwrite the default ``opkg`` repository server, e.g.:
::
opkg_repo = 'http://opkg.services.ffeh/attitude_adjustment/12.09/%S/packages'
The `%S` is a variable, which is replaced with the platform of an device
during the build process.
regdom
The wireless regulatory domain responsible for your area, e.g.:
::
regdom = 'DE'
wifi24
...
...
@@ -61,6 +68,7 @@ wifi24
bssid ``mesh_bssid`` and the adhoc multicast rate ``mesh_mcast_rate``.
Combined in an dictionary, e.g.:
::
wifi24 = {
ssid = 'http://kiel.freifunk.net/',
channel = 11,
...
...
@@ -76,6 +84,7 @@ wifi5
next_node : package
Configuration of the local node feature of Gluon
::
next_node = {
ip4 = '10.23.42.1',
ip6 = 'fdca:ffee:babe:1::1',
...
...
@@ -86,6 +95,7 @@ next_node : package
fastd_mesh_vpn
Remote server setup for vpn.
::
fastd_mesh_vpn = {
methods = {'salsa2012+gmac'},
mtu = 1426,
...
...
@@ -106,6 +116,7 @@ mesh_on_wan : optional
autoupdater : package
Configuration for the autoupdater feature of Gluon.
::
autoupdater = {
enabled = 1,
branch = 'experimental',
...
...
@@ -129,6 +140,7 @@ autoupdater : package
simple_tc : package
Uplink traffic control
::
simple_tc = {
mesh_vpn = {
ifname = 'mesh-vpn',
...
...
@@ -145,6 +157,7 @@ legacy : package
Configuration for the legacy upgrade path.
This is only required in communities upgrading from Lübeck's LFF-0.3.x.
::
legacy = {
version_files = {'/etc/.freifunk_version_keep', '/etc/.eff_version_keep'},
old_files = {'/etc/config/config_mode', '/etc/config/ffeh', '/etc/config/freifunk'},
...
...
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