https://github.com/izer-xyz/openwrt-imagebuilder-action
OpenWrt ImageBuilder Github Action
https://github.com/izer-xyz/openwrt-imagebuilder-action
github-actions imagebuilder openwrt
Last synced: 11 months ago
JSON representation
OpenWrt ImageBuilder Github Action
- Host: GitHub
- URL: https://github.com/izer-xyz/openwrt-imagebuilder-action
- Owner: izer-xyz
- License: mit
- Created: 2023-01-09T03:38:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T05:58:08.000Z (over 2 years ago)
- Last Synced: 2025-07-03T01:18:50.379Z (12 months ago)
- Topics: github-actions, imagebuilder, openwrt
- Language: Shell
- Homepage:
- Size: 143 KB
- Stars: 11
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openwrt-imagebuilder-action
Build and [OpenWrt](https://openwrt.org) firmware image using [Imagebuilder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder).
# Usage
Use template repo: [openwrt-imagebuilder-action-template](https://github.com/izer-xyz/openwrt-imagebuilder-action-template)
See [action.yml](action.yml) from more details.
Parameters
* `image`: bcm27xx-bcm2711
* `profile`: Default
* `openwrt-version`: 22.03.5
* `packages`: -ppp
* `files`: test/files
* `disabled-services`: dhcp
Outputs
* *`./bin/*`*
* e.g. `./bin/squashfs-factory.img.gz`
An example workflow creating a very basic (packages removed; [custom files](test/files) added) image and then running with Qemu
* [.github/workflows/test.yml](.github/workflows/test.yml)
### Build a firmware image without ppp package
```yaml
steps:
- uses: izer-xyz/openwrt-imagebuilder-action@v1
with:
image: bcm27xx-bcm2711
openwrt-version: 22.03.5
packages: -ppp
```
### Add custom files
```yaml
steps:
- uses: izer-xyz/openwrt-imagebuilder-action@v1
with:
image: bcm27xx-bcm2711
openwrt-version: 22.03.5
files: test/files
```
# FAQ
### How to find `image` and `openwrt-version`
The Docker Hub [Imagebuilder tags](https://hub.docker.com/r/openwrtorg/imagebuilder/tags) are formatted `${image}-${openwrt-version}`. E.g.
* [*bcm27xx-bcm2711*-**22.03.5**](https://hub.docker.com/layers/openwrtorg/imagebuilder/bcm27xx-bcm2711-22.03.2/)
* `image`: *bcm27xx-bcm2711*
* `openwrt-version`: **22.03.5**
## Additional Documentation
* Run openwrt in Qemu
https://gist.github.com/extremecoders-re/f2c4433d66c1d0864a157242b6d83f67
https://fadeevab.com/how-to-setup-qemu-output-to-console-and-automate-using-shell-script/
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE).