diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/debos.1 | 63 |
1 files changed, 62 insertions, 1 deletions
diff --git a/doc/man/debos.1 b/doc/man/debos.1 index 6e58a40..9af586c 100644 --- a/doc/man/debos.1 +++ b/doc/man/debos.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 2.2.1 +.\" Automatically generated by Pandoc 2.0.6 .\" .TH "debos" "1" "" "" "" .hy @@ -27,6 +27,7 @@ Application Options: \ \ \ \ \ \ \-\-debug\-shell\ \ \ \ \ Fall\ into\ interactive\ shell\ on\ error \ \ \-s,\ \-\-shell=\ \ \ \ \ \ \ \ \ \ Redefine\ interactive\ shell\ binary\ (default:\ bash) \ \ \ \ \ \ \-\-scratchsize=\ \ \ \ Size\ of\ disk\ backed\ scratch\ space +\ \ \-e,\ \-\-environ\-var=\ \ \ \ Environment\ variables \f[] .fi .SH DESCRIPTION @@ -72,6 +73,17 @@ unpack: unpack files from archive in the filesystem .PP A full syntax description of all the debos actions can be found at: https://godoc.org/github.com/go\-debos/debos/actions +.SH INSTALLATION (UNDER DEBIAN) +.IP +.nf +\f[C] +sudo\ apt\ install\ golang +sudo\ apt\ install\ libglib2.0\-dev\ libostree\-dev +export\ GOPATH=/opt/src/gocode\ #\ or\ whatever\ suites\ your\ needs +go\ get\ \-u\ github.com/go\-debos/debos/cmd/debos +/opt/src/gocode/bin/debos\ \-\-help +\f[] +.fi .SH SIMPLE EXAMPLE .PP The following example will create a arm64 image, install several @@ -127,6 +139,55 @@ debos\ \-t\ image:"debian\-arm64.tgz"\ example.yaml .PP This example builds a customized image for a Raspberry Pi 3. https://github.com/go\-debos/debos\-recipes +.SH ENVIRONMENT VARIABLES +.PP +debos read a predefined list of environment variables from the host and +propagates it to fakemachine. +The set of environment variables is defined by environ_vars on +cmd/debos/debos.go. +Currently the list of environment variables includes the proxy +environment variables as documented at: +.PP +https://wiki.archlinux.org/index.php/proxy_settings +.PP +The list of environment variables currently exported to fakemachine is: +.IP +.nf +\f[C] +http_proxy,\ https_proxy,\ ftp_proxy,\ rsync_proxy,\ all_proxy,\ no_proxy +\f[] +.fi +.PP +While the elements of environ_vars are in lower case, for each element +both lower and upper case variants are probed on the host, and if found +propagated to fakemachine. +So if the host has the environment variables HTTP_PROXY and no_proxy +defined, both will be propagated to fakemachine respecting the case. +.PP +The command line options \[en]environ\-var and \-e can be used to +specify, overwrite, and unset environment variables for fakemachine with +the syntax: +.PP +$ debos \-e ENVIRONVAR:VALUE \&... +.PP +To unset an enviroment variable, or in other words, to prevent an +environment variable to be propagated to fakemachine, use the same +syntax without a value. +debos accept multiple \-e simultaneously. +.SH PROXY CONFIGURATION +.PP +While the proxy related environment variables are exported from the host +to fakemachine, there are two known sources of issues: +.IP \[bu] 2 +Using localhost will not work from fakemachine. +Prefer using an address that is valid on your network. +debos will warn if environment variables contain localhost. +.IP \[bu] 2 +In case you are running applications and/or scripts inside fakemachine +you may need to check which are the proxy environment variables they +use. +Different apps are known to use different environment variable names and +different case for environment variable names. .SH SEE ALSO .PP fakemachine at https://github.com/go\-debos/fakemachine |