forked from freifunk-gluon/gluon
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
75c73a5
commit ec3141b
Showing
1 changed file
with
23 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,39 @@ | ||
| [](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml) | ||
| [](https://opensource.org/license/bsd-2-clause/) | ||
| [](https://github.com/freifunk-gluon/gluon/releases/latest) | ||
|
|
||
| # Gluon | ||
|
|
||
| Gluon is a firmware framework to build preconfigured OpenWrt images for public mesh networks. | ||
|
|
||
| ## Overview | ||
| ## Gluon-Parker | ||
|
|
||
| Gluon provides an easy-to-use firmware for a public, decentral WLAN and/or wire based mesh network. | ||
| Common network capable devices, like smartphones, laptops or desktop PCs can connect to the mesh network and communicate over it, without the need of passwords for access and without the need of installing special software. | ||
| Additionally, internet access and merging mesh clouds can be accomplished over a WAN through VPN connected gateways. | ||
| This is a fork of Gluon, that uses routing between the nodes (aka. Router devices) and the infrastructure. | ||
| It is currently in use by [Freifunk Braunschweig](https://freiunk-bs.de). | ||
| Other communities are interested in adopting it as well. | ||
|
|
||
| Gluon's features include: | ||
| Documentation is currently sparse. | ||
| Some hints can be found here: | ||
|
|
||
| * a decentral mesh network | ||
| * easy configuration mode for less techy users | ||
| * community-specific technical settings and customizations through a common site.conf and site.mk | ||
| * ecdsa signature-based autoupdater | ||
| * node status web page | ||
| * publication of node information + statistics through respondd | ||
| * a variety of preconfigured mesh and VPN protocols: | ||
| * https://media.ccc.de/v/35c3oio-69-project-parker-klassisches-routing-fr-freifunk | ||
| * https://freifunk-bs.de/parker.html | ||
|
|
||
| Not all features needed for a parker-style Gluon are currently upstream - they are kept in this repository. | ||
| In this repository we will keep a branch for every upstream development branch with our local changes on top. | ||
| These branches follow the upstream naming, so `v2023.2.x-parker` will track `v2023.2.x`. | ||
| Releases will be tagged with an additional suffix: Tag `v2023.2.4.1-parker` will be on top of `v2023.2.4`. | ||
|
|
||
| Supported mesh protocols: | ||
| We are planning to bring all these changes into upstream Gluon. | ||
| Feel free to help! | ||
|
|
||
| * batman-adv (BATMAN IV fully, BATMAN V partially) | ||
| * OLSRv2 (partially) | ||
| Other packages needed for a parker-style Gluon are developed in the [community-packages](https://github.com/freifunk-gluon/community-packages) repository. | ||
| They are named `ffbs-parker-*`. | ||
|
|
||
| A parker-style network needs a different backend. | ||
| You can get some inspiration from [here](https://gitli.stratum0.org/ffbs/ffbs-ansible). | ||
|
|
||
| Supported protocols for node-to-node connections: | ||
| ## Contributing | ||
|
|
||
| * WLAN: 802.11s (with forwarding disabled) | ||
| * WAN: VPNs via fastd and Wireguard | ||
| * LAN: via VXLAN | ||
| Pull Requests against this repo are welcome! | ||
| (Please only pull-request against changes done in this repository | ||
| All other Pull Requests should go to directly to Gluon.) | ||
|
|
||
| ## Getting started | ||
|
|
||
| We have a huge amount of documentation over at https://gluon.readthedocs.io/. | ||
|
|
||
| If you're new to Gluon and ready to get your feet wet, have a look at the | ||
| [Getting Started Guide](https://gluon.readthedocs.io/en/latest/user/getting_started.html). | ||
|
|
||
| Gluon's developers frequent an IRC chatroom at [#gluon](ircs://irc.hackint.org/#gluon) | ||
| on [hackint](https://hackint.org/). There is also a [webchat](https://webirc.hackint.org/#irc://irc.hackint.org/#gluon) | ||
| that allows for uncomplicated access from within your browser. This channel is also available as a bridged Matrix Room at [#gluon:hackint.org](https://matrix.to/#/#gluon:hackint.org). | ||
|
|
||
| ## Issues & Feature requests | ||
|
|
||
| Before opening an issue, make sure to check whether any existing issues | ||
| (open or closed) match. If you're suggesting a new feature, drop by on IRC or | ||
| our mailinglist to discuss it first. | ||
|
|
||
| We maintain a [Roadmap](https://github.com/freifunk-gluon/gluon/wiki/Roadmap) for | ||
| the future development of Gluon. | ||
|
|
||
| ## Use a release! | ||
|
|
||
| Please refrain from using the `master` branch for anything else but development purposes! | ||
| Use the most recent release instead. You can list all releases by running `git tag` | ||
| and switch to one by running `git checkout v2023.2.4 && make update`. | ||
|
|
||
| If you're using the autoupdater, do not autoupdate nodes with anything but releases. | ||
| If you upgrade using random master commits the nodes *might break* eventually. | ||
|
|
||
| ## Mailinglist | ||
|
|
||
| To subscribe to the list, send a message to: | ||
|
|
||
| gluon+subscribe@luebeck.freifunk.net | ||
|
|
||
| To remove your address from the list, just send a message to | ||
| the address in the `List-Unsubscribe` header of any list | ||
| message. If you haven't changed addresses since subscribing, | ||
| you can also send a message to: | ||
|
|
||
| gluon+unsubscribe@luebeck.freifunk.net | ||
| Please be aware that we may rebase our branches on top of upstream without a PR 🫠. |