summaryrefslogtreecommitdiffstats
path: root/doc/setup_howto
diff options
context:
space:
mode:
authorChristian Rößler2013-11-23 17:44:31 +0100
committerChristian Rößler2013-11-23 17:44:31 +0100
commit84ae4310c8b580b65ff275262de6bf1e4d653ed1 (patch)
treefbc43270046cd205e4e3ce3a3c59ddf943457686 /doc/setup_howto
parent[doc] setup_howto: Edited some more.wq (diff)
downloadtm-scripts-84ae4310c8b580b65ff275262de6bf1e4d653ed1.tar.gz
tm-scripts-84ae4310c8b580b65ff275262de6bf1e4d653ed1.tar.xz
tm-scripts-84ae4310c8b580b65ff275262de6bf1e4d653ed1.zip
[doc] setup_howto: Typos etc.
Diffstat (limited to 'doc/setup_howto')
-rw-r--r--doc/setup_howto55
1 files changed, 28 insertions, 27 deletions
diff --git a/doc/setup_howto b/doc/setup_howto
index 03f17942..e5d1652b 100644
--- a/doc/setup_howto
+++ b/doc/setup_howto
@@ -5,11 +5,11 @@ This is a little howto to get people started on openSLX. Please expand!
Hard disk space: As the tm-scripts directory will expand considerably while
building openSLX (to 5-6 GB), we recommend to allocate around 8-10 GB
- disk space. OpenSLX will install also some packages into the base
- system depending on chosen modules.
+ disk space. OpenSLX will install some packages into the base system
+ depending on chosen modules.
Currently supported distributions:
- Ubuntu 12.04 LTS, Ubuntu 13.04, openSuse 12.4.
+ Ubuntu 12.04 LTS, Ubuntu 13.04, openSuse 12.3.
Net access is vital as packages / source will be downloaded from the internet
while building. Please note that root privileges will be needed to run the
@@ -31,6 +31,7 @@ Needed services: dhcp, tftpd, httpd, NFS and/or dnbd3.
checkout openSLX git repository:
# git clone git://git.openslx.org/openslx-ng/tm-scripts.git
+# gir clone git://git.openslx.org/openslx-ng/printergui.git
5. Getting started
@@ -39,20 +40,20 @@ Change into directory tm-scripts, and execute the mltk script ('mini linux
toolkit') without parameters (or use -h, --help) to see possible options
including some examples.
-mltk will check for some needed basic development tools like gcc, make etc.
-In case of missing development tools mltk will display an information:
+mltk will check for some essential basic development tools like gcc, make
+etc. In case of missing development tools mltk will display information
| [info] You appear to be missing following development tools.
-along with some installing hints about needed package(s) and suggests
+along with some installation hints about needed package(s) and suggests
needed packet manager invocations to remedy.
-mltk will write detailed log files to the directory 'logs' (stdout.log,
-stderr.log). Detailed information can also be obtained using the '-d'
+mltk will write detailed log files to the directory 'logs' (stdout.log,
+stderr.log). Detailed information can also be obtained using the '-d'
(debug) switch.
-Please take note that mltk functions are divided in two parts, somewhat
-misleadingly named: 'remote' and 'server' (second parameter choice). As
-rule of thumb it may be said that 'remote' applies to building and 'server'
-applies to packaging the built system in appropriate ways (initramfs, sqfs)
+Please take note that mltk functions are divided in two parts, somewhat
+misleadingly named 'remote' and 'server' (second parameter choice). As
+rule of thumb it may be said that 'remote' applies to building and 'server'
+applies to packaging the built system in appropriate ways (initramfs, sqfs)
for delivery.
@@ -77,25 +78,25 @@ Build addons (vmware etc.)
7. Packaging
-When using the parameter 'server' either an IP adress or 'local' is expected.
-If the building machine is also used to deliver the built boot images 'local'
+When using the parameter 'server' either an IP adress or 'local' is expected.
+If the building machine is also used to deliver the built boot images 'local'
should be used.
-If another machine is used to deliver built images (by http etc.) the IP
-adress of the build machine has to be be used. In that case mltk needs to be
+If another machine is used to deliver built images (by http etc.) the IP
+adress of the build machine has to be be used. In that case mltk needs to be
present on the server machine.
Please note that the remote machine (the machine on which the build process
runs) needs to export the build structure (option remote -n, see
-mltk --help). This option executes a bind mount of the local build directory
-to a standardized place, /export/build, which can be accessed later from the
-server machine via rsync. To facilitate this rsync-ing it way be wise to
-add the ssh key to the build machine (authorized_keys), as then no password
+mltk --help). This option executes a bind mount of the local build directory
+to a standardized place, /export/build, which can be accessed later from the
+server machine via rsync. To facilitate this rsync-ing it may be wise to
+add the ssh key to the build machine (authorized_keys), as then no password
has to be given when syncing from the server machine.
So, remember to execute
# ./mltk remote -n
-on the build machine, if the build is going to by synchronized to a dedicated
+on the build machine, if the build is going to by synchronized to a dedicated
server machine.
@@ -117,12 +118,12 @@ To package addons the parameter 'addons' has to be used:
First, do a
# ./mltk server [IP a build machine] -s
-to synchronize all stage/addon builds in one pass. This synchronizes the
+to synchronize all stage/addon builds in one pass. This synchronizes the
complete build directories from the remote (build) machine to the server.
It is possible to synchronize several build machines (thus different
flavours) to one server. The IP adresses of build machines are used in
server directory structure to distinguish builds; therefore the option
-'local' should be used with care.
+'local' should be used with care.
The stages and addons may be packed in analogue to the 'local case'
mentioned above:
@@ -140,17 +141,17 @@ For packaging addons the parameter 'addons' should be used:
Please note that stages/addons can be synchronized independently, if
needed:
# ./mltk server [IP of build machine] stage31 -e stage31 -s
-...
+# [...]
# ./mltk server [IP of build machine] vmware -e addons -s
8. Preparing for client boot
-As example we suppose the packaged boot images are expected in
+As example we suppose the packaged boot images are expected in
[webroot]/boot/client. Of course the boot chain (or an (i)pxe-delivered boot
menu) needs to be pointed to this directory as well. It is possible to use
more than one directory when using a boot menu, by the way; different
-directories just need to be represented by separate entries in the boot menu.
+directories just need to be represented by separate entries in the boot menu.
The packaged stages, addons and the kernel will be found on the server machine
at .../tm-scripts/server/boot/[IP or local]/. For convenience it is recommended
@@ -211,7 +212,7 @@ happened before:
# ./mltk server [IP of build machine] -s
... or, if wanted, sync just some parts, if you know what you're doing.
-stage31 makes most sense so far, so to say. So, for example:
+Stage31 makes most sense so far, so to say. So, for example:
# ./mltk server [IP] stage31 -e stage31 -s
etc.