https://github.com/freifunkmuc/site-ffm
Freifunk München specific Gluon configuration
https://github.com/freifunkmuc/site-ffm
freifunk gluon hacktoberfest openwrt
Last synced: 6 months ago
JSON representation
Freifunk München specific Gluon configuration
- Host: GitHub
- URL: https://github.com/freifunkmuc/site-ffm
- Owner: freifunkMUC
- Created: 2014-06-26T00:12:23.000Z (over 11 years ago)
- Default Branch: gluon-v2023.2.x
- Last Pushed: 2025-04-10T07:25:15.000Z (6 months ago)
- Last Synced: 2025-04-10T08:30:35.776Z (6 months ago)
- Topics: freifunk, gluon, hacktoberfest, openwrt
- Language: Lua
- Homepage:
- Size: 1.27 MB
- Stars: 17
- Watchers: 9
- Forks: 28
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Dependencies
* git
* GNU make
* GNU patch
* [Upstream Gluon dependencies](https://gluon.readthedocs.io/en/latest/user/getting_started.html#dependencies)
For convenience, you can find a script to install those dependencies on an Ubuntu-based distribution:\
[install_build_dependencies.sh](scripts/install_build_dependencies.sh)
## Building
Check out this repository and execute `make`, i.e. like this:
```bash
git clone https://github.com/freifunkMUC/site-ffm.git site-ffm
cd site-ffm
git checkout -b patched && git checkout stable
make
```
### Containerised building
As the CI is using Ubuntu, only the Ubuntu dependencies are being tracked. To simplify building on other distros, containerised building is also possible:
```sh
docker build -t site-ffm-$(git rev-parse --abbrev-ref HEAD) -f Dockerfile_build .
```
This will build the build Docker image. With the following export, the Makefile will then use the repo for building but will run inside an Ubuntu container.\
**Note**: If the working directory is a git worktree, add a volume mount for the main git folder.
```sh
mkdir -p gluon-build output
docker run --rm -v $(pwd):/site-ffm:ro -v $(pwd)/gluon-build:/site-ffm/gluon-build:rw -v $(pwd)/output:/site-ffm/output:rw -w /site-ffm -u $UID site-ffm-$(git rev-parse --abbrev-ref HEAD) make
```
#### Example
Full command for a [lantiq-xrx200](https://github.com/freifunk-gluon/gluon/blob/v2022.1/targets/lantiq-xrx200) build:
```sh
mkdir -p logs gluon-build output
docker run --rm -v $(pwd):/site-ffm:ro -v $(pwd)/gluon-build:/site-ffm/gluon-build:rw -v $(pwd)/output:/site-ffm/output:rw -w /site-ffm -u $UID site-ffm-$(git rev-parse --abbrev-ref HEAD) make V=s GLUON_TARGETS=lantiq-xrx200 |& tee logs/build_lantiq-xrx200_$(date --iso=s).log
```
## Further Resources
This firmware is based on [Gluon](https://gluon.readthedocs.io/).
Look at the [site configuration related Gluon documentation](https://gluon.readthedocs.io/en/latest/user/site.html)
for information on site configuration options and examples from other communities.