2021-06-10 22:22:42 +00:00
[](https://github.com/freifunk-gluon/gluon/actions/workflows/build-gluon.yml)
[](https://opensource.org/licenses/BSD-2-Clause)
[](https://github.com/freifunk-gluon/gluon/releases/latest)
2021-06-10 22:32:39 +00:00
# Gluon
Gluon is a firmware framework to build preconfigured OpenWrt images for public mesh networks.
## Getting started
We have a huge amount of documentation over at https://gluon.readthedocs.io/.
2015-07-10 16:15:25 +00:00
If you're new to Gluon and ready to get your feet wet, have a look at the
2018-12-07 20:40:55 +00:00
[Getting Started Guide ](https://gluon.readthedocs.io/en/latest/user/getting_started.html ).
2015-07-10 16:15:25 +00:00
2019-02-07 00:53:18 +00:00
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 )
2021-12-30 22:51:40 +00:00
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 ).
2015-07-10 16:15:25 +00:00
## Issues & Feature requests
2016-01-09 21:17:53 +00:00
Before opening an issue, make sure to check whether any existing issues
2015-07-10 16:15:25 +00:00
(open or closed) match. If you're suggesting a new feature, drop by on IRC or
our mailinglist to discuss it first.
2016-05-03 17:30:43 +00:00
We maintain a [Roadmap ](https://github.com/freifunk-gluon/gluon/wiki/Roadmap ) for
the future development of Gluon.
2015-07-10 16:15:25 +00:00
## Use a release!
2016-01-09 21:17:53 +00:00
Please refrain from using the `master` branch for anything else but development purposes!
2017-07-10 20:58:15 +00:00
Use the most recent release instead. You can list all releases by running `git tag`
2021-06-10 20:34:00 +00:00
and switch to one by running `git checkout v2021.1 && make update` .
2015-07-10 16:15:25 +00:00
If you're using the autoupdater, do not autoupdate nodes with anything but releases.
2021-06-10 22:32:39 +00:00
If you upgrade using random master commits the nodes *might break* eventually.
2015-07-10 16:15:25 +00:00
## Mailinglist
To subscribe to the list, send a message to:
2016-11-05 11:29:09 +00:00
gluon+subscribe@luebeck.freifunk.net
2015-07-10 16:15:25 +00:00
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:
2016-11-05 11:29:09 +00:00
gluon+unsubscribe@luebeck.freifunk.net
