lede-dockerbuilder

KO | EN

gitlite — search

#hacktoberfest #react #golang #rust #linux #docker #nodejs #cli #kubernetes #vue #security #openai #mcp #open-source

lede-dockerbuilder

(★ 64)

A (container based) LEDE/OpenWrt image builder.

lede-dockerbuilder Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Containerized OpenWrt image builder

[![test](https://github.com/jandelgado/lede-dockerbuilder/actions/workflows/test.yml/badge.svg)](https://github.com/jandelgado/lede-dockerbuilder/actions/workflows/test.yml)

- [What](#what)
  - [Note](#note)
- [Why](#why)
- [How](#how)
  - [Using docker](#using-docker)
  - [Using nix-shell](#using-nix-shell)
  - [Usage](#usage)
    - [Builder runtime](#builder-runtime)
  - [Configuration file](#configuration-file)
  - [File system overlay](#file-system-overlay)
  - [Example directory structure](#example-directory-structure)
    - [Debugging](#debugging)
- [Examples](#examples)
  - [Building a x86_64 image and running it in Qemu](#building-a-x86_64-image-and-running-it-in-qemu)
- [Building an OpenWrt snapshot release](#building-an-openwrt-snapshot-release)
- [Author](#author)
- [License](#license)

## What

Easily and quickly build [OpenWrt](https://openwrt.org/) custom images (e.g.
for your embedded device or a Raspberry Pi) using a self-contained docker
container or a [nix-shell](https://nixos.wiki/wiki/Development_environment_with_nix-shell) and the [OpenWrt image
builder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder).
On the builder host, Docker, podman/buildah (for dockerless operation) or nix-shell is the
only requirement. Supports the latest OpenWrt release (25.12.4).

### Note

The OpenWrt imagebuilder uses pre-compiled packages to build the final image.
Go [here](https://github.com/jandelgado/lede-dockercompiler) if you are looking
for a docker images to compile OpenWrt completely from source.

## Why

- customized and optimized (size) images with your personal configurations
- full automatic image creation (could be run in CI)
- repeatable builds
- easy configuration, fast build

## How

### Using docker

```text
$ git clone https://github.com/jandelgado/lede-dockerbuilder.git
$ cd lede-dockerbuilder
$ ./builder.sh build-docker-image example-nexx-wt3020.conf
$ ./builder.sh build example-nexx-wt3020.conf
```

The `build-docker-image` command will first build the docker image containing
the actual image builder. The resulting docker image is per default tagged with
`openwrt-imagebuilder:<Release>-<Target>-<Subtarget>`. The `build` command
will afterwards run a container, which builds the actual OpenWrt image. The
final OpenWrt image will be available in the `output/` directory.

### Using nix-shell

```
$ git clone https://github.com/jandelgado/lede-dockerbuilder.git
$ cd lede-dockerbuilder
$ ./builder.sh build example-nexx-wt3020.conf --nix
```

Using `nix-shell` does not require building a container image or starting a
container first, therefore it is usually faster.

### Usage

```text
Dockerized LEDE/OpenWRT image builder.

Usage: ./builder.sh COMMAND CONFIGFILE [OPTIONS]
  COMMAND is one of:
    build-docker-image - build the docker image (run once first)
    profiles           - show available profiles for current configuration
    build              - start container and build the LEDE/OpenWRT image
    shell              - start shell in the build dir
  CONFIGFILE           - configuraton file to use

OPTIONS:
  -o OUTPUT_DIR        - output directory (default $OUTPUT_DIR)
  --docker-opts OPTS   - additional options to pass to docker run
                         (can occur multiple times)
  -f ROOTFS_OVERLAY    - rootfs-overlay directory (default $ROOTFS_OVERLAY)
  --sudo               - call container tool with sudo
  --podman             - use buildah and podman to build and run container
  --nerdctl            - use nerdctl to build and run container
  --docker             - use docker to build and run container (default)
  --nix                - build using nix-shell

command line options -o, -f override config file settings.

Example:
  # build the builder docker image first
  ./builder.sh build-docker-image example-glinet-gl-ar750.conf

# now build the OpenWrt image, overriding output and rootfs locations
  ./builder.sh build example-glinet-gl-ar750.conf -o output -f myrootfs

# show available profiles for the arch/target/subtarget of the given configuration
  ./builder.sh profiles example-glinet-gl-ar750.conf

# pass additional docker options: mount downloads to host directory during build
  ./builder.sh build example-glinet-gl-ar750.conf --docker-opts "-v=$(pwd)/dl:/lede/imagebuilder/dl:z"

# use nix to build the OpenWrt image, no need to build a container first
  ./builder.sh build example-x86_64.conf --nix
```

#### Builder runtime

- By default docker will be used to build and run the container.
- When called with `--podman` option, lede-dockerbuilder will use buildah and
  podman to build and run the container.
- When called with `--nerdctl` option, lede-dockerbuilder will use nerdctl to
  build and run the container.
- Use the `--sudo` option to run the container command with sudo.
- Use the `--nix` option to run the build in a [nix-shell](shell.nix) (instead
  of using a container runtime)

When using a container builder like docker, the build container will be newly
created on every build. When using the nix builder, the build environment will
be reused, which is usually faster. By default, the nix build environments are
installed in the `.build` directory, relative to the `builder.sh` script. This
can be overriden with the `NIX_BUILD_DIR` environment variable.

### Configuration file

The configuration file is quite self-explanatory. The following parameters are
mandatory (prefixed with `LEDE_` for historical reasons, config works also
with OpenWrt):

- `LEDE_TARGET` - Target architecture
- `LEDE_SUBTARGET` - Sub target architecture
- `LEDE_RELEASE` - Release to use
- `LEDE_PROFILE` - Profile to use
- `LEDE_PACKAGES` - list of packages to include/exclude. Prepend package to be excluded with `-`
- `LEDE_DISABLED_SERVICES` - list of services to disable on startup in /etc/init.d

`LEDE_TARGET`, `LEDE_SUBTARGET` and `LEDE_RELEASE` are used to construct the
URL of the image builder binary well as for the construction for the tag of the
docker image.

You can find the proper values by browsing the OpenWrt website e.g.
[here](https://openwrt.org/docs/techref/targets/start) and
[here](https://openwrt.org/toh/views/toh_admin_fw-pkg-download).

In addition the following optional parameters can be set, to further control
output and image creation:

- `OUTPUT_DIR` - path where resulting images are stored. Defaults to `output`
  in the scripts directory (can be overridden by -o parameter). Will be
  automatically created.
- `ROOTFS_OVERLAY` - path of the root file system overlay directory. Defaults
  to `rootfs-overlay` in the scripts directory (can be overridden by -f
  parameter).
- `LEDE_BUILDER_URL` - URL of the LEDE/OpenWrt image builder to use, override
  if you do not wish to use the default builder
  (`https://downloads.openwrt.org/releases/$LEDE_RELEASE/targets/$LEDE_TARGET/$LEDE_SUBTARGET/openwrt-imagebuilder-$LEDE_RELEASE-$LEDE_TARGET-$LEDE_SUBTARGET.Linux-x86_64.tar.xz`)
- `REPOSITORIES_CONF` - optional file file to use instead of the default
  `repositories.conf`. The file will be mounted in the container.
  Look at the [official documentation](https://openwrt.org/docs/guide-user/additional-software/imagebuilder#add_package_repositories_optional)
  for more information.

Use the `BASEDIR_CONFIG_FILE` variable to set locations of `OUTPUT_DIR` or
`ROOTFS_OVERLAY` relative to the configuration files location. This allows
self-contained projects outside of the lede-dockerbuilder folder. If e.g.
`ROOTFS_OVERLAY=$BASEDIR_CONFIG_FILE/rootfs-overlay` is set, then the
rootfs-overlay directory is expected to be in the same directory as the
configuration file.

[Example configuration](example-glinet-gl-ar750.conf) for my [GL.iNet
GL-AR750](https://openwrt.org/toh/gl.inet/gl-ar750?) router, where I have an encrypted USB disk
attached so I can use it as a simple NAS with samba and ftp when I am on travel.

```
# LEDE profile to use: GL.iNet GL-AR750
LEDE_PROFILE=glinet_gl-ar750
LEDE_RELEASE=25.12.4
LEDE_TARGET=ath79
LEDE_SUBTARGET=generic

# list packages to include in LEDE image. prepend packages to deinstall with "-".
#
# include all packages to build a mobile "NAS" supporting disk encryption:
# vsftpd (needs to be configured afterwards), cryptsetup, usb disk drivers.
LEDE_PACKAGES="-ath10k-firmware-qca9887-ct ath10k-firmware-qca9887-ct-full-htt \
    ksmbd-server hd-idle luci-app-hd-idle diffutils\
    kmod-usb-storage-uas kmod-scsi-core kmod-fs-ext4 ntfs-3g\
    kmod-nls-cp437 kmod-nls-iso8859-1 vsftpd cryptsetup kmod-crypto-xts\
    kmod-mt76 kmod-usb2 kmod-usb-ohci kmod-usb-core usbutils\
    block-mount kmod-dm kmod-crypto-ecb \
    kmod-crypto-misc kmod-crypto-cbc kmod-crypto-crc32c kmod-crypto-hash\
    kmod-crypto-user iwinfo dropbear \
    -ppp -kmod-ppp -kmod-pppoe -kmod-pppox -ppp-mod-pppoe nmap tcpdump\
    kmod-wireguard luci-proto-wireguard wireguard-tools\
    luci-ssl lsblk adblock luci-app-adblock"

LEDE_DISABLED_SERVICES=""
```

### File system overlay

Place any files and folders that should be copied to the root file system of
the resulting image to the directory pointed to by `ROOTFS_OVERLAY` (default:
`rootfs-overlay/`), which can be overridden by the -f command line option.

### Example directory structure

The following is an example directory layout, which I use to create a customized
OpenWrt image for my [NEXX WT3020](https://openwrt.org/toh/nexx/wt3020)
router (including the generated output).

```
├── builder.sh
├── docker
│   ├── Dockerfile
│   └── etc
│        └── entrypoint.sh
├── example.cfg
├── example-openwrt.cfg
├── output
│   ├── openwrt-xx.yy.z-ramips-mt7620-device-wt3020-8m.manifest
│   ├── openwrt-xx.yy.z-ramips-mt7620-wt3020-8M-squashfs-factory.bin
│   ├── openwrt-xx.yy.z-ramips-mt7620-wt3020-8M-squashfs-sysupgrade.bin
│   └── sha256sums
├── README.md
└── rootfs-overlay
    ├── etc
    │   ├── config
    │   │   ├── dhcp
    │   │   ├── dropbear
    │   │   ├── firewall
    │   │   ├── network
    │   │   ├── samba
    │   │   ├── system
    │   │   ├── wireless
    │   ├── dropbear
    │   │   └── authorized_keys
    │   ├── hotplug.d
    │   │   └── block
    │   │       └── 10-mount
    │   ├── passwd
    │   ├── rc.local
    │   ├── shadow
    │   └── vsftpd.conf
    ├── README.md
    └── usr
        └── local
            └── bin
                └── fix_sta_ap.sh
```

#### Debugging

Run `./builder.sh shell CONFIGFILE` to get a shell into the docker container,
e.g. `./builder.sh shell example.cfg`.

## Examples

These examples evolved from images I use myself.

- [image with LUCI web GUI for the Raspberry Pi 2](example-rpi2.conf).
  Just ~8MB gziped. I use this image on my home dnsmasq/openvpn 'server'.
- [image with LUCI web GUI and adblocker for the Raspberry Pi 4](example-rpi4.conf)
- [image for the TP-Link WR1043ND](example-wrt1043nd.conf)
- [image ~with samba, vsftpd and encrypted usb disk~ (image with 25.12. became too large) for
  NEXX-WT3020](example-nexx-wt3020.conf). Is the predecessor of ...
- [image with samba, vsftpd and encrypted usb disk for
  GINET-GL-M300N V2](example-glinet-gl-mt300n-v2.conf). Is the predecessor of ...
- [image with samba, vsftpd, adblock and encrypted usb disk for
  GINET-GL-AR750](example-glinet-gl-ar750.conf). This is my travel router
  setup where I have an encrypted USB disk connected to the router, accessible
  through SMB or FTP and have an adblocker running. Useful if you travel much.

To build an example run `./builder.sh build <config-file>`, e.g.

```text
$ ./builder.sh build example-rpi2.conf --nix
```

The resulting image can be found in the `output/` directory. The [OpenWrt
wiki](https://openwrt.org/docs/guide-user/installation/generic.sysupgrade)
describes how to flash the new image in detail.

### Building a x86_64 image and running it in Qemu

The [example-x86_64.conf](example-x86_64.conf) file can be used to build a
x86_64 based OpenWrt image which can also be run in Qemu, e.g., if you need
a virtual router/firewall.

First build the image with e.g. `builder.sh build example-x86_64.conf --nix`, then unpack the
resulting image with e.g. `gunzip output/openwrt-&lt;release&gt;-x86-64-generic-ext4-combined.img.gz`.
Finally the image can be started with Qemu (or simply use [run_in_qemu.sh](etc/run_in_qemu.sh) and
pass it the image name to boot)

```text
qemu-system-x86_64 \
    -enable-kvm \
    -nographic \
    -device ide-hd,drive=d0,bus=ide.0 \
    -device virtio-net-pci,netdev=hn0,id=lan \
    -netdev user,id=hn0,net=192.168.1.0/24,host=192.168.1.2,hostfwd=tcp::1122-192.168.1.1:22,hostfwd=tcp::8443-192.168.1.1:443\
    -device virtio-net-pci,netdev=hn1,id=wan \
    -netdev user,id=hn1\
    -drive id=d0,if=none,file="$IMG"
```

Qemu will assign the IP address `10.0.2.15/24` to the `WAN` interface (`eth1`)
and OpenWrt the address `192.168.1.1/24` to the `LAN` (`br-lan` bridge with
`eth0`) interface.

Port `1122` will be forwarded to the OpenWrt VMs port `22` (ssh), and port
`8443` will be forwarded to port `443` , allowing to access luci using a
web browser from the host under `https://localhost:8443`.

Note: inside Qemu, press `CTRL-a` + `x` to exit.

## Building an OpenWrt snapshot release

To build a [snapshot](https://downloads.openwrt.org/snapshots) release, set
`LEDE_RELEASE` to `snapshots` and let `LEDE_BUILDER_URL` point to the image
builder in the snapshot dir, e.g.

```text
LEDE_RELEASE=snapshots
LEDE_BUILDER_URL="https://downloads.openwrt.org/$LEDE_RELEASE/targets/$LEDE_TARGET/$LEDE_SUBTARGET/openwrt-imagebuilder-$LEDE_TARGET-$LEDE_SUBTARGET.Linux-x86_64.tar.xz"
```

See the [this example](example-x86_64-snapshot.conf) which builds an x86_64
image using the snapshot release.

## Author

## License

Apache License 2.0

lede-dockerbuilder

lede-dockerbuilder Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

lede-dockerbuilder

lede-dockerbuilder Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README