mirror of
https://github.com/pygos/build.git
synced 2024-11-22 02:59:47 +01:00
Minor documentation update
Signed-off-by: David Oberhollenzer <david.oberhollenzer@tele2.at>
This commit is contained in:
parent
9ed01eae34
commit
7b9f5e34b3
2 changed files with 19 additions and 14 deletions
28
README.md
28
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
|
By the way, before you ask: the default root password for the demo setup is
|
||||||
*reindeerflotilla*.
|
*reindeerflotilla*.
|
||||||
|
|
||||||
|
The wireless network is called *Pygos Demo Net* and the password
|
||||||
|
is *righteous*.
|
||||||
|
|
||||||
## Target configuration
|
## Target configuration
|
||||||
|
|
||||||
The Pygos build system is driven by toolchain and package configurations
|
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
|
- Board specific settings
|
||||||
- Mostly board specific cross toolchain and kernel configuration
|
- 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
|
- Product specific settings
|
||||||
- Specifies a list of boards for which the product can be built
|
- Specifies a list of boards for which the product can be built
|
||||||
- Specifies and configures extra packages needed
|
- Specifies and configures extra packages needed
|
||||||
|
@ -55,14 +57,15 @@ following boards:
|
||||||
- Raspberry Pi 3 (ARM, 32 bit)
|
- Raspberry Pi 3 (ARM, 32 bit)
|
||||||
- pc-engines ALIX board (x86, 32 bit)
|
- pc-engines ALIX board (x86, 32 bit)
|
||||||
|
|
||||||
The following demo products for those boards are planned, but currently
|
The following demo product configurations exist:
|
||||||
still in development:
|
|
||||||
|
- "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
|
## How to build the system
|
||||||
|
@ -71,7 +74,7 @@ The system can be built by running the mk.sh script as follows:
|
||||||
|
|
||||||
mk.sh <board> <product>
|
mk.sh <board> <product>
|
||||||
|
|
||||||
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
|
current working directory. The command can (and should) be run from somewhere
|
||||||
outside the source tree.
|
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
|
The main build script that builds the entire system
|
||||||
- README.md
|
- README.md
|
||||||
This file
|
This file
|
||||||
|
|
||||||
|
|
|
@ -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.
|
downloaded package tar balls, in the later it extracts the tar balls.
|
||||||
|
|
||||||
For target specific files, a `<BOARD>-<PRODUCT>` directory is created.
|
For target specific files, a `<BOARD>-<PRODUCT>` 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
|
Inside the build root a `deploy` directory is created. Build output for each
|
||||||
package is deployed to a sub directory named after the package.
|
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/<name>`, where *name* is the interface name *after*
|
in a file `interfaces/<name>`, where *name* is the interface name *after*
|
||||||
renaming.
|
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.
|
For more details, please refer to the not yet existing network documentation.
|
||||||
|
|
||||||
### Package Specific Configuration Files
|
### Package Specific Configuration Files
|
||||||
|
|
Loading…
Reference in a new issue