OpenWRT
/
docker
mirror of https://github.com/openwrt/docker.git
1
0
Fork 0
Code Issues Releases Wiki Activity

readme: s/openwrtorg/openwrt and mark rootfs experimental 

Docker is sunsetting free stuff so we drop pushing to openwrtorg, use
openwrt instead. Also don't use the `rootfs` for anything real.

Signed-off-by: Paul Spooren <mail@aparcar.org>
pull/104/head
Paul Spooren 2023-03-20 18:45:23 +01:00
parent f462ab7c9c
commit 5605f7f2dd
1 changed files with 51 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
README.md
View File

@ -21,7 +21,56 @@ runner. This allows to run multiple jobs in parallel.
See `.gitlab-ci.yml` for the current setup.
## `rootfs`
## `sdk`
Contains the [OpenWrt
SDK](https://openwrt.org/docs/guide-developer/toolchain/using_the_sdk) based on
a `debian:latest` container with required packages preinstalled. This can be
useful when building packages on MacOS X, Windows or via CI.
### Example
docker run --rm -v "$(pwd)"/bin/:/home/build/openwrt/bin -it openwrt/sdk
# within the Docker container
./scripts/feeds update base
make defconfig
./scripts/feeds install firewall
make package/firewall/{clean,compile} -j$(nproc)
Enjoy a local OpenWrt SDK container building the `firewall3` package and but the
binary in hosts `./bin` folder.
### Tags
All currently available SDKs via lower case `<target>-<subtarget>[-<branch>]`,
appending `19.07-SNAPSHOT` or `18.06.4` let's you build other than snapshots.
## `imagebuilder`
Contains the [OpenWrt
ImageBuilder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder)
based on a `debian:latest` container with required packages preinstalled. This
can be useful when creating images on MacOS X, Windows or via CI.
### Example
docker run --rm -v "$(pwd)"/bin/:/home/build/openwrt/bin -it openwrt/imagebuilder
# within the Docker container
make image
Enjoy a local OpenWrt ImageBuilder container building an image for x86/64 and
store the binary in hosts `./bin` folder.
### Tags
All currently available SDKs via lower case `<target>-<subtarget>[-<branch>]`,
appending `19.07-SNAPSHOT` or `18.06.4` let's you build other than snapshots.
## `rootfs` (experimental)
> The OpenWrt runtime uses multiple active serices to work, it's not really
> suited as a container. This `rootfs` should only be used for special cases
> like CI testing.
An unpackaged version of OpenWrt's rootfs for different architectures. The
`./rootfs` folder requires slight modifications to work within Docker,
@ -29,7 +78,7 @@ additional files for the rootfs should be added there before building.
### Example
docker run --rm -it openwrtorg/rootfs
docker run --rm -it openwrt/rootfs
Enjoy a local OpenWrt container with internet access. Once closed the image is
removed.
@ -46,52 +95,6 @@ removed.
* malta-be
* i386_pentium4
## `sdk`
Contains the [OpenWrt
SDK](https://openwrt.org/docs/guide-developer/toolchain/using_the_sdk) based on
a `debian:latest` container with required packages preinstalled. This can be
useful when building packages on MacOS X, Windows or via CI.
### Example
docker run --rm -v "$(pwd)"/bin/:/home/build/openwrt/bin -it openwrtorg/sdk
# within the Docker container
./scripts/feeds update base
make defconfig
./scripts/feeds install firewall
make package/firewall/{clean,compile} -j$(nproc)
Enjoy a local OpenWrt SDK container building the `firewall3` package and but the
binary in hosts `./bin` folder.
### Tags
All currently available SDKs via lower case `<target>-<subtarget>[-<branch>]`,
appending `19.07-SNAPSHOT` or `18.06.4` let's you build other than snapshots.
## `imagebuilder`
Contains the [OpenWrt
ImageBuilder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder)
based on a `debian:latest` container with required packages preinstalled. This
can be useful when creating images on MacOS X, Windows or via CI.
### Example
docker run --rm -v "$(pwd)"/bin/:/home/build/openwrt/bin -it openwrtorg/imagebuilder
# within the Docker container
make image
Enjoy a local OpenWrt ImageBuilder container building an image for x86/64 and
store the binary in hosts `./bin` folder.
### Tags
All currently available SDKs via lower case `<target>-<subtarget>[-<branch>]`,
appending `19.07-SNAPSHOT` or `18.06.4` let's you build other than snapshots.
[ci-badge]: https://gitlab.com/openwrtorg/docker/badges/master/pipeline.svg
[ci-ref]: https://gitlab.com/openwrtorg/docker/commits/master
[docker-hub-badge]: https://img.shields.io/badge/docker--hub-openwrtorg-blue.svg?style=flat-square