Building From Source - Revision history

Paul Blankenbaker: Marked page as being outdated

2010-09-22T14:56:56Z

Marked page as being outdated

← Older revision		Revision as of 10:56, 22 September 2010
Line 1:		Line 1:
			<p class="wikiNote">'''NOTE''': This page is outdated and should no longer be used as a reference for building a NST development system. If you are interested in putting together a system for the purpose of building the NST distribution from source, please refer to the [[Developer Info]] section.</p>

			__TOC__

	= Preparing The Build Machine =		= Preparing The Build Machine =

Paul Blankenbaker: /* Adding Packages To The Build */

2007-09-29T01:11:37Z

Adding Packages To The Build

← Older revision		Revision as of 21:11, 28 September 2007
Line 493:		Line 493:
	<div class="computerOutput">		<div class="computerOutput">

	... ~~Lot's of~~ output as configure ~~runs~~ ...		... Omitting the initial output from running configure ...

	PKGCATS: boot boot2 bootnet system time printing db x gnome server development php java applications networking wireless dockapps recovery sound custom		PKGCATS: boot boot2 bootnet system time printing db x gnome server
			development php java applications networking wireless dockapps recovery sound custom
	SFUSER: pblankenbaker		SFUSER: pblankenbaker
	SNORTRSCACHENAME: snort_rs_cache		SNORTRSCACHENAME: snort_rs_cache
	SOURCE_FORGE_MIRROR: http://easynews.dl.sourceforge.net/sourceforge		SOURCE_FORGE_MIRROR: http://easynews.dl.sourceforge.net/sourceforge
	WEBHOST_DOMAIN: ~~redali.com~~		WEBHOST_DOMAIN:
	WEBHOST_USER: ~~redalico~~		WEBHOST_USER:

	Use "make" to build src/nst-1.7.0.iso.gz, or "make help" to see		Use "make" to build src/nst-1.7.0.iso.gz, or "make help" to see
Line 702:		Line 703:

	The two '''find''' commands issued above are not necessary, but give one a good idea of what files were installed by the new: "'''src/packages/custom/bison.sh'''" script.		The two '''find''' commands issued above are not necessary, but give one a good idea of what files were installed by the new: "'''src/packages/custom/bison.sh'''" script.

			=== Some Trouble Shooting Tips ===

			Don't be surprised if things don't work the first time. There are several things that may cause problems:

			* Not copying enough files from the package.

			* Not installing dependencies (running '''ldd''' on your binaries can help track down the missing ones).

			* Not creating the necessary symbolic links (not everythine will relocate nicely to the '''/usr/local''' directory - you may need to add some symbolic links to work around this).

			* Placing a configuration file (or some other file which needs to be writable) under '''/usr/local''' on the '''NST''' system (sometimes you need to relocate the file to the ${NSTUTILSDIR} and sometimes you might find that you need to relocate AND add symbolic links).

Paul Blankenbaker: /* check_rpm ''PKG_NAME'' ''DST_ROOT'' ''STRIP_PATH'' ''MATCH0'' [''MATCH1'' ...] */

2007-09-29T01:02:21Z

check_rpm ''PKG_NAME'' ''DST_ROOT'' ''STRIP_PATH'' ''MATCH0'' [''MATCH1'' ...]

← Older revision		Revision as of 21:02, 28 September 2007
Line 622:		Line 622:
	The '''check_rpm''' function works in the following manner:		The '''check_rpm''' function works in the following manner:

	* It gets a list of possible source files belonging to ''PKG_NAME'' (A		* It gets a list of possible source files belonging to ''PKG_NAME'' (A "'''rpm -ql bison'''" in this case)
	"'''rpm -ql bison'''" in this case)

	* For each matching file ("^/usr/bin/bison" matches a single file whereas "^/usr/share/bison" matches many files and directories), it forms a destination file or directory		* For each matching file ("^/usr/bin/bison" matches a single file whereas "^/usr/share/bison" matches many files and directories), it forms a destination file or directory name by stripping off ''STRIP_PATH'' ("'''/usr'''" in our case, so "'''/usr/bin/bison'''" becomes "'''/bin/bison'''"), and then prepends ''DST_ROOT'' ("''/bin/bison''" becomes "''${NSTLOCALDIR}/bin/bison''").
	name by stripping off ''STRIP_PATH'' ("'''/usr'''" in our case, so
	"'''/usr/bin/bison'''" becomes "'''/bin/bison'''"), and then prepends ''DST_ROOT''
	("''/bin/bison''" becomes "''${NSTLOCALDIR}/bin/bison''").

	The tricky part is learning which ''DST_ROOT'' variable to use, we have 3:		The tricky part is learning which ''DST_ROOT'' variable to use, we have 3:

	; ''${NSTLOCALDIR}'' : This is the ''DST_ROOT'' one should prefer, files copied here		; ''${NSTLOCALDIR}'' : This is the ''DST_ROOT'' one should prefer, files copied here will live on the '''CD''' '''ISO''' image (not be loaded into '''RAM'''), and will end up under the "'''/usr/local'''" directory once the system is booted. However, this ends up "relocating" a lot of executables (for example, "bison" is found under "'''/usr/bin/bison'''" on a Fedora system, but under "'''/usr/local/bin/bison'''" on a '''NST''' system). Sometimes, one needs to add symlinks to work around this.
	will live on the '''CD''' '''ISO''' image (not be loaded into '''RAM'''), and will end
	up under the "'''/usr/local'''" directory once the system is booted.
	However, this ends up "relocating" a lot of executables (for example,
	"bison" is found under "'''/usr/bin/bison'''" on a Fedora system, but under
	"'''/usr/local/bin/bison'''" on a '''NST''' system). Sometimes, one needs to add
	symlinks to work around this.

	; ''${NSTUTILSDIR}'' : this directory is tarred up initially, but after		; ''${NSTUTILSDIR}'' : this directory is tarred up initially, but after boot, it is extracted to the '''RAM''' disk area. This directory is used for "'''/etc'''" files (any file which may need to be modified), or adding helper symbolic links. In our example above, we used this variable to add two symbolic links.
	boot, it is extracted to the '''RAM''' disk area. This directory is used for
	"'''/etc'''" files (any file which may need to be modified), or adding
	helper symbolic links. In our example above, we used this variable to add two symbolic links.

	; ''${NSTINITRDDIR}'' : this directory is for critical files that need to be		; ''${NSTINITRDDIR}'' : this directory is for critical files that need to be available in the initial '''RAM''' disk. These files are used to boot the system and mount the '''CDROM''' drive. Typically you will want to avoid this area.
	available in the initial '''RAM''' disk. These files are used to boot the
	system and mount the '''CDROM''' drive. Typically you will want to avoid
	this area.

	=== Test The Installation ===		=== Test The Installation ===

Paul Blankenbaker: /* Adding Files From a RPM Package */

2007-09-29T00:58:09Z

Adding Files From a RPM Package

Show changes

Paul Blankenbaker: working on notes on adding additional packages

2007-09-29T00:19:59Z

working on notes on adding additional packages

← Older revision		Revision as of 20:19, 28 September 2007
Line 438:		Line 438:

	; '''${NSTINITRDDIR}''' : This is the root directory which contains the files and directories which will end up in the initial '''RAM''' disk when booting from the '''Live CD'''. It typically contains small scripts, configuration files and enough executables and modules to get the '''CDROM''' mounted. You should avoid adding large files to this area.		; '''${NSTINITRDDIR}''' : This is the root directory which contains the files and directories which will end up in the initial '''RAM''' disk when booting from the '''Live CD'''. It typically contains small scripts, configuration files and enough executables and modules to get the '''CDROM''' mounted. You should avoid adding large files to this area.

			= Adding Packages To The Build =

			During the build process (when you type: '''make'''), package installation scripts for the various package categories under: '''src/packages''' are run. These scripts transfer information from the development system to the directory heirarchy that is used to form the final '''ISO''' image.

			== Adding Files From a RPM Package ==

			The easiest packages to add to a '''NST''' build are from packages which are installed on the development system from '''RPM''' files (typically via: '''yum''').

			To add additional packages to the '''NST''', it is recommended to use the following steps:

			* Install the package onto your development system.

			* Create a: "'''src/packages/custom'''" directory (for your custom additions to the '''NST''').

			* Update your configuration file such that the ''custom'' category is added to the: '''${PKGCATS}''' category list.

			* Add a script ending with the ''.sh'' extension for each package you want to add. For example, to add the ''bison'' package to the distribution, one would want to create a: "'''src/packages/custom/bison.sh'''" installation script.

			The following outlines the steps involved to add ''bison'' to the distribution under the ''custom'' category.

			=== Creating the Category Directory ===

			This step is trivial:

			<div class="screen">
			<div class="screenTitle">''Adding The "custom" Directory''</div>
			<div class="userInput"><span class="prompt">[root@localhost ~]# </span>cd $HOME/nst</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span>mkdir src/packages/custom</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span></div>
			</div>


			=== Adding The Custom Directory To Your Build ===

			First add the following lines to the bottom of your: "'''${HOME}/.nst/configure.sh'''" configuration file:

			<pre class="programListing">

			# Following will cause the NST build to process ALL scripts found under the
			# src/packages/custom directory when building the ISO

			PKGCATS="${PKGCATS} custom";

			</pre>

			Then run the: "'''configure'''" script and verify that the category was added:

			<div class="screen">
			<div class="screenTitle">''Configure and Verify "custom" Directory''</div>
			<div class="userInput"><span class="prompt">[root@localhost ~]# </span>cd $HOME/nst</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span>./configure</div>
			<div class="computerOutput">

			... Lot's of output as configure runs ...

			PKGCATS: boot boot2 bootnet system time printing db x gnome server development php java applications networking wireless dockapps recovery sound custom
			SFUSER: pblankenbaker
			SNORTRSCACHENAME: snort_rs_cache
			SOURCE_FORGE_MIRROR: http://easynews.dl.sourceforge.net/sourceforge
			WEBHOST_DOMAIN: redali.com
			WEBHOST_USER: redalico

			Use "make" to build src/nst-1.7.0.iso.gz, or "make help" to see
			additional targets.

			NOTE: You may want to run "make package-update" to update MANY of the
			packages needed for the NST. You can then run "make package-check" to
			see what is left to do by hand (there are many helper scripts under
			"src/bin" to aid in the package install/update process).

			</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span>./configure</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span></div>
			</div>

			The important thing to notice is the presence of: "'''custom'''" in the list of categories next to the: ''PKGCATS:'' label above.

Paul Blankenbaker: /* Building a ISO Image */

2007-08-22T15:52:32Z

Building a ISO Image

← Older revision		Revision as of 11:52, 22 August 2007
Line 257:		Line 257:
	</div>		</div>

	<p class="wikiNote">You will always see a ''[warn]]'' indicator when the '''java''' package is installed. At the time of this writing, you may also expect to see a ''[warn]'' indicator for the '''cups''' and '''clamav''' packages (this should be resolved prior to the final release). Other packages flagged by a ''[warn]'' and/or ''[failed]]'' indicator, would indicate that the layout of the package has changed since its installation script was last updated (the '''NST''' developers will get to it before the next release).</p>		<p class="wikiNote">You will always see a ''[warn]'' indicator when the '''java''' package is installed. At the time of this writing, you may also expect to see a ''[warn]'' indicator for the '''cups''' and '''clamav''' packages (this should be resolved prior to the final release). Other packages flagged by a ''[warn]'' and/or ''[failed]'' indicator, would indicate that the layout of the package has changed since its installation script was last updated (the '''NST''' developers will get to it before the next release).</p>

	Now that a '''ISO''' image has been produced, one can do any of the following:		Now that a '''ISO''' image has been produced, one can do any of the following:

Paul Blankenbaker: /* Building a ISO Image */

2007-08-22T15:52:05Z

Building a ISO Image

← Older revision		Revision as of 11:52, 22 August 2007
Line 265:		Line 265:
	* Transfer the '''ISO''' image to a different machine (we typically use '''scp''', if you are a Windows user, you may want to consider [http://winscp.sourceforge.net/ WinSCP]).		* Transfer the '''ISO''' image to a different machine (we typically use '''scp''', if you are a Windows user, you may want to consider [http://winscp.sourceforge.net/ WinSCP]).

	* Boot directly from the '''ISO''' image using a '''VMware''' product or '''Virtual PC'''.		* Boot directly from the '''ISO''' image using a '''VMware''' product or '''Virtual PC'''. NOTE: At the time of this writing, there is an issue with '''NST''' and the recommended virtual LSI SCSI controller in '''VMware Server''' (beta testers should opt for the '''BusLogic''' controller when creating new virtual machines for the time being).

	= Tweaking The Configure/Build Process =		= Tweaking The Configure/Build Process =

Paul Blankenbaker: /* Tweaking The Configure/Build Process */

2007-08-22T15:36:24Z

Tweaking The Configure/Build Process

Show changes

Paul Blankenbaker: /* Building a ISO Image */

2007-08-22T14:01:03Z

Building a ISO Image

← Older revision		Revision as of 10:01, 22 August 2007
Line 238:		Line 238:

	= Building a ISO Image =		= Building a ISO Image =

			To build the '''NST ISO''' image, one runs the following command:


			<div class="screen">
			<div class="screenTitle">''Building a ISO Image''</div>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span>make</div>
			<pre class="computerOutput">

			... You will see a lot of output and it will take awhile to build ...

			</pre>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span>ls -l src/*.iso</div>
			<pre class="computerOutput">
			-rw-r--r-- 1 root root 509790208 2007-08-25 17:27 src/nst-1.7.0.iso
			</pre>
			<div class="userInput"><span class="prompt">[root@localhost nst]# </span></div>
			</div>

			<p class="wikiNote">You will always see a ''[warn]]'' indicator when the '''java''' package is installed. At the time of this writing, you may also expect to see a ''[warn]'' indicator for the '''cups''' and '''clamav''' packages (this should be resolved prior to the final release). Other packages flagged by a ''[warn]'' and/or ''[failed]]'' indicator, would indicate that the layout of the package has changed since its installation script was last updated (the '''NST''' developers will get to it before the next release).</p>

			Now that a '''ISO''' image has been produced, one can do any of the following:

			* Burn the image to a '''CD''' or '''DVD''' (we've had good luck with '''CDRW''' media during our development). You might be able to use the: "'''make cd'''", "'''make cdrw'''" and/or "'''make dvd+rw'''" (see the output of: "'''make help'''" for more information). NOTE: If you are developing inside a virtual machine, you probably won't be able to burn a disk immediately. Instead, you'll need to transfer the image to a different system which has a burner.

			* Transfer the '''ISO''' image to a different machine (we typically use '''scp''', if you are a Windows user, you may want to consider [http://winscp.sourceforge.net/ WinSCP]).

			* Boot directly from the '''ISO''' image using a '''VMware''' product or '''Virtual PC'''.

	= Tweaking The Configure/Build Process =		= Tweaking The Configure/Build Process =

Paul Blankenbaker at 13:26, 22 August 2007

2007-08-22T13:26:10Z

Show changes