home *** CD-ROM | disk | FTP | other *** search
/ terabyteunlimited.com / 2014.06.terabyteunlimited.com.tar / terabyteunlimited.com / iflnet-unreg.zip / readme.txt < prev   
Text File  |  2007-08-07  |  15KB  |  291 lines
  1. Image for Linux with Network Boot Disk
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Image for Linux is a Linux-based disk imaging backup and restore solution.
  5.  
  6.  
  7. Licensing
  8. ~~~~~~~~~
  9. BY COPYING, DISTRIBUTING, INSTALLING, OR USING THE ACCOMPANYING TERABYTE, INC.
  10. ("TERABYTE") SOFTWARE PRODUCT (THE "PRODUCT"), THE INDIVIDUAL OR ENTITY USING
  11. THE PRODUCT ("USER") IS CONSENTING TO BE BOUND BY AND IS BECOMING A PARTY TO
  12. THE TERABYTE LICENSE AGREEMENT INCLUDED WITH THE PRODUCT PACKAGE. IF USER DOES
  13. NOT AGREE TO ALL OF THE TERMS OF THE LICENSE AGREEMENT, USER MUST NOT COPY,
  14. DISTRIBUTE, INSTALL OR USE THE PRODUCT IN ANY MANOR.  IF USER HAS RECEIVED A
  15. SIGNED LICENSE AGREEMENT FOR THE PRODUCT DIRECTLY FROM TERABYTE THAT CONTAINS
  16. TERMS WHICH VARY FROM THE TERMS OF THE INCLUDED LICENSE AGREEMENT, THEN THE
  17. SIGNED LICENSE AGREEMENT GOVERNS THE USE OF THE PRODUCT.
  18.  
  19.  
  20. Introduction
  21. ~~~~~~~~~~~~
  22. This archive contains the IFL Network Boot Disk, which in turn includes the 
  23. Image for Linux program. The Network Boot Disk supports a wide array of storage 
  24. devices including:
  25.  - IDE hard drives and CD/DVD drives
  26.  - USB 1.1/2.0 hard drives, flash drives, CD/DVD drives
  27.  - SATA hard drives and CD/DVD drives
  28.  - IEEE 1394 (FireWire) hard drives and CD/DVD drives
  29.  - most SCSI controllers (those supported natively by the Linux kernel)
  30.  - storage devices connected via PCMCIA interface (typically USB or IEEE 1394)
  31.  - ISCSI drives (over network connection)
  32.  
  33.  
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. Section 1 - Creating and using the default configuration (iflnet.iso)
  36. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37.  
  38. The file iflnet.iso can be burned to CD/DVD from Windows or Linux to run the
  39. default configuration. The default configuration of the disk can be summarized
  40. as follows:
  41.  - wired network using eth0 interface (no wireless)
  42.  - requires DHCP server availability to obtain IP address
  43.  - console login not required on boot
  44.  - root password is 'ifl' (used for SSH login)
  45.  - SSH server is started on boot
  46.  - The ISCSI initiator daemon is started on boot 
  47.  - the timezone is UTC
  48.  - uses qwerty keyboard layout
  49.  - uses 80x25 as default video mode 
  50.  
  51. To create the default CD/DVD boot media in Windows:
  52. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  53. 1. Unzip the archive to a folder of your choice
  54.  
  55. 2. Burn iflnet.iso to CD/DVD. BurnCDCC, a free utility from TeraByte
  56.    Unlimited, is ideal for this if you don't have burner software.
  57.  
  58.  
  59. To create the default CD/DVD boot media in Linux:
  60. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  61. 1. Unzip the archive to a directory of your choice
  62.  
  63. 2. Burn iflnet.iso to CD/DVD using appropriate burner software such
  64.    as cdrecord (command line) or K3B (GUI program - recommended).
  65.  
  66.  
  67. The default configuration of the disk includes the following features:
  68.  - wired network support
  69.  - support for mounting NFS and Samba shares
  70.  - Imageall (free TeraByte Unlimited helper utility for IFL)
  71.  - SSH client and server for connecting to/from other computers
  72.  - FTP client (ncftp)
  73.  - read/write, check, resize, format Linux filesystems (Ext2/3, ReiserFS)
  74.  - read/write support for NTFS (using the ntfs-3g driver)
  75.  - resize and format NTFS filesystems (ntfsresize and mkntfs)
  76.  - read/write, format, & check FAT/FAT32 filesystems
  77.  - Linux fdisk, cfdisk, sfdisk partitioning programs
  78.  - hexedit file/disk hex editor
  79.  - text editor (nano)
  80.  - bash shell
  81.  - vlock available to lock console(s) requiring root password to unlock
  82.  - ISCSI support (initiator daemon and kernel modules)
  83.  - has makeHDD script to install to hard drive partition or UFD
  84.  
  85. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  86. Section 2 - Working with the IFL Network Boot Disk from a Linux distribution 
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88.  
  89. The following capability is available when working with the IFL Network Boot
  90. Disk from a Linux distribution:
  91.  - use the makeISO script to create a customized ISO file
  92.  - use the makeHDD script to install the default or a customized version to a
  93.    hard drive partition, or to a UFD
  94.  - use the makePXE script to create a set of PXE boot files for the default
  95.    version, or for a customized version
  96.  
  97. A customized version of the disk can be created by running makeISO, makeHDD,
  98. or makePXE. But first, the contents of certain files and directories must be
  99. modified to make it a custom version. An outline of what to edit/change/add 
  100. in order to customize the disk can be found at the end of this file.
  101.  
  102. Setting up the IFL Network Boot Disk in a Linux distribution:
  103. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  104. IMPORTANT: To successfully work with the IFL Network Disk from a Linux
  105. distribution, the contents of the zip file must be unzipped on a *Linux* 
  106. partition (ext2/3 or reiserfs). If a FAT/FAT32 or NTFS partition is used, 
  107. problems with file permissions and upper/lower case are likely to result.
  108.  
  109. 1. Unzip the iflnet archive in a directory of your choice
  110.  
  111. 2. In a terminal, change to the above directory
  112.  
  113. 3. From that directory, run the command 'unzip config.zip'. 
  114.  
  115. When you unzip the config.zip file, the directory will be populated with 
  116. several additional files and directories. That includes three executable
  117. scripts; makeISO, makeHDD, and makePXE.  
  118.    
  119. The makeISO script: (no command line options)
  120. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  121. The makeISO script is used to create a customized version in ISO file format. 
  122. The ISO file will be named iflnet-custom.iso. Run the script by typing
  123. ./makeISO from the prompt as ROOT. Before running the script, follow the 
  124. procedure below for customizing the disk, or the new ISO file will just 
  125. contain the default configuration (the same as iflnet.iso). The makeISO 
  126. script has no command line options. 
  127.  
  128. The makeHDD script: (type ./makeHDD to see options and usage examples)
  129. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  130. The makeHDD script is used to install the default or a customized version to
  131. a hard drive partition, or to a UFD (USB Flash Drive). The script requires at
  132. least one command line parameter, which is the drive or partition to install 
  133. to. Type ./makeHDD without parameters to see the command line options, and
  134. some usage examples. 
  135.  
  136. Note: The makeHDD script is also on the default CD/DVD, and can be run from 
  137. there as well. If running makeHDD from the CD/DVD, the /c option (see below)
  138. is not supported.
  139.  
  140. To install a customized version, follow the procedure below for customizing 
  141. the disk, and then run the script with the /c option. If the /c option is not
  142. used, the script will install the default configuration.
  143.  
  144. The makeHDD script can install to a partition on a hard drive, OR to a 
  145. partition on a UFD, OR to an entire (unpartitioned) UFD. The script will 
  146. not install to an entire drive unless the drive is detected as  being a 
  147. removable drive (such as a UFD). 
  148.  
  149. To install to a partition, the following is required:
  150.  - the partition must already exist, and must be at least 20 MB in size
  151.  - the partition must be a FAT16, FAT32, or a Linux (type 83) partition
  152.  - if it's a Linux partition, it must be a primary partition
  153.  - the partition does not have to formatted (can be, but doesn't have to be)
  154.  - the partition can not be mounted
  155.  
  156. To install to an entire drive (usually a UFD), the following is required:
  157.  - the drive must be detected by Linux as being a removable drive.
  158.  - the drive must be at least 20 MB in size
  159.  - if the drive currently contains partitions, none can be mounted
  160.    (ALL existing partitions will be deleted)
  161.  
  162. The makeHDD script will check for the above conditions before installing,
  163. and will exit with an error message if it detects a problem.
  164.  
  165. When installing to a FAT/FAT32 partition, makeHDD will install the syslinux
  166. boot loader. Syslinux requires the 'mcopy' command, which means the mtools
  167. package must be installed. If /usr/bin/mcopy is not detected on the system,
  168. an error message will be displayed, and the script will fail. Note that the
  169. mtools package is only required when installing to a FAT/FAT2 *partition*. 
  170. If installing to an entire drive, the script uses a FAT16 image that already
  171. has syslinux installed.
  172.  
  173. If installing to a Linux partition, the extlinux boot loader is used, and the
  174. partition is formatted as ext2. Extlinux requires that the partition be a 
  175. primary partition. In addition, if installing to a partition on a drive other
  176. than HD0, the partition will not boot unless the drive is "BIOS swapped" so
  177. that it is now HD0. This can be accomplished (for example) by using the swap
  178. option in the BootIt NG boot manager.
  179.  
  180. The /c option: This option will install a customized version based on the
  181. contents of config.txt, IFL.INI, the scripts directory, the wireless directory,
  182. and the iscsi directory. If /c is not used, the default configuration will be
  183. installed (the same as iflnet.iso). Note that if none of the above files and
  184. directories are modified, the /c option will not have any functional effect.
  185.  
  186. The /mbr option: This option will install standard MBR code to the MBR of the
  187. drive containing the target partition. The /mbr option is only allowed when 
  188. installing to a partition on a removable drive (a UFD). The MBR code installed
  189. with this option is about 300 bytes, and will not overwrite the partition
  190. table on the drive. This option is only needed if you intend to boot directly
  191. from the drive, and it does not already contain MBR code (or you want to
  192. replace the existing MBR code).
  193.  
  194. The /a option: This option will set the target partition active. If you intend
  195. to boot the partition from a boot manager (such as BootIt NG), this option is
  196. not required. It would be required if the partition is on the drive that you 
  197. are booting the system from, and that drive has a standard MBR installed. The
  198. standard MBR will look for an active partition to boot.
  199.  
  200. The makeHDD script has some safeguards built in, hopefully to prevent mistakes
  201. like installing to the wrong drive or partition. In all cases, there will be
  202. a confirmation screen displayed where the user must type out the word 'yes'
  203. before going ahead with the installation. On that screen, the command line
  204. entered, as well as the target drive/partition information will be displayed
  205. as a visual check.
  206.  
  207. The makePXE script: (type ./makePXE to see options and usage examples)
  208. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  209. The makePXE script will create a set of boot files in the pxe directory, which
  210. can then be used to manually set up a PXE network boot. Please refer to the 
  211. file pxe.txt in the pxe/help directory for more information about setting up 
  212. a PXE boot.
  213.  
  214. The makePXE script has two command line options, one of which is always 
  215. required. The /d option will create the files based on the default iflnet.iso 
  216. configuration. The /c option will create the files for a customized version 
  217. based on config.txt, IFL.INI, and the wireless, scripts, and iscsi directories.
  218. The command line options and usage information can be displayed by typing 
  219. ./makePXE without any parameters.
  220.  
  221.  
  222. Creating a customized version of the IFL Network Boot Disk:
  223. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  224.  
  225. When customizng the disk, the following options are available:
  226.  - can specify and use static IP address, default route, DNS
  227.  - can use alternate or additional network interface, or no network interface
  228.  - can configure wireless networking (see wireless/help/wireless.txt)
  229.  - can specify a default video mode other than 80x25
  230.  - can specify the azerty or dvorak keyboard map (default is qwerty)
  231.  - can include custom scripts in the scripts directory
  232.  - can optionally execute some or all of the scripts on boot
  233.  - can specify a timezone other than UTC
  234.  - can specify that console login is required on boot
  235.  - can set the root password
  236.  - can specify a hostname other than 'ifl'
  237.  - can disable the SSH server on boot
  238.  - can include a custom configuration for ISCSI in the iscsi directory
  239.  - can disable the ISCSI daemon on boot
  240.  - can edit and include the IFL.INI file to specify custom settings for IFL
  241.  - can enable support for mounting LVM volumes (Linux Volume Manager)
  242.  - can enable login from a serial port (COM1 and/or COM2)
  243.  
  244. The following steps are an outline of how to customize the disk:
  245.  
  246. 1. Edit config.txt (optional): If desired, edit the config.txt file in this 
  247.    directory to select and configure the available options. The comments in
  248.    config.txt explain the options. Note that the options to require a console
  249.    login and to set the root password are configured when you run one of the
  250.    make scripts in step 6, 7, or 8 below. If you do not change anything in 
  251.    config.txt, the file will still be included on the disk, but will have no 
  252.    effect.
  253.  
  254. 2. Edit IFL.INI (optional): If desired, edit the empty IFL.INI file in this 
  255.    directory to add any custom IFL settings as defined in the IFL manual. The
  256.    IFL.INI file will be automatically included on the disk. If you have no 
  257.    need for any IFL settings, you can just leave the file empty - it won't 
  258.    have any effect.
  259.          
  260. 3. Configure wireless (optional): See the wireless/help directory for 
  261.    information on how to set up & configure that for your particular network
  262.    adapter. Note that some wireless adapters may not be supported. Also note 
  263.    that some options (at least one) in config.txt will need to be configured 
  264.    for wireless.
  265.          
  266. 4. Set up the scripts directory (optional): If desired, populate the scripts 
  267.    directory with one or more bash scripts that you want to include on the 
  268.    disk. To have one or more of those scripts executed automatically on boot, 
  269.    you also need to configure the RUNSCRIPTS option in config.txt. The default 
  270.    is that NO scripts will be executed. It is not necessary to set permissions 
  271.    on the scripts. That will be taken care of automatically.
  272.  
  273. 5. Set up the iscsi directory (optional): If desired, set up the iscsi 
  274.    directory as needed to work with your network and iscsi target setup.
  275.    When creating custom boot media, the ENTIRE issci directory will be copied
  276.    to the root file system at /etc/iscsi, and will replace the default iscsi
  277.    directory there. The iscsi directory initially contains a copy of the 
  278.    default /etc/iscsi directory, so if no changes are made, building a custom 
  279.    disk will have no effect on iscsi operation.
  280.    
  281. 6. To create a customized CD/DVD, run the makeISO script as described above.
  282.    
  283. 7. To install the customized version to hard drive or UFD, run the makeHDD 
  284.    script with the /c option as described above. The /c option must be used 
  285.    to install a customized version. Otherwise it will ignore any changes made
  286.    above, and will just install the default configuration.
  287.       
  288. 8. To create the customized version as a set of PXE boot files, run the makePXE
  289.    script with the /c option as described above. Then refer to the file pxe.txt
  290.    in the pxe/help directory.
  291.