From 7b9f5e34b3f25efe709e55cee8d21b5e8f9fbb42 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Sat, 1 Sep 2018 22:47:07 +0200 Subject: [PATCH] Minor documentation update Signed-off-by: David Oberhollenzer --- README.md | 28 +++++++++++++++------------- docs/build.md | 5 ++++- 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 765d712..eb1985f 100644 --- a/README.md +++ b/README.md @@ -31,16 +31,18 @@ For an overview of the available documentation see [docs/index.md](docs/index.md By the way, before you ask: the default root password for the demo setup is *reindeerflotilla*. +The wireless network is called *Pygos Demo Net* and the password +is *righteous*. + ## Target configuration The Pygos build system is driven by toolchain and package configurations -that are divided into three categories: +that are divided into two categories: - - Common settings shared by all targets - - Contains things like a bare minimum default package set - Board specific settings - Mostly board specific cross toolchain and kernel configuration - - Can add additional packages required for that board + - Can specify a minimal set of packages required for minimal operation + of the board - Product specific settings - Specifies a list of boards for which the product can be built - Specifies and configures extra packages needed @@ -55,14 +57,15 @@ following boards: - Raspberry Pi 3 (ARM, 32 bit) - pc-engines ALIX board (x86, 32 bit) -The following demo products for those boards are planned, but currently -still in development: +The following demo product configurations exist: + + - "router" builds on all boards. On the Raspberry Pi 3, a wireless network + is created. A DHPC server serves IP addresses and configures the board as + default gateway and DNS server. DNS queries are resolved using a local + unbound resolver. The ethernet interface is configured via DHCP and packets + are NAT translated and forwarded. On the ALIX board, the DHCP server serves + on two interfaces and the third interface is used for upstream forwarding. - - "router" builds for all of the above boards. A DHCP server offers - addresses on two of the ALIX boards Ethernet ports or on the - Raspberry Pi 3 wireless interface. A DHCP client configures the - remaining interface, uses it as default route and does NAT routing. - DNS queries are resolved via a local root resolver. ## How to build the system @@ -71,7 +74,7 @@ The system can be built by running the mk.sh script as follows: mk.sh -This will start to download and builds the cross toolchain and system in the +This will start to download and build the cross toolchain and system in the current working directory. The command can (and should) be run from somewhere outside the source tree. @@ -105,4 +108,3 @@ The build system directory contains the following files and sub directories: The main build script that builds the entire system - README.md This file - diff --git a/docs/build.md b/docs/build.md index 5f75207..1c7f072 100644 --- a/docs/build.md +++ b/docs/build.md @@ -25,7 +25,7 @@ The `mk.sh` creates a `download` and a `src` directory. In the former it stores downloaded package tar balls, in the later it extracts the tar balls. For target specific files, a `-` directory is created. -Throughout the build system, this directory is refereed to as *build root*. +Throughout the build system, this directory is referred to as *build root*. Inside the build root a `deploy` directory is created. Build output for each package is deployed to a sub directory named after the package. @@ -241,6 +241,9 @@ For each network interface, addresses, mtu, offloading, etc can be configured in a file `interfaces/`, where *name* is the interface name *after* renaming. +If the files `nftables.rules` or `sysctl.conf` are found, they are copied to +the target system image and the coresponding services are enabled. + For more details, please refer to the not yet existing network documentation. ### Package Specific Configuration Files