pygos/build
1
0
Fork 0
mirror of https://github.com/pygos/build.git synced 2024-11-23 11:39:47 +01:00
Code Issues Releases Wiki Activity

Update documentation

Browse source 
Signed-off-by: David Oberhollenzer <david.oberhollenzer@tele2.at>
This commit is contained in:
David Oberhollenzer 2018-10-04 00:31:41 +02:00
parent 62345ef7bb
commit edeedb8047
3 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -42,7 +42,7 @@ that are split across multiple *layers*.
From the product name, a layer configuration file in the `product` sub From the product name, a layer configuration file in the `product` sub
directory is read, specifying what configuration layers to use and in directory is read, specifying what configuration layers to use and in
whate order (later layers can override earlier layers). what order (later layers can override earlier layers).
The actual configuration for the build system is in the coresponding sub The actual configuration for the build system is in the coresponding sub
directories in `layer/<name>`. directories in `layer/<name>`.
@ -65,7 +65,9 @@ The system currently contains configurations for the following products:
and packets from the first two are NAT translated and forwarded. The two and packets from the first two are NAT translated and forwarded. The two
ports have different IP subnets and are not allowed to talk to each other. ports have different IP subnets and are not allowed to talk to each other.
A local SSH server can be reached via the first two ports. A user has to A local SSH server can be reached via the first two ports. A user has to
be added first, since root login is disabled. be added first, since root login is disabled. A local Nginx web server
can be reached via the first two ports that serves a simple demo landing
page.
- `router-rpi3` - A Raspberry Pi 3 based wireless access point (32 bit ARM). - `router-rpi3` - A Raspberry Pi 3 based wireless access point (32 bit ARM).
A DHPC server serves IP addresses and configures the board as default A DHPC server serves IP addresses and configures the board as default
@ -73,6 +75,8 @@ The system currently contains configurations for the following products:
resolver. The ethernet interface is configured via DHCP and packets resolver. The ethernet interface is configured via DHCP and packets
are NAT translated and forwarded. A local SSH server can be reached on the are NAT translated and forwarded. A local SSH server can be reached on the
WLAN interface. A user has to be added first, since root login is disabled. WLAN interface. A user has to be added first, since root login is disabled.
A local Nginx web server can be reached on the WLAN interface that serves
a simple demo landing page.
## How to build the system ## How to build the system

3
docs/build.md
View file

@ -210,6 +210,8 @@ Currently, the following variables are used:
* `LINUX_TGT` contains the space seperated make targets for the generic, * `LINUX_TGT` contains the space seperated make targets for the generic,
main line, LTS kernel package. main line, LTS kernel package.
* `OPENSSL_TARGET` contains the target architecture for the OpenSSL package. * `OPENSSL_TARGET` contains the target architecture for the OpenSSL package.
* `CPU_IS_64BIT` is set to `yes` for 64 bit CPUs. This is needed for some
packages like nginx that need a little help for cross compiling.
### Init System Configuration ### Init System Configuration
@ -259,3 +261,4 @@ The following files are currently used (with default override behavior):
* `dnsmasq.conf` is installed to `/etc` by the dnsmasq package. * `dnsmasq.conf` is installed to `/etc` by the dnsmasq package.
* `unbound.conf` is installed to `/etc` by the unbound package. * `unbound.conf` is installed to `/etc` by the unbound package.
* `dhcpcd.conf` is installed to `/etc` by the dhcpcd package. * `dhcpcd.conf` is installed to `/etc` by the dhcpcd package.
* `nginx.conf` is installed to `/etc/nginx` by the nginx package.

6
docs/layers.md
View file

@ -69,9 +69,9 @@ layers.
### Product Specific Layers ### Product Specific Layers
- `router-base` contains basic configuration for the router class of products. - `router-base` contains basic configuration for the router class of products.
It adds `unbound`, `dnsmasq`, `openssh` and `tcpdump`. The kernel parameters It adds `unbound`, `dnsmasq`, `openssh`, `nginx` and `tcpdump`. The kernel
are configured to enable IP forwarding, `resolv.conf` is set to resolve parameters are configured to enable IP forwarding, `resolv.conf` is set to
names through the local DNS resolver. resolve names through the local DNS resolver.
- `router-alix` extends `router-base` with interface configuration for the - `router-alix` extends `router-base` with interface configuration for the
ALIX board and appropriate nftable rules. ALIX board and appropriate nftable rules.