Initial commit

Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = FFBSNetworkDocumentation
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

source/conf.py

+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'FFBS Network Documentation'
+copyright = '2018, Rouven Czerwinski'
+author = 'Rouven Czerwinski'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.todo',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FFBSNetworkDocumentationdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'FFBSNetworkDocumentation.tex', 'FFBS Network Documentation Documentation',
+     'Rouven Czerwinski', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ffbsnetworkdocumentation', 'FFBS Network Documentation Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'FFBSNetworkDocumentation', 'FFBS Network Documentation Documentation',
+     author, 'FFBSNetworkDocumentation', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
\ No newline at end of file

source/development.rst

+=============
+ Development
+=============
+Here we describe the development workflow for the new network system.
+
+Repositories
+============
+Descriptions of the available development repositories.
+
+ffbs-documentation
+------------------
+The FFBS network documentation. This repository contains the documentation you are
+reading at the moment.
+
+`https://gitli.stratum0.org/ffbs/ffbs-documentation <https://gitli.stratum0.org/ffbs/ffbs-documentation>`_
+
+ffbs-ansible
+------------
+The ffbs-ansible repository contains the ansible configuration files. These are
+used to setup nodes as a concentrator or exit node type.
+
+`https://gitli.stratum0.org/ffbs/ffbs-ansible <https://gitli.stratum0.org/ffbs/ffbs-ansible>`_
+
+ffbs-packages
+-------------
+The gluon FFBS packages. These are the packages required for the new network,
+e.g. packaging of the lua scripts for gluon.
+
+`https://gitli.stratum0.org/ffbs/ffbs-packages <https://gitli.stratum0.org/ffbs/ffbs-packages>`_
+
+ffbs-site
+---------
+The gluon FFBS site configuration. This contains the initial configuration,
+development takes place on the next branch.
+
+`https://gitli.stratum0.org/ffbs/ffbs-site/tree/next <https://gitli.stratum0.org/ffbs/ffbs-site/tree/next>`_
+

source/index.rst

+.. FFBS Network Documentation documentation master file, created by
+   sphinx-quickstart on Wed Mar  7 19:17:02 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the FFBS Network documentation!
+==========================================
+
+.. toctree::
+   overview
+   services
+   development
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

source/overview.rst

+============
+ Node Types
+============
+This section describes the different node types used in the network.
+
+Concentrator
+============
+The concentrators provides persistent storage functionalities for the network
+and routes traffic from its connected clients to an exit node. The concentrator
+provides the configuration for the client node type via the etcd service.
+
+Exit
+====
+Exit nodes are the edge nodes which provide internet access to the FFBS network.
+The use Freifunk Rheinland as the exit network and need to provide NAT for this
+service.
+
+Client
+======
+Client nodes provide network access to the end users. This is done either via a
+wireless service as an AP or to a local LAN via a seperate ethernet port on the
+node. Client nodes are usually embedded wireless routers flashed with the FFBS
+firmware.
+

source/services.rst

+=============================
+ Services and Infrastructure
+=============================
+This section provides a basic description of the used software packages in the
+FFBS network.
+
+Etcd
+====
+Etcd provides a clustered key-value store accessible via http(s). It is used
+between the concentrator nodes to provide configuration storage for the network.
+
+Wireguard
+=========
+Wireguard is a new in kernel VPN solution (`project link
+<http://www.wireguard.org/>`_). It is much faster than the fastd tunelling
+solution in the old network and should provide faster client networking speeds.
+
+Lua
+===
+The Lua programming language is used extensively on the client nodes, e.g. to
+retrieve the client configuration and configure the router accordingly.
+
+Python
+======
+Python is used in the backend services, e.g. expose endpoints for the client
+configuration retrieval. The backend services talk to the etcd service via a
+localhost connection.
+
+gluon
+=====
+GLuon