better documentation

This commit is contained in:
2021-12-01 18:15:55 +01:00
parent 4ce7c3a9d3
commit f8168b0865
3 changed files with 97 additions and 59 deletions

View File

@ -2,6 +2,44 @@
The APU is a Linux box to be used as a control box at LIN sample environment
servercfg/(hostname).cfg contain the configuration for all boxes
servercfg/ contains the configuration files for all boxes
to_system/ contains the files to be installed in the system
## config files
filename: servercfg/(hostname)_(hexdigits).cfg
* (hostname) the hostname to be given on startup
* (hexdigits) the last six digits of one of the ethernet adresses of the interfaces on the APU
content of the config files:
[NETWORK]
```
# leftmost socket next to the console:
enp1s0=wan # the uplink, DHCP enabled, in netwoork n.x.y.z for 0 <= n < 192
enp1s0=wan,192.168.1.0/24 # the uplink, DHCP enabled, may be in addition in local network 192.168.1.x
# several networks might be specified, with comma separation
# must not contain addresses defined on other interfaces!
enp2s0=192.168.3.5 # the ip address of the device to be connected (DHCP or static),
# must be odd (the value one lower is used for the APU address in this interface)
enp3s0=off # disabled
enp4s0=192.168.3.1/24 # our ip address, the static address of the connected device must
# be within 1-254 and not match our own
# rightmost socket, next to the usb plugs
[ROUTER]
3000=/dev/ttyUSB0 # routing 3000 to the internal serial port /dev/ttyUSB0
5900=192.168.2.33 # routing VNC (local port 5900 to port 5900 on 192.168.2.33
8080=192.168.127.254:80 # routing 8080 to port 80 of 192.168.127.254
[FRAPPY]
cfg=uniax # the cfg file for the frappy server
port=5000 # the port for the frappy server
```
to_system contains the files to be installed in the system