AtaraxiaDev/openwrt-auto-extroot
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Attila Lendvai 2015-11-13 12:26:05 +01:00
parent ca36ecdaaf
commit cbf234800e
1 changed files with 50 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -1,6 +1,7 @@
# What # What
It's a script to build a customized OpenWRT firmware image. It's a script to build a customized OpenWRT firmware image
(basic familiarity with OpenWRT is assumed).
If this image is flashed on a device it will try to automatically If this image is flashed on a device it will try to automatically
set up [extroot](http://wiki.openwrt.org/doc/howto/extroot) on **any set up [extroot](http://wiki.openwrt.org/doc/howto/extroot) on **any
@ -11,30 +12,12 @@ that can be done at that point to ask the user for confirmation.
# Why # Why
So that e.g. customers can buy a router on their own, flash our So that e.g. customers can buy a router on their own, flash our custom
firmware, plug in a pendrive, and manage their SIP (telephony) node firmware, plug in a pendrive, and manage their SIP (telephony) node
from our webapp. from our webapp.
# Status # How
### Building
This is more of a template than something standalone. You most
probably want to customize this script here and there; search for
`CUSTOMIZE` for places of interest.
I've extracted this from a project where OpenWRT nodes auto-provision
themselves in 3 stages, but I thought it's useful enough for making it
public (stage 1: extroot setup; stage 2: install packages; stage 3: a
Python script for app-level sync).
At the time of writing it only supports a few `ar71xx` routers but
it's easy to extend it.
## Tested with
[OpenWRT Chaos Calmer 15.05 RC1](https://downloads.openwrt.org/chaos_calmer/15.05-rc1/)
on a TP-Link WDR4300.
# Building
e.g. `./build.sh TLWDR4300` e.g. `./build.sh TLWDR4300`
@ -42,22 +25,57 @@ Results will be under `build/OpenWrt-ImageBuilder-ar71xx_generic-for-linux-x86_6
To see a list of available targets, run this in the ImageBuilder dir: ```make info```. To see a list of available targets, run this in the ImageBuilder dir: ```make info```.
# Usage ### Setup stagesd
Blinking leds show which phase the extroot setup scripts are in. Consult the
sources for details: [autoprovision-functions.sh](image-extras/common/root/autoprovision-functions.sh#L49).
#### Stage 1
At the first boot after flashing the firmware the autoprovision script will
wait for anything (!) in `/dev/sda` to show up, then erase it and set up a
`swap`, an `extroot`, and a `data`filesystem (for the remaining space), and
then reboot.
#### Stage 2
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
(either by using ssh or LuCI if you could include it in the firmware).
### Login
After flashing the firmware the router will have the standard After flashing the firmware the router will have the standard
`192.168.1.1` IP address, and SSH will listen there using the keys `192.168.1.1` IP address, and SSH will listen (in all stages) using the keys
specified in `image-extras/etc/dropbear/authorized_keys`. specified in [authorized_keys](image-extras/common/etc/dropbear/authorized_keys)
(**this repo contains my own ssh public key as an example, either delete it or replace
it with yours!**).
By default the root passwd is initialized to a random string. 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).
Once connected, you can read the log with `logread -f`. Once connected, you can read the log with `logread -f`.
The autoprovision script will wait for any `/dev/sda` to show up, then # Status
erase it and set up a `swap`, an `extroot`, and a `data` filesystem,
and then reboots.
In stage 2 it will need an internet connection, so you should connect This is more of a template than something standalone. You most
to its [LuCI interface](http://192.168.1.1) to set up an Internet probably want to customize this script here and there; search for
upstream, and then it will automatically continue installing packages, `CUSTOMIZE` for places of interest.
finishing the whole process, and then do a final reboot.
Most importantly, **set up your own public ssh key, or delete the default**.
I've extracted this from a project where OpenWRT nodes auto-provision
themselves in 3 stages, but I thought it's useful enough for making it
public (stage 1: extroot setup; stage 2: install packages; stage 3: a
Python script for an app-level sync feature).
At the time of writing it only supports a few `ar71xx` routers out of the box
but it's easy to extend it.
## Tested with
[OpenWRT Chaos Calmer 15.05 RC1](https://downloads.openwrt.org/chaos_calmer/15.05-rc1/)
on a TP-Link WDR4300.
# Troubleshooting # Troubleshooting