Update readme for LEDE
This commit is contained in:
Attila Lendvai
GitHub
parent
6d0547b26b
commit
a02567b2fd
35
README.md
35
README.md
@ -1,8 +1,9 @@
|
||||
# What
|
||||
|
||||
It's a script to build a customized OpenWRT firmware image on a Linux x86_64 host
|
||||
(basic familiarity with [OpenWRT](https://wiki.openwrt.org/doc/howto/user.beginner)
|
||||
is assumed).
|
||||
It's a script to build a customized [LEDE](https://lede-project.org/)
|
||||
firmware image using a Linux x86_64 host (basic familiarity with
|
||||
[LEDE](https://lede-project.org/) is assumed). LEDE is a fork of
|
||||
[OpenWRT](https://openwrt.org/).
|
||||
|
||||
If the generated image is flashed on a device it will try to automatically
|
||||
set up [extroot](http://wiki.openwrt.org/doc/howto/extroot) on **any
|
||||
@ -21,14 +22,13 @@ from our webapp.
|
||||
### Building
|
||||
|
||||
To build issue the following command: `./build.sh architecture variant device-profile`, e.g.:
|
||||
* `./build.sh ar71xx generic TLWDR4300`
|
||||
* `./build.sh ramips mt7621 ZBT-WG3526`
|
||||
* `./build.sh ar71xx generic tl-wdr4300-v1`
|
||||
|
||||
Results will be under `build/OpenWrt-ImageBuilder-${architecture}_${variant}-for-linux-x86_64/bin/`.
|
||||
Results will be under `build/lede-imagebuilder-${release}-${architecture}-${variant}.Linux-x86_64/bin/`.
|
||||
|
||||
To see a list of available targets, run this in the ImageBuilder dir: `make info`.
|
||||
To see a list of available targets, run `make info` in the ImageBuilder dir.
|
||||
|
||||
If you want to change which OpenWRT version is used, then edit the relevant variables in `build.sh` (`RELEASE`, and `RELEASE_NAME`).
|
||||
If you want to change which LEDE version is used, then edit the relevant variable(s) in `build.sh`.
|
||||
|
||||
### Setup stages
|
||||
|
||||
@ -45,7 +45,7 @@ space), and then reboot.
|
||||
#### Stage 2: download and install some packages from the internet
|
||||
|
||||
Once it booted into the new extroot, it will continuously attempt to install
|
||||
some OpenWRT packages until an internet connection is set up on the router
|
||||
some LEDE packages until an internet connection is set up on the router
|
||||
(either by using ssh or LuCI if you could fit it into the firmware).
|
||||
|
||||
### Login
|
||||
@ -57,7 +57,7 @@ By default the root passwd is not set, so the router will start telnet with
|
||||
no password. If you want to set up a password, then edit the stage 2 script:
|
||||
[autoprovision-stage2.sh](image-extras/common/root/autoprovision-stage2.sh#L53).
|
||||
|
||||
If a password is set, then telnet is disabled by OpenWRT and SSH will listen
|
||||
If a password is set, then telnet is disabled by LEDE and SSH will listen
|
||||
using the keys specified in [authorized_keys](image-extras/common/etc/dropbear/authorized_keys).
|
||||
|
||||
Once connected, you can read the log with `logread -f`.
|
||||
@ -79,32 +79,33 @@ but it's easy to extend it.
|
||||
|
||||
## Tested with
|
||||
|
||||
[OpenWRT Chaos Calmer 15.05 RC1](https://downloads.openwrt.org/chaos_calmer/15.05-rc1/)
|
||||
[LEDE 17.01.1](https://downloads.lede-project.org/releases/17.01.1/)
|
||||
on a TP-Link WDR4300.
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## Which file should I flash?
|
||||
|
||||
You should consult the [OpenWRT documentation](https://wiki.openwrt.org/doc/howto/user.beginner).
|
||||
The produced firmware files should be somewhere around ```build/OpenWrt-ImageBuilder-15.05-ar71xx-generic.Linux-x86_64/bin/ar71xx```.
|
||||
You should consult the documentation at [LEDE](https://lede-project.org/docs/start) and/or at
|
||||
[OpenWRT](https://wiki.openwrt.org/doc/howto/user.beginner).
|
||||
The produced firmware files should be somewhere around ```build/lede-imagebuilder-17.01.1-ar71xx-generic.Linux-x86_64/bin/ar71xx```.
|
||||
|
||||
In short:
|
||||
|
||||
* You need a file with the name ```-factory.bin``` or ```-sysupgrade.bin```. The former is to
|
||||
be used when you first install OpenWRT, the latter is when you upgrade an already installed
|
||||
OpenWRT.
|
||||
be used when you first install LEDE, the latter is when you upgrade an already installed
|
||||
LEDE.
|
||||
|
||||
* You must carefully pick the proper firmware file for your **hardware version**! I advise you
|
||||
to look up the wiki page for your hardware on the [OpenWRT wiki](https://wiki.openwrt.org),
|
||||
because most of them have a table of the released hardawre versions with comments on their
|
||||
status (sometimes new hardware revisions are only supported by the latest OpenWRT, which is
|
||||
status (sometimes new hardware revisions are only supported by the latest LEDE, which is
|
||||
not released yet).
|
||||
|
||||
## Help! The build has finished but there's no firmware file!
|
||||
|
||||
If the build doesn't yield a firmware file (```*-factory.bin``` and/or ```*-sysupgrade.bin```):
|
||||
when there's not enough space in the flash memory of the target device to install everything
|
||||
then the OpenWRT ImageBuilder prints a hardly visible error into its flow of output and
|
||||
then the LEDE ImageBuilder prints a hardly visible error into its flow of output and
|
||||
silently continues. Look into [build.sh](build.sh#L31) and try to remove some packages
|
||||
that you can live without.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user