FOG Project - User contributions [en]

Active Directory - FOG Setting

2014-04-21T14:45:31Z

Chad-bisd: added overview and requirements and some descriptions to various subsections and tried to clarify wording in a few places.

==Overview==
FOG can automatically join computers to an Active Directory domain.

==Requirements==
*FOG client application installed on hosts (usually as part of the image)
*FOG server configured to join computer computers to the domain
*FOG HostNameChanger module active on server, client, and in host configuration
*FOG 0.31 and earlier may require netdom.exe on hosts

==Where to Configure==

===Turn on HostNameChanger module===
This module determines if a host will join the domain. It must be enabled in several locations for it to work properly.

*When installing or reconfiguring the FOG client application on the host, this module must be made active for the computer to auto-join the domain.
*On the host record in the fog WebUI, Active Directory menu option must be checked to enable "Join domain after image task".
*In the server webUI, FOG configuration menu option, HostNameChanger menu option on the left, service must be enabled.

===FOG Defaults===
Set the default domain, username, password, and organization unit (OU) for joining computer accounts to the domain. See [[#Syntax]] details about the values for each field.

*Web UI: Other Information -> FOG Settings

===Groups===
Set the domain, username, password, and organization unit (OU) for joining hosts to the domain for all hosts currently in this group. See [[#Syntax]] details about the values for each field.

*Web UI: Group Management
*Search for Group name or click "List Groups"
*Click on the name of the group in the list
*Active Directory option in the menu on the left

'''Note:''' This is a applied in a batch for each host in the group when saved. These settings are not stored in the group settings permanently, nor applied to future hosts automatically when added to the group.

===Individual Hosts===
Set the domain, username, password, and organization unit (OU) for joining the host to the domain. See [[#Syntax]] details about the values for each field.

*Web UI: Host Management
*Search for host name or click "List All Hosts"
*Select the host computer
*Active Directory option in the menu on the left

==Syntax==

===Domain Name===
The fully qualified domain name.

Examples:

*company
*company.ad
*company.com
*company.local

===Organizational Unit===
The organizational unit, in LDAP format.

Exmaples:

*OU=PCs,DC=company,DC=com
*OU=Lab Computers,OU=PCs,DC=company,DC=com
*[Blank] Leaving this blank will join the default OU for new PCs, usually "Computers"

===Domain Username===
The user in your domain you wish to use to add the computers to Active Directory.

[domain]\[account]

Exmaple:

*company\FOGServiceAccount

'''Note: Domain does not need to be fully qualified for Domain Username'''

===Domain Password===
The password for your domain-join account, encrypted using [[FOGCrypt]].

==Testing with Netdom to troubleshoot==

Windows Command Line(cmd)

'''FOGPassword is NOT encrypted for the command line test.'''

===Join Domain===

netdom JOIN mypcHostname /Domain:SyperiorSoft /OU:FOGou /UserD:FOGUser /passwordd:FOGPassword /reboot:35

===Remove from Domain===

netdom REMOVE mypcHostname /domain:SyperiorSoft /UserD:FOGUser /passwordd:FOGPassword

[[category:Windows]] [[category:Active Directory]]

FOGUserGuide

2013-06-11T01:37:18Z

Chad-bisd: /* Preface */ Minor wording changes and additions

A guide to deployment, management,
And concept overview
For FOG.

Based on a document by:
Thomas J. Munn
CISSP

== Introduction ==

=== Preface ===

This document is intended to be modified by FOG users, in fact it is based on a document created by a FOG user. If you feel something could be said better or put more clearly, it is encouraged that you make changes to this document. We just ask that you keep it constructive and in good taste. In order to edit the wiki you are now required to create an account, as spamming of the forum has gotten pretty bad recently.

<UL><LI>'''What is FOG?''' 

FOG is a Linux-based, free and open source computer imaging solution for Windows XP, Windows Vista, Windows 7, Windows 8, and Linux (limited) that ties together a few open-source tools with a php-based web interface. FOG doesn't use any boot disks, or CDs; everything is done via TFTP and PXE. Your PC boots via PXE and automatically downloads a small Linux client. From there you can select many activities on the PC, including imaging the hard drive.

Also with FOG many network drivers are built into the Linux client's kernel, so you don't really need to worry about nic drivers (unless there isn't kernel support for it yet). FOG also supports putting an image that came from a computer with a 80GB partition onto a machine with a 40GB hard drive as long as the data is less than 40GB. FOG supports multi-casting, meaning that you can image many PCs from the same stream. So it should be as fast whether you are imaging 1 PC or 20 PCs.</li> 

<LI>'''How should FOG be implemented?''' 

FOG is best implemented on a dedicated server, any spare machine you have. We recommend that you have '''sufficient''' hard drive space as each image you make is usually between 5 and 10 GB. Using a RAID array allows imaging multiple computers simultaneously without much performance degradation. A '''gigabit NIC''' is recommended. For faster image compression and decompression, provide as much processor and RAM as you can make available. </li> 

<LI>'''What features are included with FOG?''' 

FOG is more than just an imaging solution, FOG has grown into an imaging/cloning and network management solution. FOG now performs tasks like installing and managing printers, tracking user access to computers, installing applications remotely via snap-ins, automatic user log offs and computer shutdown on idle timeouts. If a computer is badly infected with a virus or malware, you can boot FOG in AV mode and have it remove the viruses. You can wipe your disks, destroying all information that was on them, restore deleted files, or scan the disk for bad blocks.</li> 

<LI>'''How much does FOG cost?''' 

FOG is an Open Source project and licensed under the GPL which means that you are free to use FOG on as many computers as you like for free. This also means that if you want to make any changes to the source code you are free to do so.

The creators of FOG make no profits from this project with the exception of donations. FOG comes with absolutely '''NO WARRANTY''' and the creators of FOG are in '''NO WAY RESPONSIBLE FOR ANY DAMAGE OR LOSS CAUSED BY FOG!''' Please see the license file included with the FOG release for more information. With that being said we attempt to do a very good job of supporting our users, in fact it is one of the goals of FOG to have better support than most commercial products. All support requests should be placed through the FOG's forum which is located at:

http://fogproject.org/forum/

Thanks for supporting open source software and enjoy!</li></UL>

=== Background on FOG ===

<UL><LI>'''Why FOG?''' 

Working in an educational environment our organization's techs very often re-imaged computers in their day to day activities. For a long time we used a commercial product that in many ways didn't meet our needs. It wasn't web based, and you needed to create driver disks, floppys or USB drives. Other things were very difficult, such as searching for a host by MAC address and the product was expensive, even with an educational discount. So we started to investigate ways in which we could do things better, and as our organization struggled to make a commercial product work better by trying to pxe boot dos, and testing it in Windows PE, we, the FOG Team started to build linux based solution on our own time. We finally got a working version and decided to release it as open source since we use many other open source products, and figured we should give back to the community.</li></UL>

=== Fundamental Concepts ===
This section provides some basic concepts that the FOG Project uses.
<UL><LI>'''Unicasting''' 
Unicasting in FOG means sending a single image to a single host. This can mean an upload or a deploy, and is independent of the image type. 
See this section for more on [[Unicasting]]</li>
<LI>'''Multicasting''' 
Multicasting in FOG uses UDPcast to send a single image to multiple computers using only slightly more bandwidth than sending the image to a single computer with unicast. 
See this section for more on [[Multicasting]]</li></UL>

== Installing FOG ==
FOG is a typical ''[http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP]'' software bundle, so the main server is a '''L'''inux box. The rest of the components: '''A'''pache, '''M'''ySQL, '''P'''HP, and several other services, are automatically downloaded and installed by the FOG installation script.

=== Requirements ===
This listing is for informational purposes only, as the required components will be automatically downloaded and installed by the FOG installation script.

*PHP 5.2.1+
*MySql 5+
*Apache 2+

=== Installation on different distributions of Linux ===
Click below for step-by-step guides written for your favorite flavor of Linux:
{{Installation}}

== Network Integration ==
=== Basic Network Setup ===
The FOG setup script asks several questions which might not be obvious. These sections describe only the most generic settings.
<ul><li>'''Isolated Network''' 
The easiest method to image machines and get started using FOG is on a small, isolated network. The FOG setup program will configure all the necessary services for you completely automatically. This section covers only those basic steps.
 '''See [[FOG on an Isolated Network]]'''</li> 
<li>'''Integrating FOG Server with Existing Network Systems''' 
Slightly more complicated is the task of integrating FOG into your existing network infrastructure. This section attempts to describe the steps to link FOG with a fairly generic enterprise system. 
'''See [[Integrating FOG into an Existing Network]]'''</li></ul>

===Advanced Network Setup===
==== Integrating FOG Server with Existing Network Systems in non intrusive mode using MAC filtration ====
This methods allows to use Fog in existing network without the need of controlling existing DHCP server. Requires you to input the MAC address of FOG clients.
See [[Integrating FOG into an Existing Network in non intrusive mode]]
==== Integrating FOG server into an existing network in non intrusive mode using ProxyDHCP ====
This methods allows to use Fog in existing network without the need of controlling existing DHCP server. Does NOT required you to input the MAC addresses of FOG clients.
See [[Setting up ProxyDHCP]].

==== Wake On Lan (WOL) ====
<ul><li> [[Cisco_Wake_on_lan|Cisco WOL - Layer 3]] </li>
<li> [[ProCurve_Wake_on_lan|ProCurve WOL]] </li></ul>
==== Multicast/UDPCast ====
<ul><li> [[Cisco_Multi_Cast|Cisco Multicast - Layer 3]] </li></ul>
<ul><li> [[HPMulticast|HP Multicast - Layer 2&3]] </li></ul>
==== Full Listing of Ports used by FOG server and client ====
FTP – tcp 20,21 
SSH – tcp 22 
TFTP – udp 69 
HTTP(s) – tcp 80,443 
Portmap – tcp/udp 111 
NFS – tcp/udp 2049 
Transfer ports – tcp/udp 1024 – 65535 
As found at: http://fogproject.org/forum/threads/firewall-config.27/

== Getting Started ==

=== Quick Start - Basic Tasks ===

So you have a FOG server installed and setup, now what do you do? Below are a few common "Getting Started" items.

#[[Booting into FOG and Uploading your first Image]]
#[[Deploying your Image a single client]]
#[[Deploying your Image a group of clients]]

=== Tips ===

#FOG requires that all hosts be entered in the FOG Database for imaging. The most important part is getting the MAC address of the host right. FOG uses the MAC for targeting image installs and acquires. Using the wrong MAC could result in unpredictable results, including the complete erasure of the wrong pc! The IP address isn’t that important, and the ‘name’ field is more for the user. Mac address format is 00:12:3F:C4:57:0C . Using dashes, spaces, or no items at all will result in the GUI not accepting the host.
#After hosts are entered, it is wise to group them together by function, hardware, or common image. The image will be shared among all members of a particular group. This occurs within the ‘hosts’ screen, and NOT on the groups screen. This is a little confusing, so it helps to think of the ‘groups’ screen as a task generator, rather than controlling group memberships.
#For importing hosts in a .csv file follow the format below: 1 line per host:<pre>"00:c0:4f:18:62:63","Hostname","1.1.1.1","Your description","XP/Vista","Image filename to use"</pre>
#Hosts are then configured to boot via PXE boot by going into the BIOS. Make sure PXE boot is the FIRST option, NOT the hard disk, or things won’t work.
#Configure your ‘master’ pc for the first image. Probably a good idea to run ‘[http://support.microsoft.com/kb/302577 sysprep]’ prior to imaging, but not necessary. Sysprep will make your imaging life easier, if hardware is different, etc. See Microsoft.com for more details on using sysprep.

== Preparing a Client for Cloning ==
FOG's strength can be better harnessed if some time and work is put into preparing a master image that fits the needs of your environment. 
This section covers client preparation steps that will save you time and headaches like:
::Setting a [[Client_Setup#Set_up_Default_Profile|Default User Profile]] Installing Windows Updates Pre-Installing the [[Client_Setup#Final_Steps_Before_Imaging_.2F_Before_Sysprep|FOG service]], etc. 
It also covers more advanced ideas that are guaranteed to ''cause'' headaches, like:
::Sysprep, [[Client_Setup#Hardware-Independent_Images_-_Understand_HAL|Hardware-Independent Images (HAL)]], and Driver integration. 
Read more about ''[[Client Setup]]''

== FOG Benchmarks ==

=== [[Internal Benchmarks]] ===
== Managing FOG ==
The FOG web interface is your primary management console. It is very well-documented in the pages linked below: 
===The Main [[Managing FOG]] Document===
The link above opens the Main Managing FOG document and has a Table of Contents of its own. 
Subcategories within the Managing Fog section include the following sections:
<UL><LI>'''Understanding the FOG [[Managing_FOG#Dashboard|Dashboard]]''' 
Provides an overview of the GUI and explains the symbols used on the [[Managing_FOG#Menu Bar|Menu Bar]].</LI>
<LI>'''Managing [[Managing_FOG#Hosts|Hosts]]''' 
This section covers management tasks such as: [[Managing_FOG#Adding a new host|Adding a new host]], [[Managing_FOG#Managing Hosts|Managing Hosts]], [[Managing_FOG#Host Status|Host Status]], and [[Managing_FOG#Creating Host Groups|Creating Host Groups]].</LI>
<LI>'''Managing [[Managing_FOG#Groups|Groups of Hosts]]''' 
This section provides an [[Managing_FOG#Overview_4|Overview]] of sorting hosts into useful Groups, and provides instruction on [[Managing_FOG#Managing Groups|Managing Groups]].</LI>
<LI>'''Defining and Managing [[Managing_FOG#Images|Images]]''' 
Defines types of images: Single Partition | Multiple Partition - Single Disk | Multiple Partition - All Disks | Raw Image 
Also describes [[Managing_FOG#Creating_Images_Objects|Creating]], [[Managing_FOG#Modifying_Image_Objects|Modifying Image Objects]], and [[Managing_FOG#Adding_Existing_Image_Objects|Adding Images to Existing Objects]].</LI>
<LI>'''[[Managing_FOG#Storage_Management|Storage Management]] - adding additional Storage Nodes''' 
This section introduces the [[Managing_FOG#Overview_6|concept of Storage Nodes]], which provide scalability to FOG with the ability to "share the load of computers being imaged." 
Also covered are [[Managing_FOG#Adding_a_Storage_Node|Adding Storage Nodes]], Monitoring [[Managing_FOG#Monitoring_The_Master_Node|Image Replication]] between nodes, and Understanding the [[Managing_FOG#Master_Node_Status|role of the "Master Node"]] in a group. 
In addition, this section details the necessary steps to [[Managing_FOG#Including_multiple_PXE_.2F_TFTP_servers|include PXE and TFTP Services]] for a node located on a remote network segment.</LI>
<LI>'''Defining types of [[Managing_FOG#Users|Administrative FOG Users]]''' 
The difference between a regular FOG user and a [[Managing_FOG#Overview_7|Mobile user]] 
Also covered are [[Managing_FOG#Creating_Accounts|Creating]] and [[Managing_FOG#Modifying_Users|Modifying]] FOG user accounts</LI></UL>

==FOG [[Managing_FOG#Tasks|Tasks]]==
This is a major section of FOG Management because all day-to-day client management is initiated within the FOG Tasks section. 
The [[Managing_FOG#Overview_8|Overview Section]] provides a quick list of tasks available within FOG. 
[[Managing_FOG#General_Tasks|General Tasks]] - Basic Imaging Tasks:
::Uploading an image (includes video tutorial) Deploying an image Multicasting 
[[Managing_FOG#Advanced_Tasks|Advanced Tasks]] - Describes tasks other than imaging:
::Debug Upload - Unicast (Debug) Send - Unicast (Debug) Send - Unicast (Without Snapins) Deploy All Snapins Deploy Single Snapin Memory Test Wake Up Fast Wipe Normal Wipe Full Wipe Disk Surface Test File Recovery Virus Scan Hardware Inventory
===Delayed Tasks, or [[Managing_FOG#Scheduling|Scheduling Tasks]] in the future===
Describes advanced settings available for scheduling tasks including Shutdown after Execution, [[Managing_FOG#Single_Execution_Scheduling|Single Task]] scheduling, and [[Managing_FOG#Cron_Style_Task_Scheduling|setting a CRON-Style Task]].
===[[Managing_FOG#Printers|Adding Printers]] to FOG===
How to add printers to FOG. This allows the [[Managing_FOG#Printer_Manager|FOG Service to manage printers]] on FOG Clients
==The [[Managing_FOG#The_FOG_Client_Service|FOG Client Service]]==
A service that runs on client computers allowing FOG to better manage them. Provides AD Integration, the ability to change a Hostname, Green Power management, Snap-in installation, User tracking, Printer Management, and more. See the [[Managing_FOG#Overview_10|Overview]] for a more complete list. 
The FOG client can be partially or fully-enabled by [[Managing_FOG#Module_specific_configuration_settings|modifying the ini file.]] 
===[[Managing_FOG#Installation|Installing]] the FOG Client===
A typical client installation, Silent installation, and a video tutorial.
===Advanced Description of [[Managing_FOG#Functions_and_Operation|FOG Services]]===
More detail on: 
::Auto Log Out Hostname Changer Host Register Task Reboot Directory Cleaner Display Manager Green FOG Snapin Client User Tracker User Cleanup Printer Manager Client Updater
===[[Managing_FOG#Keeping_Clients_up_to_date|Updating]] the FOG Client===
How to update the FOG client.
===The [[Managing_FOG#FOG_Tray|FOG Tray]]===
Describes the Windows application that runs in the taskbar

===[[Managing_FOG#Troubleshooting|Troubleshooting]] the FOG Client===
Log file location
==Snap-ins==
A FOG [[Managing_FOG#Snap-ins|Snap-in]] is anything that can be run on a Windows client. This can be ''just about anything'', including: installing applications like Firefox or Microsoft Office, adding an icon or shortcut to the desktop, or tweaking a registry key. This section covers [[Managing_FOG#Creating_a_Snapin_.2F_Overview|Creating a Snap-in]], adjusting the FOG server to handle snap-ins [[Managing_FOG#Preparing_the_FOG_Server|larger than 2MB]], [[Managing_FOG#Uploading_the_Snapin|Uploading the Snap-in]] into the FOG system, and [[Managing_FOG#Linking_the_Snapin_to_Hosts|Linking]] the Snap-in to hosts.

== FOG Plugins ==
Plugins enhance FOG's functionality.
<UL><LI>The Capone plugin allows FOG to recognize similar hardware platforms and push your specified image to them with minimal (or no) interaction.</LI>
</UL>
See [[Plugins]] to activate and manage plugins.

== FOG Server Maintenance ==
<ul><LI>[[Backing up FOG]]</LI>
<LI>[[Restoring FOG from Backup]]</LI>
<LI>[[Upgrading the FOG Server]]</LI></ul>

== Advanced Installations ==

=== Separate TFTP and DHCP Server ===

In this setup, the TFTP server and the DHCP server are hosted on a separate server. The TFTP server holds the PXE boot files including the Linux Kernel, boot file system image, and pxe config files. The DHCP server is the server that assigns the clients with IP addresses and network connection information.

Click here for detailed steps: 
[[Separate TFTP and DHCP Server]]

=== Additional TFTP / DHCP Server on separate subnet ===
This setup allows FOG to manage systems at a remote network location by installing the necessary services to allow clients to PXE boot to a Storage Node: 
[[Multiple_TFTP_servers|Including multiple PXE / TFTP servers]]

This extends the work done in the above article, [[Multiple_TFTP_servers|Including multiple PXE / TFTP servers]], and extends it a bit to allow for FOG nodes to be used in various locations that pull from a central server. 
[[Fog_deployment_nodes| Using remote FOG nodes for distributed deployment]]

=== Separate NFS Server ===

Edit the storage node definition with the IP address of your NFS server and set the image location to the path on the nfs server.
Make sure it has a file called .mntcheck in the root of the share, a directory called dev and a .mntcheck file in the dev folder.

if you want to mount it on the fog server too, follow these steps:-
* mv /images /imagesold
* mkdir /images
* edit /etc/fstab

For example if your server name is mynfsserver and the share on it is called fogimages
<pre>mynfsserver:/fogimages /images nfs defaults 0 0 </pre>

then type
<pre>mount -a</pre>

'''KNOWN ISSUE'''
You will get an error "Ftp connection to storage server has failed" at the end of uploading images though.
You will have to manually rename and move the file from the dev directory to the directory below.

If your NFS server supports ftp as well, enable ftp on it too with the username and password specified in the storage server settings and this message will go away.

Hopefully someone will re-write POST_Stage2.php to change this at some point as if you already have the NFS share mounted why do we do this bit with ftp?

You may also get an infinite loop of the following message:-
<pre>"Unable to find a valid task ID based on the clients mac address of: <mac address>".</pre>
if you add an @ sign before the ftp commands it appears to have fixed the issue.

so line 133 of /var/www/fog/service/Post_Stage2.php would look like this

<pre> if (@ftp_rename ( $ftp, $src, $dest ) || @ftp_rename ( $ftp, $srcdd, $dest ))</pre>

=== Change NFS location ===

This is '''not about a seperate NFS server''' in general, but about how to '''change the local storage directory''' and export it correctly.

See [[Change NFS location]] for more.

== Other Advanced Topics ==

*[[Building a Custom Kernel]]
*[[Creating Custom FOG Service Modules]]
*[[Modifying the Init Image]]
*[[Translating FOG]]
*[[Bypass Host Registration]]

== Troubleshooting ==
This section is intended to bring together the most common issues from the [http://www.fogproject.org/forum forums].

==== Troubleshooting Installation and Configuration Issues ====
<ul><li>[[Knowledge Base]]</li>
<li>[[Password Central]]</li>
<li>[[Troubleshooting an image push to a client]]</li>
<li>[[Troubleshooting an image upload]]</li>
<li>[[Troubleshooting a multicast]]</LI>
<li>[[Troubleshooting Driver Issues]]</li>
<li>[[Speeding up the Graphical User Interface]]</li>
<li>[[Bottleneck]] / Imaging Speed Issues</li>
<li>[[Troubleshooting Host Management Showing Hosts as Down]]</li></ul>

== Appendix C: Alternative Resources ==
For Microsoft sysprep information, see this page:
http://vernalex.com/guides/sysprep/video.shtml

FOG install HOWTO:
http://www.howtoforge.com/installing-fog-computer-imaging-solution-on-fedora8

FOG sourceforge page:
http://freeghost.sf.net/

Deployment Forum at Edugeek contains many Fog related threads
http://www.edugeek.net/forums/o-s-deployment/

= About the Developers =

=== Chuck Syperski ===

Chuck Syperski is the lead developer for FOG computer imaging solution. He is a software developer and network integration specialist for a public school district outside of Chicago, IL. Chuck Syperski has a Bachelor of Science in Computer Science from the University of Illinois and is half way done with his master's degree :). He specializes in Java, jsp, jsf, objective C, C, C++, C#, perl and php. You can contact Chuck Syperski directly via sourceforge as the following link:

http://sourceforge.net/users/microleaks/

Chuck Syperski releases other software titles through his company [http://cwssoft.com CWS Software LLC]

=== Jian Zhang ===

No content

Clamav

2013-03-02T22:51:47Z

Chad-bisd: /* Ubuntu 10.04 LTS */ removed note at the end.

==Clamav on Debian Lenny==
The current version of clam with Debian stable aka Lenny does not seem to work with FOG. I did the following to get clam working.

#First remove stable version of clam: '''aptitude purge clamav-freshclam clamav clamav-daemon'''
#Now add the source for the newer version of clam: '''nano /etc/apt/sources.list'''
#I added:
<nowiki>#clam</nowiki>

<nowiki>deb http://volatile.debian.org/debian-volatile stable/volatile main contrib non-free</nowiki>
#'''aptitude update'''
#Now proceed with the fog installation script

'''Note:''' The above must be done before you install fog. For testing download the [http://en.wikipedia.org/wiki/EICAR_test_file Eicar Test Virus] to a test workstation and run the clam task on that system. Once the scan has finished the result can be found in the reports section of the FOG web interface.

==ClamAV on Ubuntu==
===Ubuntu 10.04 LTS===
<ol>
<li>*Optional Steps*
<ol>
<li>Remove ClamAV installed with Fog because it's out of date and generates too many warnings when trying to update, if it updates at all</li>
<li>Add the PPA to your sources list: ppa:ubuntu-clamav/ppa</li>
<li>Get the newest clamav installed on your Fog Server</li>
<li>Update your definitions by running freshclam</li>
</ol>
</li>
<li>Disable scripted updates and let ClamAV download definitions to the root of the web server. Add "ScriptedUpdates off" to the freshclam.conf file on the Fog Server.</li>
<li>Expand the Fog init file. (from [[Modifying_the_Init_Image]])
<ul>
<li>cd /tftpboot/fog/images</li>
<li>gunzip init.gz</li>
<li>mkdir initmountdir</li>
<li>mount -o loop init initmountdir</li>
</ul>
</li>
<li>Modify the freshclam.conf file inside the init. Add "DatabaseMirror MyFogServerNameOrIP" and "ScriptedUpdates off" to this file.</li>
<li>Compress the init file.
<ul>
<li>cd /tftpboot/fog/images</li>
<li>umount initmountdir/</li>
<li>rmdir initmountdir</li>
<li>gzip init</li>
</ul>
</li>
<li>Make symbolic links to the ClamAV files in the root of the web server
<ul>
<li>cd /var/www</li>
<li>ln -s /var/lib/clamav/bytecode.cvd</li>
<li>ln -s /var/lib/clamav/daily.cvd</li>
<li>ln -s /var/lib/clamav/main.cvd</li>
</ul>
</li>
<li>Setup a virus scan task for a host and watch your client download the definitions from your Fog server and run the scan</li>
</ol>

Main Page

2013-03-01T06:36:58Z

Chad-bisd: Added link to new forums

'''Welcome to the FOG Wiki pages'''

FOG is a free, open source computer cloning solution and this wiki contains the bulk of documentation for the project. If you feel you have something to offer the documentation, please feel free to edit it. We just ask that you keep it in good taste.

Thanks,

The FOG Project Team

''' The Spammers Win '''

We can no longer keep up with the spam that is posted to this WIKI, so we have disabled account creation. If you would like an account, please request one in our [http://www.fogproject.org/forum forums].

'''Change Log'''

<pre>

Version 0.32
------------

Release date: July 22nd, 2011

*Added ability to disable chkdsk after imaging (doesn't function with scheduled jobs)
*Added ability to change the computer's hostname from init.gz
*Remoted need for fogprep
*Installer now will attempt to install dhcp3-server if isc-dhcp-server doesn't exist
*Extended use of OO classes
*Fixed imaging listing overflow on manual registration
*Init now mounts NFS using TCP.
*Fixed issue: 3324065 - typo on snap in page
*Fixed issue: 3367423 - AD auto population issue with '/'

Version 0.31
------------

Release date: Jun 20th, 2011

*New web UI (All thanks to Peter Gilchrist)
*Updated kernel version 2.6.39.1
*Added Spanish translation (Thanks Pablo J. Mayordomo García)
*Updated chntpw to version 110511
*Updated clamav to 0.97.1
*Fixed spelling error in Inventory report
*Fixed issue: 3157703 - disk space reporting (thanks Corey Edwards)
*Fixed issue: 3194588 - Spelling error in help dialog (thanks Nathan Lock)

Version 0.30
------------

Release date: Feb 23th, 2011

*Rebuilt init image (ALL Thanks to Aaron Bergz!!!!) details below
**Converted to Busy Box
**Added detection for number of CPUs
**Parallel upload image compression
**Added drive write cache check.

*Update memtest from 4.0 to 4.2
*Updated kernel to version 2.6.37 (core)
*Added kernel branch - core
*Added additional search fields to the host search from the inventory table
*Updated chntpass support to scan partitions looking for sam file

Version 0.29
------------

Release date: May 25th, 2010

*Removed the need for etherwake, implemented WOL in php code.
*Fixed issue with upstart vs sysvinit with tftpd-hpa
*Fixed issue with scheduled tasks and Windows 7 failing
*Fixed program files path issue on FOG Service installer
*Updated AV Scan to check for a two partition setup with Windows 7
*Added Follow page to about
*Added silient install option for the FOG service
*Added Pending MAC address report
*Added DMI Information to the Client System Information pxe menu item
*Updated pxelinux.0 to version 3.86 and added memdisk
*Got Capone ready for production use.
*Updated dmidecode from 2.7 to 2.9
*Updated Memtest86+ to 4.0
*Updated device IDS (pci.ids)
*Updated ClamAV to version 0.96-exp
*Added ability for ClamAV to scan rars
*ClamAV now caches virus defs. on the server.
*Updated photorec and testdisk to 6.11.3
*Added Host Status (basic ping)
*Fixed background image streching issue on Login History Image.
*Added Chinese (Simplified) translation
*Added FOG Prep for Windows 7 image upload
*Added Italian translations
*Added internationalization support (Thanks Luca Berton!)
*Changed to a sprite for the menu bar (Thanks John Deery!)
*Removed dependency "libmd5-perl" from installation as it is not needed.
*Upgraded jpggraph to version 3.0.7
*Removed ereg functions and replaced with preg_match as they are deprecated in php 5.3.x+
*Fixed bug (2882606) spelling error on Loan Form. Thanks neodawg
*Applied patch (2886212) to allow Quick registration to set default values. Thanks Andrew Single
*Fixed mkswap issue (2962069) Thanks Acacha
*Cleaned up the Kernel Updater
*Updated kernel to 2.6.33.3
*Added ability to search for hosts by additional macs
*Added MAC Manufacturer Lookup
*Multiple MAC address support
*changed hostname changer to use unmanaged code to (un)join domain
*Network bandwidth graph should no longer flicker
*Started migration to OO API

Version 0.28
------------

Release date: September 28th, 2009

*Updated Kernel to version 2.6.31.1
*Fixed issue with multicasting a mutli-part image for windows 7
*Added ajax based active task listing
*Added nombr kernel option which will not blow away mbr (Thanks Line Noise)
*If storage node MAX_CLIENTS is set to 0, it is no longer a random candidate.
*Updated syslinux to version 3.82
*Added client information to pxe menu.
*Installation script checks if it is being run as root.
*Fixed tftp installation to NOT overwrite customizations.
*Fixed HD information on hardware info page (2857507).
*Added ability to add custom PXE menu items.
*Decreased loading time for login page.
*Fixed typo in tasks.advanced.include.php
*Replaced append argument "quiet" with loglevel=4
*Added Hidden Menu option to PXE Menu builder
*Added primary group to host quick info section. (Thanks sam wilson)

Version 0.27
------------

Release date: July 15th, 2009

*Added support for Windows 7
*Added Scheduled Task Support
*Fixed Fedora 11 issue where apache would fail to start.
*Fixed to support Fedora 11 change of dhcpd configuration file
*Fixed Ubuntu services to terminate more gracefully.
*Fixed issue with installer not configuring services correctly
*Updated syslinux tools 3.81
*Added web based log viewer
*Updated Kernel to version 2.6.30.1
*Allowed Kernel updater to specifiy a alternate file name.
*Changed default username for password reset to "Administrator" from "administrator" thanks schmalenegger
*Fixed spelling error in fog script (2629489)
*Fixed bug (2669367) for use of mysql_real_escape_string before a connection was defined, thanks schmalenegger
*Applied patch (2654529) , thanks schmalenegger
*Applied patch (2767897), thanks Matthew Fusaro
*Set PXE timeout value to save in db (2654680), thanks schmalenegger
*Added proxy support to web UI (2716741), thanks schmalenegger
*Added pci.ids so lspci will give usefull description.
*Changed ascii logo.
*Added auto-populate of image file name for new image files.

Version 0.26
------------

Release date: February 27, 2009

*Added Quick Image Function
*Added advanced tasks to host -> basic tasks page
*Updated kernel to 2.6.28.7
*Applied patch (2616743) from schmalenegger adding keymap to default pxe boot file
*Applied patch (2537449) from schmalenegger fixing the getIPAddress for non-english installs.
*Applied patch (2512766) from schmalenegger fixing spelling errors in hosts.edit.include.php
*Added Windows 7 to supported OS List (Do not yet use, not functional!)
*Added Windows Password reset tool.
*Added Windows Password reset script for debug mode (no task needed)

Version 0.25
------------

Release date: January 13, 2009

* Updated capone to (hopefully) work with storage nodes.
* Updated kernel to 2.6.28
* Changed Image tmp directory to no longer include colons.
* Slight improvements to mutliple partition support
* Fixed possible premature exit of loop in service functions file. (Thanks Pierre Rognant)
* Added default page display option.
* Added config setting for ssh username.
* Added config setting for ssh port number.
* Fixed Disk Information on Dashboard.
* Allow for viewing disk information of storage nodes
* Fixed Image Log/Report
* Fixed ??? forcing of a task.

Version 0.24
------------

Release date: December 1, 2008

* Added Storage Group framework.
* Added SSH Java Client
* Added task stats for unicast transfers to the active tasks page.
* Added Image ID to image listing
* Upgraded memtest86+ to 2.10
* Used modifed partimage to allow printing status to stderr.
* Fixed error thrown when partition is already resized to correct size during upload.
* Fixed issue with blank hard disk detection
* Updated functions.include.php to include better error message for upload task creation failures.

Known Issues
* Capone not yet updated, if you are using admin plugin, *capone*, DON'T UPDATE TO THIS VERSION!

Version 0.23
------------

Release date: October 27, 2008

* Fixed wipe tasks' kernel argument issue
* (2076993) Added option to add computer to domain from fog.reginput
* (2089168) Fixed quotes in snapin args.
* Added nicer error on IE's failing to display disk information.
* Added icon on task page to signify is task is active on host
* Minor Updates to Module capone (Thanks: Peter Sykes)
* Updated Kernel to 2.6.27

Version 0.22
------------

Release date: September 24, 2008

* Change client modules to unmanaged shutdown/reboot methods: TaskReboot, AutoLogout, GreenFog
* Update PrinterManager to support Windows Shared Style Printers (Thanks: elishughes)
* Updated ClamAv to version 0.94
* Updated MemTest86+ to Version 2.01
* Added option to force device for hard disk per host.
* Added option to specify alternative kernel per host.
* (2078165) Improved ajax script that displays remaining disk space.
* Added option to set timeout on pxe menu builder.
* (2085281) Incorrect error message on PXEMENU page.
* (2100818) Fixed default populations of AD information.
* Improved MulticastTask.class.php added --max-wait param (Thanks: mikrorechner)
* Improved MulticastTask.class.php to support missing part (Thanks: mikrorechner)
* Updated Kernel to 2.6.26.5
* Added Equipment Loan Report
* Added Capone (client specific extension)
* Added Plugin System
* (2078618) Fixed wol.php to function on ubuntu (thanks: Phil G)
* (2063135) Fixed Stale tasks after removal of host. (thanks: Mark Featherston)

Version 0.21
------------

Release date: August 22, 2008

* Added FOG Mobile Portal
* modified user to include mobile account type
* Changed mac address field in new host screen to parse mac address
* Added graphical pxe boot as default
* Added PXE Boot Menu configuration options

Version 0.20
------------

Release date: August 18, 2008

* Added default values for AD support in fog settings section.
* Changed service installer image
* Removed brownbark theme
* Added ability to delete large number of hosts via groups.
* (2043261) PXELinux.0 updated to version 3.71
* Add ability to sort tables a few sections.
* Added retry to set default printer in printer manager
* Updated remaining modules to now check server for status.
* Fixed: On host service module update, screen resolution would be set to disabled (0,0,0)
* Changed login form to track logins on new server as well as current server.
* Updated kernel 2.6.26
* (2025167) Fixed update process when default md5 sum is not used.
* Added very basic update script.

Version 0.19
------------

Release date: July 21, 2008

* (2002771) Fixed installtion of dhcp, when user selects not to use fog for dhcpd.
* Improved installer for faster upgrades.
* Added redirect page in web root, if a file doesn't exist.
* (2021536) Fixed force task issue.
* (1992895) Added Date/Time to image listing
* Modified service modules to handle delayed connections.
* Added kernel argument per host.
* Added global kernel argument setting.
* Minor interface improvements.
* Fixed: PrinterManager user state error, where new user logins not detected.

Version 0.18
------------

Release date: June 25, 2008

* Fixed: Image IDs not showing up in IE7
* (1991304) Fixed: Turned off Magic Quotes at runtime.
* Removed shutdown option from wake on lan task, for obvious reasons.
* (2001844) Fixed: Fixed PhotoRec
* (1998697) Added: --no-htmldoc option to fog installer
* (1997803) Fixed dd error during file upload. (Patched by Elis Hughes)
* Added grub/swap support to Linux multiple partition support (Patched by elishughes)

Version 0.17
------------

Release date: June 19, 2008

* Updated installer to remove tftpboot.fogbackup if it exists
* Added image listing and os listing to for.reginput
* Added Snapin Log Report
* Added return code on snapin installations. (Patched by Stonekeeper)
* Added ability to deploy msi/headless executables snapins.
* Added logging/reporting of unicast image tasks (Patched by Stonekeeper)
* Added delay to PrinterManager, DisplayManager & UserTracker to account for slow logins
* (1990265) Fixed race conditions with multicast manager; starting invalid number of clients (Patched by Dan Fego)
* Fixed Post_Wipe.php to user new database settings (Patched by Stonekeeper)

Version 0.16
------------

Release date: June 9, 2008

* Fixed problem with restarting of FOG service installer when a module is disabled.
* Fixed CSS on Floating Alert Box for IE7 to position the OK button correctly on the form
* (1977697)Fixed Inability to link a printer to a host/group under ie7.
* Fixed Floating Alert Box to now move above menu bar in Firefox 3.0
* Added make to package list to better support fedora 9
* Added Poweroff support to kernel via ACPI and APM
* Update Kernel to 2.6.25-4
* Added keymap support for alt. keyboard layouts
* Added debug module to output various information to the log
* Added User Cleanup Module
* Added Directory Cleaning module
* Added Auto Log Off module
* (1967052) Added work around for schema installer when database already exists.
* Added table globalSettings, moduleStatusByHost, and a few others
* Updated schema version to 9
* Updated FOG_Printer_Manager module to allow access to the named pipes from non-admin users.
* Added "--no-upgrade" option to fog installer
* Added Easy Update to make upgrading from version to version easier in the future.
* Added FOG Settings page to the "other information" section of fog management.
* Added option to make page animations optional.
* (1940447) Fixed Password validation issue.
* Cleaned up the task confirmation page.

Version 0.15
------------

Release date: April 18, 2008

* Fixed - Deploy all snapins to group.
* Added FTP connection information for NFS server
* Fixed user tracker report to include host.
* Updated kernel with atl2 patch 2.04
* Fixed dd issue introduced in version 0.14

Version 0.14
------------

Release date: April 8, 2008

* Added basic multiple partition support
* Improved installer with default values
* (1920830) After host removal, all tasks linked with host are deleted.
* Modified S01reboot in boot image to disable saving of random seed
* Added fogpartinfo binary to boot image for better disk detection
* Added 3 new operating systems to the support OS table.
* Added basic backup utility.
* Added ability to replace an existing snapin file.

Known/Outstanding Issues
* Percentage reported by multipartition multicast session is incorrect.
* Multipartition has issues with grub.
* Multipartition will not work with extended partitions.

Version 0.13
------------

Release date: March 21, 2008

* Made installer language independent
* Made DHCP startup optional
* Added build-essential to the ubuntu install list
* Added FOG Tray Icon
* Changed TaskReboot to optionally reboot with user logged in

Version 0.12
------------

Release date: March 4, 2008

* Added Hardware Inventory Task
* Added Printer Installation Service Module
* Added User Tracking Service Module
* Added FOG Reporting
* Added Enhanced Registration Method
* Added Client FOG Service Updater
* Feature Request #1902517 - Change FOG upload behavior to include removal of Page File and Hibernate file.
* Added Basic Tasks to Host management screen
* Added Login History to the Host management screen
* Added Hardware Inventory to host management screen
* Added printer management to host management screen
* Updated Kernel to 2.6.25-rc3
* Fix # 1901545 - Add insecure option to all exports
* Fix # 1892693 - New user passwords only characters
* Added HTMLDoc to list of install packages
* Added 3 sec pause to pxe boot
* Added pxe boot option fog.memtest
* Added pxe boot option fog.reg
* Added pxe boot option fog.reginput
* Updated Partprobe to 1.8.6
* Put a freeze on changes to AbstartFOGService.dll
* Put a freeze on changes to FOGService.exe

Known Issues
* Setting of default printer is currently not functional.

Version 0.11
------------

* Cleaned up group removal page.
* Cleaned up user removal page.
* Fixed CSS on footer
* Moved delete button to the bottom of the group edit page to keep a consistant look and feel.
* Added FUSE to the kernel
* Added ClamAV to the boot image
* Added Virus History to the Host Edit pages
* Added Virus Summary to Information Section
* Feature Request #1886328: Added insecure option to exports

Version 0.10
------------

* Fix #1881264: GPT/MSDOS MBR Error
* Added client kernel updater
* Branched to two kernel types: kitchensink and skinny
* Added FOG version and estimated users to login screen.
* Added DNS and router configuration to the installation script.
* Added interface configuration to the installation script.
* Added DD disk imaging support.
* Updated schema to version 5.

Version 0.09
------------

* Added Multicast support using UDPCast
* Added FOGMulticastManager service
* Feature Request #1860234: Added "List all Hosts" to hosts section
* Feature Request #1860774: Added ability to modify all the oses for a group
- Thanks bjornan
* Added unmanaged api call to reboot client in FOG service
* Added Search to Groups section of FOG Management
* Added Search to Images section of FOG Management

Version 0.08
------------
* Fix #1843328: changed constant()'s to define()'s in functions.include.php
- Thanks Gabor Halasz
* Fix #1845874: fixed image by group problem.
- Thanks Gabor Halasz
* Fix #1848708: Replaced hardcoded image directory with STORAGE_DATADIR
- Thanks Gabor Halasz
* Fix #1850687: WOL enhancement merged.
- Thanks Gabor Halasz
* Fix #1850700: Hardcoded webroot in dashboard.include.php
- Thanks Gabor Halasz
* Fix #1850854: hardcoded dns server in intrd & tmp cleanup
- Thanks Gabor Halasz
* Fix #N/A: Fixed capital Y/N response in installer returning: "Invalid repsonse"

* Added Ubuntu installer support
* Added Snapin support
* Added Snapin subservice
* Added domain registration
* Added patition resize percent to config.php
* Added advanced option Send without Snapins
* Added advanced option Deploy Snapins
* Added advanced option Deploy sinlge snapin
* Changed function getNumberOfTasks to not include orphaned tasks
* Updated jpgraph to version 2.3
* updated db schema to version 3

Version 0.07
------------
* Changed default theme from BrownBark to BlackEye.
* Added theme option to config file.
* Added Fast Disk wipe.
* Added Disk Surface test.
* Updated Linux Kernel to 2.6.23.8.
* Removed Kernel module support.
* Removed Kernel swap disk support.
* Added ramdisk size option to config file.
* Added GUI support to the FOG Service.
* Added graphical config to the FOG Service.
* Added Task Reboot sub service.
* Changed IP address from a mandatory to optional field.
* Modified host upload making IP address optional here too.
* Added ability to delete image files from web GUI.

Version 0.06
------------
* Fixed Upload Resize Bug.
* Added CSV host import
* Added Vista support to hostname change module.
* Added Host Registration module with XP and Vista support
* Corrected join in Active Tasks page

Version 0.05
------------
* Added memtest86+
* Added testdisk
* Added photorec
* Cleaned up GUI a little
* Added AJAX bandwidth monitor
* Added AJAX HD monitor

Version 0.04
------------
* Added advanced boot options

Version 0.03
------------
* Added Windows Vista Support^
* Added vista MBR to boot image
* Added FOGVistaMbr Fix application to image
* Added xxd to the image
* updated ntfsutils to version 2.0
* updated db schema to version 2
* Added url to download the client installation package

Bug Fixes
* Added alternate method to detect hard disks, which
will detect a disk that has not partition on it.
* Fixed sudo to allow apache to run etherwake.

^ In order for vista to work, the following commands
must be run as administrator BEFORE uploading the image.

bcdedit /set {bootmgr} device boot
bcdedit /set {default} device boot
bcdedit /set {default} osdevice boot

Version 0.02
------------
* Moved user config settings from the main install script to lib/config.sh
* Cleaned up Kernel and included new .config file
* added installation notification
* added fog service with hostname changer
* minor bug fixes

Version 0.01
------------
Initial Product Release

</pre>

Modifying the Init Image

2013-02-11T23:03:05Z

Chad-bisd: fixed grammar errors on last line

==Modifying the Boot Image==
If you wish to modify the way that the pxe/tftp works files in the /tftpboot directory can be edited.
===Using scripts===
Modifying the boot image is easy to do. FOG comes with a script that enables you to easily modify the init image.

The script mounts the image and decompress it so you can view its files to modify them, however it tries to open nautilus to show you the files. Bear in mind that if you have no GUI (or your connected via ssh) you will have to browse the files manually in

/tmp/tmpMnt/

To run the script execute the file in here

/opt/fog/utils/Boot Image Editor/FOGMountBootImage.sh

That will execute the script, when your done modifying the Init image hit Enter and the file will be re compress and set ready to use.

===By Hand===
Or, to do it by hand:
<pre>
cd /tftpboot/fog/images
gunzip init.gz
mkdir initmountdir
mount -o loop init initmountdir
</pre>

After you're done making changes, you have to clean up and unmount the init image:
<pre>
cd /tftpboot/fog/images
umount initmountdir/
rmdir initmountdir
gzip init
</pre>

==Examples==
===Adding sfdisk to the /sbin directory===
This will add the <tt>sfdisk</tt> program into the boot environment:
<pre>cd /tftpboot/fog/images
gunzip init.gz
mkdir initmountdir
mount -o loop init initmountdir</pre>
init is now ready for modification. Make your changes:<pre>
cp /sbin/sfdisk /tftpboot/fog/images/initmountdir/sbin</pre>
Modifications Complete. Unmount and re-gzip it:<pre>
umount initmountdir
rmdir initmountdir
gzip init</pre>Now you can use the sfdisk program from the PXE environment.
===Remove Authentication from Quick Image===
This example will show how to automatically authenticate users when they select Quick Image. If you are happy to allow anybody to deploy an image to a hardrive this is for you.
<pre>cd /tftpboot/fog/images
gunzip init.gz
mkdir initmountdir
mount -o loop init initmountdir
cd /tftpboot/fog/images/initmountdir/bin/</pre>
Edit fog.quickimage 
Comment out the followig lines by putting a # in front
<pre> #echo " Enter a valid FOG username and password.";
#echo "";
#echo -n " Username: ";
#read username;
#echo ""
#echo -n " Password: ";
#stty -echo
#read password;
#stty echo;
#echo "";
#echo ""</pre>

Replace with:
<pre> username="a valid username"
password="a valid password";</pre>
Save the modification<pre>
cd ../..
umount initmountdir/
rmdir initmountdir
gzip init</pre>

You are done and now users can image without the need for a username and a password.

User:Chad-bisd/Using FOG in VirtualBox

2012-09-15T06:26:29Z

Chad-bisd: /* Creating the Client */

==Overview==
This tutorial is meant to introduce the reader to using FOG in a virtual environment using Oracle VM Virtualbox.

==Requirements==
*Host computer with dual/quad core process and 4GB+ RAM running a VirtualBox compatible OS
*Oracle VM VirtualBox installed on host computer
*OS Install images (ISO or CD/DVD)
** Linux for FOG server (Ubuntu 10.04 LTS)
** Windows XP, Vista, 7, etc for clients
*Internet connection

'''Note:''' VirtualBox works best on processors that support Hardware Virtualization (VT-x/AMD-V). While it will run on other processors, the performance suffers.
==Creating the virtual FOG Server==
Once you have Oracle VM VirtualBox installed, start it and create a new virtual machine definition by clicking the "New" button. This will start the wizard that guides you through creating a virtual machine definition.

Name the virtual machine and select the Operating System (Linux) and Version (Ubuntu). Select the amount of memory to allocate to the virtual machine depending on how much memory is in the host. Usually 1GB is plenty for a FOG server for testing. Create a new startup disk, select VDI type, dynamically allocated. The size of the virtual disk depends on just how much you plan to test with it. For this test client, only the base install of Windows is used, so 20 GB is plenty. Continue through the wizard and finish creating the virtual machine definition.

Select your virtual machine definition and click Settings. Go to the Network section, click on Adapter 2, and enable it. Change the Attached to: value to Internal Network, and name the network "FogPXE". Click OK to save. Start the virtual machine by double clicking the definition name or by selecting it from the list and clicking the Start button in the VirtualBox top menu.

The First Run Wizard! should start and help you install the operating system. Click Next. Choose the ISO or CD/DVD that contains your OS install. We'll choose an Ubuntu 10.04 Server i386 ISO file that we downloaded earlier. '''Don't worry about having GUI at this time, we'll install one later if needed.''' Click Next after selecting the install file. Click Start to begin the OS install on our first virtual machine.

===Installing Ubuntu===
The virtual machine reboots and launches the ISO, which launches the Ubuntu install. Select English for the language and hit Enter. Select "Install Ubuntu Server" from the menu and hit Enter. '''If your mouse gets stuck in the virtual machine, the right control key will break it out for you.''' Select English again for the language and hit Enter. Select United States for the country and hit Enter. Select No to detect keyboard layout unless you have a really really special keyboard. Select USA as origin of the keyboard and hit Enter. Select USA as the keyboard layout and hit Enter. The installer begins the process of installing Ubuntu. This may take several minutes.

====Configuring the Network====
When prompted for the Primary Network Interface, choose eth0 and hit Enter. At this point, it's hard to tell which interface is the NAT'ed one and which is the internal network one, so let's just hope they are detected in the right order. If you chose the right one, it will get IP configuration info from the DHCP server built into VirtualBox. Don't get confused at this point, it's just how VirtualBox assigns IP addresses to the virtual network interfaces that are inside VirtualBox.

Set the hostname when prompted. Choose something meaningful, like FOGMaster, and hit Enter. You'll be prompted for time zone info with an educated guess already chosen. It's usually right, so just hit Enter or select No and choose the right time zone.

====Partitioning the Disk====
When prompted for disk partition info, select the default: Guided - use entire disk and set up LVM, and hit Enter. You should only have one disk shown in the next screen, so select it and hit Enter. On the next screen you'll have to move the selection to Yes in order to write the changes to disk and configure LVM. So just arrow over to Yes and hit Enter. Leave the default size for the volume group and hit Enter to continue. At the prompt to write the changes to disk, arrow over to Yes and hit Enter. The installer creates the volume group, partitions, and file systems necessary for the OS.

The installer now installs the OS onto the virtual disk. This may take a few minutes depending the speed of the host.

====Setting up the Primary User====
When prompted for the Full Name of the new user, select almost anything other than "fog". Your first and last name will do just fine. Enter them and hit Enter. The installer prompts for a username and defaults to your first name. This is probably fine unless your first name is "fog". If your first name really is "fog", just make the username "admin" or something simple one word and not a Linux reserved user name (do not use root, nobody, fog, wwwroot, etc...) Hit Enter to accept the username. Type in a password and hit enter. Confirm password and hit enter. Do not encrypt your home directory, so choose No and hit Enter.

'''IMPORTANT:''' Remember the username and password from here.

====Updating Software Packages====
If you use a proxy server to get to the internet, type that information in when prompted and hit Enter. If you do not use a proxy server, leave it blank and hit Enter. The installer goes through a few more steps setting up the system, retrieving a bunch of files from somewhere, whatever. The installer prompts for update settings. Choose No Automatic Updates and hit Enter.

When prompted for addition software to install, leave the options blank and tab down to Continue and hit Enter. All the software we'll need we will install later either via the FOG install script or manually using apt.

====Finalizing the Install====
Select Yes when prompted to install GRUB boot loader to the master boot record and hit Enter. At the Installation Complete prompt, select Continue and hit Enter. VirtualBox will automatically unmount the install files and boot straight into Ubuntu.

===Configuring Ubuntu===
There are a few things to do to the Ubuntu OS after the install. First we'll login as the user we created during the install. The user account does not have root privileges without using the sudo command. Almost every command from here on will begin with sudo.

====Setting a static IP====
Because the virtual machine has two network adapters, we need to determine which is the NAT'd one and which is the private one. Run the command:
<pre>sudo ifconfig</pre>
When prompted, enter your password again. You should see the interface configuration printed to the screen. If we selected the correct primary interface during setup, we should see eth0 having an inet addr: 10.0.2.X. If you only have a "lo" interface listed, then we got something wrong. Keep reading and see if you can figure out what is wrong as we continue to configure the network settings.

This virtual machine has two network adapters, but only one is showing up. This is because we have not told Ubuntu how to bring the other interface up, i.e. static IP or dhcp, or even told it we want the other interface to come up at boot time. To do that, we'll edit the /etc/network/interfaces file.

<pre>sudo nano -wS /etc/network/interfaces</pre>

Let's break down that command and explain what each part does. "sudo" makes the command run in privileged mode. "nano" is the name of the editor. "-wS" are arguments to nano. "-w" means don't wrap long files. Very important when editing configuration files. "S" means smooth scrolling, or line by line scrolling rather that page by page. "/etc/network/interfaces" is the name of the configuration file for Ubuntu's networking interfaces.

Arrow down to the bottom of the page and add a section for the other adapter. In most cases, the second adapter will be "eth1". So hit Enter to leave a blank line and type the following:
<pre># The internal FOG PXE interface
auto eth1
iface eth1 inet static
address 10.1.1.12
netmask 255.255.255.0
</pre>
Don't worry about the static IP address too much here. Since this interface is on an "internal network" inside VirtualBox, only interfaces specifically setup to be part of the same internal network will be able to see it. Hit Ctrl+O to save, hit Enter to write to the file /etc/network/interfaces when prompted. Hit Ctrl+X to quit nano.

Bring up the second adapter.
<pre>sudo ifup eth1</pre>
and check it with
<pre>sudo ifconfig</pre>
You should see eth0, eth1, and lo adapters. If you do, then we're done configuring the network. If you don't, verify your /etc/network/interfaces file is correct.

====Updating Ubuntu====
It is very important to update Ubuntu before moving forward with the FOG installation. Many issues can be avoided by installing up to date packages for this release.

First, we'll update the package repository since it is out of date. The current repository may only know about the packages from the install file.
<pre>sudo apt-get update</pre>

Next, we'll upgrade all the base packages that need them. This does not upgrade us from Lucid to the next version, only upgrades the packages within this release.
<pre>sudo apt-get upgrade</pre>

This takes a while, but when it's done, install the dkms package in preparation for installing the VirtualBox Guest Additions later.
<pre>sudo apt-get install dkms</pre>

I also had problems with the console scrolling really slow. To resolve this, I added
<pre>blacklist vga16fb</pre>
to the end of the /etc/modprobe.d/blacklist-framebuffer.conf file and rebooted. The console was much snappier.

===Installing FOG===
The FOG install is very standard for Ubuntu 10.04. Please review the [[Ubuntu_10.04#Setting_up_FOG]] installation guide.

Some differences from a basic install. You'll want to change the IP address to the one you gave to eth1 when you configured it static. You'll change the interface FOG uses from eth0 to eth1, and you install the DHCP server.

The settings should be:
Ubuntu
Normal Server
10.1.1.12
no dhcp router address
no dhcp dns address
interface: eth1
yes to dhcp
no to internationalization

FOG will then download and install the various packages used such as Apache2, PHP, MySQL, etc. Since this is a virtualbox install, do NOT put in a mysql root user password. After a while, all the packages will be installed and verified and you'll having a working FOG server.

Leave this virtual machine running for now.

==Creating the Client==
===Defining the Virtual Machine===
In the Oracle VM VirtualBox Manager window, click New to make a new virtual machine definition. Our first client will be just to make sure that PXE booting is working, so it doesn't really matter what Operating System or Version we choose. Name the VM "FOG Client 1" for now, choose Microsoft Windows, and whatever version of windows you have a licensed. Specify enough RAM for the machine to work but not run your host system out of memory. Create a new Virtual Hard Disk accepting the defaults. Now select the "FOG Client 1" definition and click Settings. Click the System section on the left and the Motherboard tab in the right side panel.

We're going to adjust the boot device order so the computer tries to PXE boot first. Check the Network option in the Boot Order list, and then use the arrows on the right to move it to the top. Now we need to adjust the network settings, so choose Network on the left panel. We want 1 adapter to be for PXE boot. Change Adapter 1 to Internal Network. From the drop down box for the Internal Network name, choose FogPXE, which must match what you specified for the FOG Server virtual machine adapter. If you select it from the drop down list you're pretty safe it will be the same. Enable Adapter 2 and set it for NAT. This will give out client access to the internet for updates, etc. Click OK to save the settings then start the virtual machine by selecting it from the list and pressing the Start option in the top menu or double clicking the VM Name.

You will get the First Run Wizard. For this time, we're going to ignore this so we can get to PXE boot. Just hit Cancel. After a few seconds, you should be greeted with PXE boot messages and finally the FOG menu. Arrow down to stop the timer so you can read the menu before it disappears.

===Installing the client OS===
Since we cancelled out of the First Run Wizard! we have to manually start up the OS installer. You can install from a CD/DVD or ISO file. Once you have the disc or ISO file, use the devices menu to attach the device to the virtual machine and then reboot/start the virtual machine and let it run through the boot order, which should be Network, floppy, CD/DVD, Hard Drive. The OS installer should kick off shortly after the FOG menu times out.

Install a minimal OS for now just so we can test upload and deploy.

Ubuntu 10.04

2012-09-15T05:53:24Z

Chad-bisd: /* Making FOG accessible at the root of the server (optional) */

== Overview ==

This guide uses a live installer cd version of Ubuntu, and then covers the installation of FOG.

== Known issues ==

=== Language issue ===

This tutorial will probably only work with the English Installation of Ubuntu.

=== FOG version issues ===

With Ubuntu 10.04, FOG versions 0.30 and 0.31 will not install cleanly. So it is recommended to only use versions 0.29 or 0.32 or greater, or carefully follow the guidance below.

==== Libmd5-perl installation issue (FOG versions < 0.29) ====

If you get an error during installfog.sh regarding libmd5-perl (FOG 0.28 and earlier -- dependency removed in FOG 0.29), you need to manually download and apply the package:

wget http://ftp.us.debian.org/debian/pool/main/libm/libmd5-perl/libmd5-perl_2.03-1_all.deb
sudo dpkg -i libmd5-perl_2.03-1_all.deb

==== PXE Error - Boot file not found (FOG versions < 0.29) ====

If PXE can't locate your boot file, Ubuntu and FOG may be expecting it to be in different places. Creating a symbolic link may resolve the issue:

<pre>
sudo rmdir /var/lib/tftpboot
sudo ln -s /tftpboot /var/lib/tftpboot
</pre>

== Installing Ubuntu ==

An Ubuntu cd/dvd can be obtained from:

http://www.ubuntu.com/

After burning a cd/dvd of the ISO image, we must boot the live cd.

During boot select '''Install Ubuntu 10.04 LTS''' menu item.

[[Image:10.04.install.png]]

The next screen(Step 2 of 7) will ask you about your time zone settings, in our example we will select '''Chicago''' and click '''forward'''.

[[Image:10.04.tz.png]]

The following screen(Step 3 of 7) will ask you for your keyboard layout, in our example we will select '''USA''' and click '''forward'''.

[[Image:10.04.keyboard.png]]

The next screen(Step 4 of 7) will prompt you for partitioning information, we will select to '''Erase and use entire disk''', and click '''forward'''.

[[Image:10.04.part.png]]

Now(Step 5 of 7) you will need to enter some user account information, enter the required information and click, '''forward'''. In this example, we used the username '''administrator''', please '''do not''' use '''fog''', this account will be created for use by the FOG system.

[[Image:10.04.user.png]]

On the final screen(Step 7 of 7), click '''install''' to start the installation process.

At this point the installer will take over, this process may take a long time, so please be patient.

When you are prompted, restart the server.

== Setting a static IP address ==

After the server restarts, log in with the account your created during installation.

[[Image:10.04.nm.png]] or [[File:Othernm.png]]

Right-click on the Network-Manager icon, and select '''edit connections...'''

[[Image:10.04.ec.png]]

In the Network Connections window select profile '''Auto eth0''' and click '''Edit'''

[[Image:10.04.ip.png]]

Go to the IPv4 Settings tab:

*Change Method to Manual
*Make sure '''Connect Automatically''' is checked
*Add your static IP address with netmask and gateway.
*Add a DNS Server address
*Add a DNS suffic/Search domain
*Ensure that '''Available to all users''' is checked.

Hit '''Apply'''

At this point you may need to click on the Network Manager icon and select '''Auto eth0''' for the profile to be applied.

Confirm your new settings are active by right-clicking on Network-Manager again and selecting '''Connection Information'''.

== Updating Ubuntu ==

This step is optional, but highly recommended especially if you are running this server in a production environment.

#Click the '''System Menu -> Administration -> Update Manager'''
#Click the '''Check''' button.
#Enter your password
#Click '''Install Updates'''

If a restart is required, then do so at this time.

== Setting up FOG ==
Now we must download the FOG package from sourceforge.

Option 1: To do this click on Applications -> Internet -> Firefox Web Browser and enter the URL: http://sourceforge.net/projects/freeghost/files/
:Then click on the Download link.
:Then click on the latest release (version 0.29 or later) to start the download. It should be named something like fog_x.xx.tar.gz

Option 2: At the Ubuntu Server console, type the following to download the .32 version. Search for the latest version at link above:
:<pre>sudo wget http://sourceforge.net/projects/freeghost/files/FOG/fog_0.32/fog_0.32.tar.gz</pre>

Open a terminal (Applications -> Accessories -> Terminal)

Now let's create a directory to store the downloaded FOG installers: <pre>sudo mkdir -p /opt/fog-setup</pre>
:'''Note:''' don't use /opt/fog for this directory because the installer script will create that directory for application files later.

Now let's copy that file into the fog-setup directory with:<pre>sudo cp ~/Downloads/fog_*.tar.gz /opt/fog-setup/</pre>

Now we can extract the file, and perform the installation with the following commands.
<pre>
cd /opt/fog-setup
sudo tar -xvzf fog*
cd fog*
</pre>
'''Note:''' If you run FOG inside an OpenVZ container, you now want to [[Ubuntu_and_OpenVZ|edit some files]] before continuing.

Now run the installer script with:
<pre>
cd bin
sudo ./installfog.sh
</pre>

'''Your answers to the setup questions will depend on whether you are installing FOG in an [[FOG on an Isolated Network|isolated network]] or an [[Integrating FOG into an Existing Network|existing network]] that already has a functioning DHCP server. Please read the appropriate guide and adjust your answers accordingly.'''

You will be prompted for the Linux distro you are installing, enter '''2''' and press '''enter'''.

You will be prompted for the installation mode, either '''N''' (Normal Server) or '''S''' (Storage Server). If you are not sure which option to select, use '''N''' for Normal Installation.

The installer will ask you for the IP address of the server, then press '''enter'''.

The installer will ask if you would like to enter a router address for DHCP, if you would like to press '''y''' and press '''enter''', then enter the address, then press '''enter'''.

The installer will ask if you would like to enter a DNS address for DHCP and the boot image, if you would like to press '''y''' and press '''enter''', then enter the address, then press '''enter'''.

You would then be prompted if you would like to change the default interface from eth0, if you would like press '''y''', press '''enter''' and add the interface (if you are unsure, select '''n''').

You will be prompted to select if you would like to install the packages required for translations, if you would like to, press '''y''''.

Acknowledge and follow the on screen instructions for "MySQL". '''DO NOT SET A PASSWORD''' for the root account.

After the installation has completed open Firefox again and enter the URL: http://localhost/fog/management. You will then be prompted to install the database schema. Click on the '''Install/Update Now''' button.
[[Image:0.29.schema.png]]

When the schema is up to date, attempt to go to the URL: http://localhost/fog/management again. This time you should be prompted to login:
<pre>
username: '''fog'''
password: '''password'''
</pre>

[[Image:0.29.login.png]]

== Final preparation of the FOG server ==

=== Making FOG accessible at the root of the server (optional) ===

Edit the apache index.html via nano or your chosen editor: <pre>sudo nano -w /var/www/index.html</pre>
Change the content to look like:
<pre>
<html>
<head>
<meta http-equiv="Refresh" content="0; URL=fog/index.php">
</head>
</html>
</pre>

Save (ctrl+o), quit (ctrl+x) and you should now be able to access FOG at http://server-name-or-ip/.

=== Increasing the PHP file size upload ===
After Ubuntu is installed, we need to modify the server to allow Snapin's of larger sizes.

Modifying PHP for FOG Snapin use - http://www.fogproject.org/wiki/index.php/Managing_FOG#Ubuntu

=== MySQL configuration ===
{{MySQL Configuration}}

== Testing your installation ==
{{Testing your installation}}

Moving your images directory/Adding Storage to the Images directory

2012-09-06T23:02:57Z

Chad-bisd: added section headers

{{Merge|target=Adding Storage to a FOG Server|discuss=Talk:Adding Storage to a FOG Server}}
==Overview==
If you need to add storage capacity to your images directory or you would like to replace your /images directory with a larger capacity array/hard drive here are the basic steps. We are going through the steps on Ubuntu, but they should be very similar on Fedora.

==Prepping the new disk==
*Determine the device node by running
sudo fdisk -l
*Locate the entry the matches your device you are adding for something like /dev/sdX where X is a letter.

*Make sure the device is formatted with ext3/4. Your should see a partion listed like this:
Device Boot Start End Blocks Id System
/dev/sdX1 1 121601 976760001 83 Linux
*If you have a partition that isn't either ext3/4, you will need to delete them with the following commands. '''Note: This WILL make the data on the partition unreadable!'''
sudo fdisk /dev/sdX
p
*Take note the number of partitions you need to delete and for each of them do:
d
[parition number]
*When you are done removing the partitions type:
w
q
*At this point if you don't have any partitions on the disk we can create it with the following commands:
sudo fdisk /dev/sdX
n
1
p
1
[enter]
[enter]
t
83
w

*Now we can format our partition with:

mkfs.ext3 /dev/sdX1

Please note the 1 at the end.

*Now we are going to get the UUID of the device using:

sudo blkid /dev/sdX1

record the UUID value

==Moving images folder to new storage==

*Move and recreate the image directory with:

sudo mv /images /images1
sudo mkdir /images

*Now we want to setup /etc/fstab to make sure the device gets mount during boot up.

sudo nano /etc/fstab

or

sudo gedit /etc/fstab

*Add the following line to the bottom

UUID=XXXXXXXXXXXXXXXXXXXXXX /images ext3 defaults 0 0

*Mount it with:

sudo mount -a

*Check that is mounted with:

mount

*Copy your images back to your new directory

sudo cp -Rf /images1/* /images/

*Change permissions with:

suco chown -R fog /images
sudo chmod -R 755 /images
sudo chmod -R 777 /images/dev

If you want to just add capacity to your images directory, you could instead mount your new device as a subfolder of the /images directory. In this case your wouldn't need to move the original directory to /images1, and your fstab line would look like:

UUID=XXXXXXXXXXXXXXXXXXXXXX /images/newdisk ext3 defaults 0 0

Reset WebUI FOG password

2012-08-01T02:38:30Z

Chad-bisd: tidied up the article a bit

== Overview ==
If somehow you lose access to the FOG server web interface, you can use the following procedure to connect to the MySQL database and reset the password for any existing FOG user. These user accounts and passwords are only for logging into the FOG server web interface and should not be confused with other fog users in the operating system.

== Reset password ==

On the FOG server where the MySQL "fog" database is installed, execute the commands:

*If the root user in MySQL does not have a password:
<pre>
sudo mysql -u root fog
</pre>

*If the root user in MySQL does have a password:
<pre>
sudo mysql -u root -pROOTUSERPASSWORD fog
</pre>

*Run this query to reset the password. You can change users other than "fog" by changing the uName value in the query.
<pre>
UPDATE users SET uPass = MD5('password') WHERE uName = 'fog';
exit;
</pre>

Login to the WebUI with:
*Username: fog
*Password: password (or whatever you used in the query above inside the MD5 call)

User:Treydock

2012-07-31T05:55:42Z

Chad-bisd: Created page with "Are you still around and available to finish the article on Fog deployment nodes? ~~~~"

Are you still around and available to finish the article on [[Fog deployment nodes]]? [[User:Chad-bisd|Chad-bisd]] 23:55, 30 July 2012 (MDT)

Fog deployment nodes

2012-07-31T05:53:42Z

Chad-bisd: moved overview section to top and heading 2 level since page title is the only heading 1 preferred on the page

== Overview ==
This article will cover how to extend the functionality of FOG to host multiple FOG "nodes" that are controlled by a central FOG "master". Much of the credit for this can be found on the page [[Multiple_TFTP_servers|Including multiple PXE / TFTP servers]]. What I've done is refined this process a bit, and also will cover some additional techniques for managing the nodes.

Currently I operate 4 "nodes" and a single master. Each node is dedicated to it's own building and/or department to allow them to perform their own imaging without the need to manage a full FOG install. Where this differs slightly from the previously mentioned article is that these nodes can both capture and deploy images to their own subnets or use images from the master server.

This setup has been tested and implemented using FOG-0.30 on CentOS 5.6 both i386 and x86_64 systems.

==FOG Master Role==
The master has the following primary functions
* Web front end to manage FOG
* Controls all tasks for FOG nodes
* Provides the necessary PXE boot files and menus
* Capture and deploy images using DHCP, TFTP, and PXE

== FOG Node Role ==
The nodes have the following functions
* Capture and deploy images using DHCP, TFTP, and PXE

= Installing a FOG node =
The process for installing a node is identical to the normal install except for a few minor changes to the install scripts.

In the fog_0.30 folder where the install files were extracted, you need to modify the '''bin/installfog.sh''' to add '''configureDHCP;''' and '''configureTFTPandPXE;''' under the "# Storage Node installation" section.

Here is what the resulting list should look like.
<pre>
configureUsers;
configureMinHttpd;
configureStorage;
configureNFS;
configureDHCP;
configureFTP;
configureTFTPandPXE;
configureUDPCast;
installInitScript;
installFOGServices;
configureFOGService;
sendInstallationNotice;
writeUpdateFile;
</pre>

You also need to add the appropriate packages to be installed at '''lib/redhat/config.sh'''. On the line '''storageNodePackages''' add '''tftp-server dhcp'''. Adjust this for your distribution.

Here's the full line on my install
<pre>
storageNodePackages="httpd php php-cli mysql php-mysql nfs-utils vsftpd xinetd tar gzip make m4 gcc gcc-c++ lftp tftp-server dhcp";
</pre>

= Further Details =

This is a work in progress...more to come.

Integrating FOG into an Existing Network in non intrusive mode

2012-07-30T05:00:40Z

Chad-bisd: /* Installation */ fixed link to user guide

== Overview ==
An existing network is assumed to have DHCP and DNS services already functioning on separate server(s), as well as full Internet connectivity. No changes will be required on existing infrastructure. Also network operation will not be affected. The only inconvenience is that in order to image computer one had to know it's MAC address.

'''Note:''' The FOG installation makes several queries to resources on the Internet. The server must be connected to the Internet during the initial installation.

== Installation ==
<ol>
<li>Install the base OS</li>
<li>Connect to the Internet and update the base OS</li>
<li>[[FOGUserGuide#Installing_FOG|Install FOG]]
<ol>
<li><tt>What type of installation would you like to do? [N] n</tt> 
Choose Normal. Read the on-screen explanation for details.</li>
<li><tt> What is the IP address to be used by this FOG Server? [current address]'''192.168.1.1'''</tt> 
Your server's current Internet address is displayed. It is better to use static IP address</li>
<li><tt> Would you like to setup a router address for the DHCP server? [Y/n] n</tt> 
No.</li>
<li><tt> Would you like to setup a DNS address for the DHCP server and client boot image? [Y/n] n</tt> 
No.</li>
<li><tt> Would you like to change the default network interface from eth0? 
: If you are not sure, select No. [y/N] n</tt> 
This would allow us to keep one network card connected to the Internet, and use a second network card for the internal private network. This is beyond the scope of this guide.</li>
<li><tt> Would you like to use the FOG server for dhcp service? [Y/n] Y</tt> 
Yes. This allows clients to get IP addresses on the network and connect to the FOG server.</li>
<li><tt> This version of FOG has internationalization support, would you like to install the additional language packs? [Y/n]</tt> 
Choose Yes if you'd like to install additional languages</li>

<li><pre> #####################################################################

FOG now has everything it needs to setup your server, but please
understand that this script will overwrite any setting you may
have setup for services like DHCP, apache, pxe, tftp, and NFS.

It is not recommended that you install this on a production system
as this script modifies many of your system settings.

This script should be run by the root user on Fedora, or with sudo on Ubuntu.

Here are the settings FOG will use:
Distro: Ubuntu
Installation Type: Normal Server
Server IP Address: X.X.X.X (your IP address)
DHCP router Address:
DHCP DNS Address:
Interface: eth0
Using FOG DHCP: 1
Internationalization: 1

Are you sure you wish to continue (Y/N) y</pre>
If it all looks good, enter Y</li>
<li><pre>
Installation Started...

Installing required packages, if this fails
make sure you have an active internet connection.

* Preparing apt-get
* Installing package: apache2
...
...
...</pre>The install continues... 
The following message is displayed:<pre> * Installing package: mysql-server

We are about to install MySQL Server on
this server, if MySQL isn't installed already
you will be prompted for a root password. If
you don't leave it blank you will need to change
it in the config.php file located at:

/var/www/fog/commons/config.php

Press enter to acknowledge this message.
</pre>
Just press enter a couple times.</li>

<li><tt> Send notification? (Y/N)y </tt>
::<tt> * Thank you, sending notification...</tt> 
In one person's experience, this step freezes more often than not. If you choose Yes and it takes longer than a few seconds, it is likely frozen.
Here is a solution: [[Thank_you,_sending_notification]]</li>
<pre>Done

Setup complete!

You still need to install/update your database schema.
This can be done by opening a web browser and going to:

http://192.168.1.5/fog/management

Default User:
Username: fog
Password: password

$</pre>
</ol>
<li>Immediately stop Fog's DHCP server not to affect the network</li>
<li>Edit Fog's dhcpd.conf the following way:

<pre>
# DHCP Server Configuration file.
# see /usr/share/doc/dhcp*/dhcpd.conf.sample
# This file was created by FOG
use-host-decl-names on;
ddns-update-style interim;
ignore client-updates;
# Fog's IP address:
next-server 172.16.23.195;

# Subnet where you are going to use Fog
subnet 172.16.23.0 netmask 255.255.255.0 {
option subnet-mask 255.255.255.0;
default-lease-time 21600;
max-lease-time 43200;
}

# This machine will receive DHCP offer from Fog's DHCP
host optiplex990_1 {
hardware ethernet 78:2B:CB:CC:CC:CC;
fixed-address 172.16.23.251;
option host-name "test1";
filename "pxelinux.0";
#Default router (if needed)
option routers 172.16.23.1;
}
</pre>
<li>Start Fog's dhcpd server</li>
<li>Ensure that only machine which MAC address were entered to dhcpd.conf can receive DHCP offer from Fog server</li>
<li>If you want to add another machine edit dhcpd.conf and add the new host section: 
<pre>
host NewHost {
hardware ethernet 78:2B:CB:CC:CC:1F;
fixed-address 172.16.23.252;
option host-name "test2";
filename "pxelinux.0";
#Default router (if needed)
option routers 172.16.23.1;
}
</pre>
</li>
</ol>

== Updating config files for non-empty MySQL root password ==
{{Updating config files for non-empty MySQL root password}}

Integrating FOG into an Existing Network

2012-07-30T04:59:55Z

Chad-bisd: Added overview and section header for installation

== Overview ==
An existing network is assumed to have DHCP and DNS services already functioning on separate server(s), as well as full Internet connectivity. Changes will have to be made on the DHCP server to forward PXE traffic to the FOG server. See [[Modifying existing DHCP server to work with FOG]] for assistance with this setting.

'''Note:''' The FOG installation makes several queries to resources on the Internet. The server must be connected to the Internet during the initial installation.
== Installation ==
<ol>
<li>Install the base OS and set a static IP address for this server</li>
<li>Connect to the Internet and update the base OS</li>
<li>[[FOGUserGuide#Installing_FOG|Install FOG]]
<ol>
<li><tt>What type of installation would you like to do? [N] n</tt> 
Choose Normal. Read the on-screen explanation for details.</li> 
<li><tt>What is the IP address to be used by this FOG Server? [current address]</tt> 
Your server's current Internet address is pre-filled. Just press enter to accept it.</li> 
<li><tt>Would you like to setup a router address for the DHCP server? [Y/n] Y</tt> 
We assumed there is already exists a DHCP server, so choose yes.</li> 
<LI><tt>What is the IP address to be used for the router on the DHCP server? [preFilled?] type.your.DHCP.address</tt> 
Enter the IP address of your network's DHCP server. FOG may have filled this in automatically.</li> 
<li><tt>Would you like to setup a DNS address for the DHCP server and client boot image? [Y/n] y</tt> 
Enter the IP address of your network's DNS server. FOG may have filled this in automatically.</li> 
<li><tt>What is the IP address to be used for DNS on the DHCP server and client boot image? [preFilled?] type.your.DNS.address</tt> 
Enter the IP address of your network's DHCP server. FOG may have filled this in automatically.</li> 
<li><tt> Would you like to change the default network interface from eth0? 
: If you are not sure, select No. [y/N] n</tt>
This would allow us to have multiple network cards. This is beyond the scope of this simple guide.</li> 
<li><tt>Would you like to use the FOG server for dhcp service? [Y/n] n</tt> 
No. DHCP addresses will be provided by the infrastructure's DHCP server. Having multiple DHCP servers on a single network causes a race condition for the clients, and potentially conflicting IP addresses if they are issuing out addresses within the same range.</li> 
<pre> DHCP will not be setup but you must setup your
current DHCP server to use FOG for pxe services.

On a Linux DHCP server you must set:
next-server

On a Windows DHCP server you must set:
option 066 & 067</pre>
Noted. Be sure to work with the DHCP admins to get PXE services forwarding to your FOG server. See [[FOGUserGuide#Modifying_existing_DHCP_server_to_work_with_FOG|Modifying existing DHCP server to work with FOG]] for assistance with this.</li> 
<li><tt> This version of FOG has internationalization support, would you like to install the additional language packs? [Y/n]</tt> 
Choose Yes if you'd like to install additional languages</li> 

<li><pre> #####################################################################

FOG now has everything it needs to setup your server, but please
understand that this script will overwrite any setting you may
have setup for services like DHCP, apache, pxe, tftp, and NFS.

It is not recommended that you install this on a production system
as this script modifies many of your system settings.

This script should be run by the root user on Fedora, or with sudo on Ubuntu.

Here are the settings FOG will use:
Distro: Ubuntu
Installation Type: Normal Server
Server IP Address: your.FOG.server.address
DHCP router Address: your.DHCP.address
DHCP DNS Address: your.DNS.address
Interface: eth0
Using FOG DHCP: 0
Internationalization: 1

Are you sure you wish to continue (Y/N) y</pre>
If it all looks good, enter Y</li> 
<li><pre>
Installation Started...

Installing required packages, if this fails
make sure you have an active internet connection.

* Preparing apt-get
* Installing package: apache2
...
...
...</pre>The install continues... 
The following message is displayed:<pre> * Installing package: mysql-server

We are about to install MySQL Server on
this server, if MySQL isn't installed already
you will be prompted for a root password. If
you don't leave it blank you will need to change
it in the config.php file located at:

/var/www/fog/commons/config.php

Press enter to acknowledge this message.
</pre></li>
<li>Choose a root password for your MySQL service. Take note of the file name above as it will have to be edited post-install.</li> 

<li><tt> Send notification? (Y/N)y </tt>
::<tt> * Thank you, sending notification...</tt> 
In one person's experience, this step freezes more often than not. If you choose Yes and it takes longer than a few seconds, it is likely frozen.
Here is a solution: [[Thank_you,_sending_notification]]</li> 
</ol>
The Installation script is complete:
<pre>Done

Setup complete!

You still need to install/update your database schema.
This can be done by opening a web browser and going to:

http://192.168.1.5/fog/management

Default User:
Username: fog
Password: password

$</pre></li>
</ol>
==Updating config files for non-empty MySQL root password==
{{Updating config files for non-empty MySQL root password}}

FOG on an Isolated Network

2012-07-30T04:57:08Z

Chad-bisd: /* Installation */ updated link to section in fog user guide

== Overview ==
The physical layout of this type of installation is a server (or robust desktop), a high-speed multi-port switch, a handful of Ethernet cables, and of course your target machines. 
Note: The FOG installation makes several queries to resources on the Internet. The server must be connected to the Internet during the initial installation. In the example below, we are removing that connectivity after installation. This will break a few built-in features such as ClamAV updating. 
== Installation ==
<ol>
<li>Install the base OS</li>
<li>Connect to the Internet and update the base OS</li>
<li>[[FOGUserGuide#Installing_FOG|Install FOG]]<ol>
<li><tt>What type of installation would you like to do? [N] n</tt> 
Choose Normal. Read the on-screen explanation for details.</li> 
<li><tt> What is the IP address to be used by this FOG Server? [current address]'''192.168.1.1'''</tt> 
Your server's current Internet address is displayed. When FOG is installed we will be disconnecting from the Internet and defining our own private IP address. Enter your future static IP private address: 192.168.1.1</li> 
<li><tt> Would you like to setup a router address for the DHCP server? [Y/n] n</tt> 
No. A router is not part of this simple isolated network.</li> 
<li><tt> Would you like to setup a DNS address for the DHCP server and client boot image? [Y/n] n</tt> 
No. Also unnecessary in this simple network</li> 
<li><tt> Would you like to change the default network interface from eth0? 
: If you are not sure, select No. [y/N] n</tt> 
This would allow us to keep one network card connected to the Internet, and use a second network card for the internal private network. This is beyond the scope of this simple guide.</li> 
<li><tt> Would you like to use the FOG server for dhcp service? [Y/n] Y</tt> 
Yes. This allows clients to get IP addresses on our private network and connect to the FOG server.</li> 
<li><tt> This version of FOG has internationalization support, would you like to install the additional language packs? [Y/n]</tt> 
Choose Yes if you'd like to install additional languages</li> 

<li><pre> #####################################################################

FOG now has everything it needs to setup your server, but please
understand that this script will overwrite any setting you may
have setup for services like DHCP, apache, pxe, tftp, and NFS.

It is not recommended that you install this on a production system
as this script modifies many of your system settings.

This script should be run by the root user on Fedora, or with sudo on Ubuntu.

Here are the settings FOG will use:
Distro: Ubuntu
Installation Type: Normal Server
Server IP Address: 192.168.1.1
DHCP router Address:
DHCP DNS Address:
Interface: eth0
Using FOG DHCP: 1
Internationalization: 1

Are you sure you wish to continue (Y/N) y</pre>
If it all looks good, enter Y</li> 
<li><pre>
Installation Started...

Installing required packages, if this fails
make sure you have an active internet connection.

* Preparing apt-get
* Installing package: apache2
...
...
...</pre>The install continues... 
The following message is displayed:<pre> * Installing package: mysql-server

We are about to install MySQL Server on
this server, if MySQL isn't installed already
you will be prompted for a root password. If
you don't leave it blank you will need to change
it in the config.php file located at:

/var/www/fog/commons/config.php

Press enter to acknowledge this message.
</pre>
Just press enter a couple times. We will not be setting a MySQL password since this is your own private network.</li> 

<li><tt> Send notification? (Y/N)y </tt>
::<tt> * Thank you, sending notification...</tt> 
In one person's experience, this step freezes more often than not. If you choose Yes and it takes longer than a few seconds, it is likely frozen.
Here is a solution: [[Thank_you,_sending_notification]]</li> 
</ol>
<pre>Done

Setup complete!

You still need to install/update your database schema.
This can be done by opening a web browser and going to:

http://192.168.1.5/fog/management

Default User:
Username: fog
Password: password

$</pre>
</ol>

== Updating config files for non-empty MySQL root password ==
{{Updating_config_files_for_non-empty_MySQL_root_password}}

Template:Updating config files for non-empty MySQL root password

2012-07-30T04:25:41Z

Chad-bisd: removed extra "password' in the instructions

If you choose to set a password for the MySQL root user, there are two files that must be updated on the server. This only applies to the "N" (Normal) installation mode. FOG servers installed in "S" (storage) mode will use the "fogstorage" username and appropriate password to connect back to the MySQL database on the main fog server.

edit <tt> /var/www/fog/commons/config.php</tt> and enter your MySQL root password in this line:<pre>define( "MYSQL_PASSWORD", "password" );</pre>
edit <tt> /opt/fog/service/etc/config.php</tt> and enter your MySQL root password in this line:<pre>define( "MYSQL_PASSWORD", "password" );</pre>

Ubuntu 10.10

2012-07-30T03:47:57Z

Chad-bisd: initial creation: moved 10.10 specific info out of the 10.04 LTS article.

== Overview ==
Installing FOG on Ubuntu 10.10 follows the same steps as installing FOG on [[Ubuntu 10.04|Ubuntu 10.04 LTS]], with the following exceptions.

== PCMCIA NIC initialization issue (Ubuntu issue) ==

The installer for Ubuntu 10.10 server properly initializes PCMCIA NICs during the installation process, but it does not configure the server to automatically initialize the NICs after installation is completed. Therefore when the server starts up, it has no network connectivity.

There are two ways to work around this:

#The easy way - Use the "Alternate Install" disc, currently at version 10.04.01 LTS. Select the language that you want. Before clicking "Install", press F4 and select "Install a command-line system". Now click "Install". The installer on this CD will automatically set up the server to properly initialize the PCMCIA NICs.
#The harder way - Use the "Server" installation disc but add the "pcmciautils" package, which automagically fixes this problem. The machine will need an active Internet connection in order to download this package. Go through most of the installation steps in the normal way. When it prompts you to install the boot loader, press the F2 key to open another console. Type the following:

<pre>
apt-get install pcmciautils
</pre>

Ubuntu 11.04

2012-07-30T03:43:51Z

Chad-bisd: added link to 10.04 LTS install article

==Overview==

Installing FOG on Ubuntu 11.04 follows the same steps as [[Ubuntu 10.04|installing FOG on 10.04 LTS]] with these exceptions.


== Known (FOG) version issues ==
=== FOG 0.31 ===
==== dhcp3-server to isc-dhcp-server ====

With Ubuntu 11.04, the standard dhcp package was changed to isc-dhcp-server. FOG 0.31 only looks for isc-dhcp-server (this was fixed in .32), therefore to use FOG version .31 with Ubuntu 11.04 you will need to edit the following files:

<pre>/opt/fog_0.31/lib/ubuntu/config.sh</pre>

{|
|Line
|Original
|Change
|-
|24
|isc-dhcp-server
|dhcp3-server
|-
|27
|isc-dhcp-server
|dhcp3-server
|-
|46
|/etc/dhcp/dhcpd.conf
|/etc/dhcp3/dhcpd.conf
|}

<pre>/opt/fog_0.31/lib/ubuntu/function.sh</pre>
{|
|Line
|Original
|Change
|-
|353
|isc-dhcp-server
|dhcp3-server
|-
|354
|isc-dhcp-server
|dhcp3-server
|-
|355
|isc-dhcp-server
|dhcp3-server
|}

Talk:Integrating FOG into an Existing Network

2012-07-30T02:18:42Z

Chad-bisd: Created page with "==Rewrite Needed?== I think this article needs a rewrite. It should list what is different than the isolated network install only and link back or transclude the appropriate ..."

==Rewrite Needed?==
I think this article needs a rewrite. It should list what is different than the isolated network install only and link back or transclude the appropriate information to keep from duplicating info that may become out of date if it's not edited in all the different places. [[User:Chad-bisd|Chad-bisd]] 20:18, 29 July 2012 (MDT)

Template:Testing your installation

2012-07-30T01:19:35Z

Chad-bisd: Initial creation: moving this to a template because it could be reused in various installation articles but is non-specific enough to allow transclusion

Now that everything is installed, you will need a client to test your installation.

#On a client, change the boot order to boot from network or PXE boot as the first boot device.
#You may also need to enable network booting in some BIOSes
#Boot up the computer and you should see the FOG boot menu that will give you a few options
#select '''memory test''' and if memtest loads you should be ready to run!

Template:MySQL Configuration

2012-07-30T01:17:12Z

Chad-bisd: removed header layer to make the template more flexible by allowing the transcluding page to set the header level

MySQL needs to be setup to accept connections from remote machines. This is not the default behaviour on many distros.

Check the file:

<pre>/etc/mysql/my.cnf</pre>

and look for the line beginning with:

<pre>bind-address=</pre>

This should read:

<pre>bind-address=<IP of FOG Server></pre>

rather than:

<pre>bind-address=127.0.0.1 or bind-address=localhost</pre>

Remember to restart MySQL if you make changes to this file:

<pre>sudo /etc/init.d/mysql restart</pre>

Talk:Ubuntu 10.04

2012-07-30T00:50:18Z

Chad-bisd:

== 11.04 info on the 10.04 page ==
It is my thought that the 11.04 info be removed from this page and moved to the article on 11.04 install, which should be created if not already present. As it stands now, it's just confusing and the line seems to be inserted fro nowhere. [[User:Chad-bisd|Chad-bisd]] 18:50, 29 July 2012 (MDT)

== Misc ==
Question:

during isntallation, there are 2 questions I don't understand and don't know what to enter.

The installer will ask if you would like to enter a router address for DHCP, if you would like to press y and press enter, then enter the address, then press enter.
The installer will ask if you would like to enter a DNS address for DHCP and the boot image, if you would like to press y and press enter, then enter the address, then press enter.

If I am NOT going to use the server as DHCP server, do I need to put here th eDHCP and DNS of my own?

The question is tricky for me.

== Why ask questions on a wiki discussion page??? ==

The wiki is akin to 'the manual' and these discussion tabs are intended to discuss proposed changes to or comments about the manual. Please use the forum:
http://www.fogproject.org/forum/
[[User:Itismike|Itismike]] 23:26, 7 July 2011 (UTC)

Password Central

2012-07-12T16:24:19Z

Chad-bisd: /* Common Knowledge */ removed reference to old forum post since old forum is no longer visible.

= This page is a work in progress - feel free to help! =
See the Discussions tab at the top for templates and known password locations.
And please, feel free to make adjustments and add content!<HR>
FOG relies on many passwords. On a simple installation most of these are handled automatically. On more advanced installations troubleshooting password mismatches can be challenging. The page linked below aims to be a single resource to explain all passwords necessary for FOG in all its various configurations.
=== Common Knowledge ===

The only password that is encrypted in FOG is the password used for joining computers to a domain; Info->FOG Settings->Active Directory Defaults; all other passwords are listed in plain text.

=== Basic Installation ===
====Fog's user account on main FOG server====
This is a standard user account on the server. It is named 'fog' 
Common errors associated with this mismatched password:
<ul>
<li>FOG can't do anything</li>
<li>Unexpected, strange errors</li>
<li>...</li>
</ul>
How to modify this password:
:The location varies per operating system.
:To reset it, type this at the command line on the Main FOG server:
<pre>sudo passwd fog</pre>

====FOG user on web interface====
Common errors associated with a mismatched password:
<ul><li>Can't log into FOG web interface</li>
<li>...</li>
</ul>How to update it: 
:<tt>sudo ...</tt>
====MySQL root user ====
The MySQL root user is normally only used on the main Fog server. Storage nodes use the <tt>fogstorage</tt> user instead of root.

Common errors associated with a mismatched password:
<ul><li><pre>Unable to connect to Database
Msg: Failed to connect to server: localhost Server returned: Access denied for user 'root'@'localhost' (using password: YES) </pre></li><li>[https://sourceforge.net/projects/freeghost/forums/forum/716419/topic/4859086/index/page/1 Scheduled Tasks fail to run]</li></ul>
How to update it: 
:Changing the root admin password in MySQL is not simple. It's a lot easier to enter a known root password in the file mentioned below. This is an older guide, but might be helpful if a root password is lost:
http://www.debian-administration.org/articles/442
<ul>Additional notes<li>In a private network this is usually not set. The installer urges a blank password.</li>
<li>The password is also in the following files:<ul><li><tt>/var/www/fog/commons/config.php</tt></li>
<li><tt>/opt/fog/service/etc/config.php</tt></li></ul></li>
</ul>

====FOG Quick Image password====
How to update it: 
From the GUI:
:About > PXE Boot Menu >
From command line (note this will be overwritten if the GUI is updated)
:<tt>sudo vi tftpboot\pxelinux.cfg\default</tt>

== Additional Passwords Outside of a Basic Installation ==

=== Storage Nodes ===
====FOG user account on storage node====
<ul>Common errors associated with this mismatched password:
<li><unknown></li>
</ul>
How to update it:
:On the Storage Node: <tt>sudo passwd fog</tt>
====MySQL connector back to Main FOG server====
<ul>Common errors associated with this mismatched password:
<li><tt>/images/</tt> directory does not update - contains no images</li>
<li>...</li>
</ul>
How to update it:
<pre>vi /var/www/fog/commons/config.php
define( "MYSQL_DATABASE", "fog" );
define( "MYSQL_USERNAME", "fogstorage" );
define( "MYSQL_PASSWORD", "b83cd3" );</pre>
====FTP Connection from Storage Node to Master FOG Server====
<ul>Common errors associated with this mismatched password:
<li><unknown at this time></li>
</ul>
How to test it:
<OL><LI>On the Master FOG Server, copy the password from this file:
<pre>cat /var/www/fog/commons/config.php
...
...
...
define( "STORAGE_FTP_USERNAME", "fog" );
define( "STORAGE_FTP_PASSWORD", "[---------longPassword---------]" );
...</pre></LI>
<li>Using the above credentials, attempt an FTP session back to the Main FOG Server 
From the Storage Node:<pre>ftp [FOG_Main_Server_IPAddr]
Connected to [IPAddr].
220 (vsFTPd 2.2.2)
Name ([IPAddr]:[user]):fog
331 Please specify the password.
Password: [paste that longPassword from above]
230 Login successful.</pre>
</LI></ol>
To verify that FTP is functional:
<OL><li><unknown at this time></LI>
</OL>

----

Dell Dimension 2400 with Broadcom 4401 Onboard NIC/Cisco Catalyst 2950 Switch

2012-06-27T06:02:23Z

Chad-bisd: added info about portfast and STP settings.

Ethernet card takes too long to negotiate with Cisco switch and fails to get DHCP Address. '''Resolution''': Press ''Pause/Break'' on keyboard after BIOS until port is negotiated on switch (port is green), hit ESC, and DHCP will get address.

Another option might be to adjust your spanning tree protocol (STP) settings to allow portfast for all non-uplink ports (ports that connect to a leaf object, not another switch/router).

Managing FOG

2012-06-27T05:57:21Z

Chad-bisd: /* Installing the Node */ added username and password info

== Managing FOG ==

=== Dashboard ===

==== Overview ====

[[Image:fogmainpage.jpg]]

The FOG dashboard is the first page you are presented with after login. This page just gives you an overview of what is happening on your FOG server.

==== System Overview ====

The system overview box is the the top left hand box on this page. The information presented in this box is the current user, the server IP addresse or hostnames for your web server, tftp server and storage server (which can all be different). This section also gives you the system uptime or how long the system has been running without restart, the number of users logged into the Linux box, and lastly the system load.

==== System Activity ====

The system activity box is in the top row, the middle box. What this section shows is the unicast queue, or the number of unicast downloads that are currently in progress, which on a default setup, the maximum value is 10. This means that after 10 hosts are receiving images (at once) the 11th will wait for one of the hosts in progress to complete before starting. The reason this was created was so that you could queue up 100 machines with different images (all unicast) and still keep the system functional. We have heard of this queue being used to re-image an entire building of computers ( ~ 1000+ ) overnight. This section only updates on page refresh, and not in real time.

==== Disk Information ====

The disk information box is the top, right hand section of the dashboard page. This is a semi-realtime display of the storage remaining on the storage server. If you get an error in this box, please see [[Dashboard Error: Permission denied...]]

==== 30 Day Imaging History ====

This image shows your imaging trends for the past 30 days

==== Menu Bar ====

[[Image:fogmenu.jpg]]

This menu appears at the top of every page on Fog's web UI. The icons are, from left to right:

'''Home/Dashboard''' - This is the home screen of the FOG management portal.

'''Users''' - Individual administrators of the FOG resources.

'''Hosts''' - This section houses the hosts, which are the pcs to be imaged or to extract images from.

'''Groups''' - This section houses groups, which are similar PCS’ that need tasks done en-masse.

'''Images''' - This section allows you to manage the image files stored on the FOG server.

'''Storage Management''' - This section allows you to add/remove storage nodes from the FOG system.

'''Snap-ins''' - This section provides ways to automate various post-imaging tasks, not covered in this document

'''Printers'''' - This section allows for management of printers, allowing you create printer objects that can later be assigned to hosts or groups.

'''FOG Service Configuration'''' - This section allows you to control how the client service functions.

'''Tasks''' - This section allow you to perform imaging tasks such as acquiring or deploying images.

'''Reports''' - Reports let you pull information from the FOG database either as HTML, pdf, or csv.

'''About''' - The section has the rest of the settings that don't fit anywhere else like the kernel updater and the client service updater.

'''Logoff''' - Click this to log off of the Fog web UI.

Note: “Groups” do not control group memberships. Group memberships are controlled via the ‘host’ icon.

=== Hosts ===

==== Overview ====

[http://freeghost.sourceforge.net/videotutorials/hostinfo.html Video Tutorial]

A host in FOG is typically a computer, but it can be any network device. Hosts are used to identify a computer on the network and are used to manage the device.

==== Adding a new host ====

===== Method 1: Manually Adding =====

[http://www.fogproject.org/videotutorials/addimghost.html Video Tutorial]

Adding a new host can be done in the hosts section of FOG (the single monitor). Then by clicking on the "Add New Host" button on the left hand menu. At least a hostname and a MAC address must be entered in order to add the host to the FOG database.

A host consists of the required fields:

*'''Hostname''' - A string used for the Windows Hostname of client, this must be less than 15 characters long.
*'''MAC address''' - This field is used in for for a unique identifier for the host. The string must be separated by : (colon), in the format of 00:11:22:33:44:55.

Hosts can also include, but are not required:

*'''IP address''' - Just your typical IP address, in the typical formation of X.X.X.X or 192.168.1.1.
*'''Description''' - Information for your own reference.
*'''Image Association''' - This field is a drop down box that will allow you select an image object created in the '''Images''' section.
*'''Operating System''' - Drop down box that allow you to select the primary type of operating system running on this host.
*'''Kernel''' - This is only used if you want to overwrite the default kernel used for FOG. Needs to be specified as fog/kernel/mybzImage
*'''Kernel Arguments''' - This allow you to add additional kernel arguments for booting the host (ie: vga=6, or irqpoll).
*'''Primary Disk''' - This option allows you to force a device to use during imaging if fog fails to detect the correct device node.

This page also allows for configuration of Active Directory integration, but this topic will be covered later. When all settings are added, click on the "Add" button.

===== Method 2: Adding a new host via Full Registration =====

This is the preferred method (as of version 0.12), and maybe the easiest method for getting a host into the FOG database, but it requires you to visit the host. When at the client computer, during the boot up process when you see the pxe boot menu select '''Perform Full Host Registration and Inventory'''. If you are using the text based pxe boot menu, type '''fog.reginput'''. During this phase you will be prompted for general information about the host like hostname, operation system, and even image. If you enter a valid operating system and image id, you will be able to deploy and image to this computer directly from registration. If you would like to push an image down to this computer, select '''y''' when prompted.

After the requested information is entered, FOG will pull a quick hardware inventory the client.

This method of registration will only register the primary, wired mac address with the FOG server.

For more information on these commands please see:

[http://www.fogproject.org/wiki/index.php?title=FOGUserGuide#Client_Side_Tasks Client Side Tasks]

===== Method 3: Adding a new host via Quick Registration =====

Quick registration is very much like the Full host registration, with the exception that it will not prompt you for any input, nor give you the option to image the computer directly from the registration screen. When the host is added to the FOG server, it will be named with the hosts primary mac address. This method is great for adding a lab of 30 computers to FOG quickly and easily.

To enable this feature

#Go to '''Other Information'''
#select '''FOG Settings'''
#Find section '''FOG Quick Registration'''
#change value '''FOG_QUICKREG_AUTOPOP''' to '''1'''
#Set '''FOG_QUICKREG_IMG_ID''' to the image ID you would like to use for all newly created hosts.
#Set '''FOG_QUICKREG_OS_ID''' to the OS ID you would like to use for all newly created hosts.
#Change '''FOG_QUICKREG_SYS_NAME''' to what you would like to name you new machines, where * will be replaced by a number. If you would like to zero pad numbers you can use '''LAB300-**''' which would result with '''LAB300-03''' or '''LAB300-09'''.
#Set '''FOG_QUICKREG_SYS_NUMBER''' to the first number you would like to use.

After each registration the computer will automatically image and the '''FOG_QUICKREG_SYS_NUMBER''' will incremented by 1.

===== Method 4: Uploading Host Information =====

===== Overview =====

When getting started with FOG, you need to enter the host information for the devices on your network. We understand this can be a long difficult process, so in order to make this process easier we created a page that allows you to upload most of the host information from a CSV file.

The CSV file that is uploaded to FOG must be in the following format, and the file should not have a header row.

MAC Address,
Host name,
IP Address,
Description,
OSID ,
ImageID

===== Other notes =====

<ul>

<li>The MAC Address (required) is the NIC's MAC address seperated by : (colon).</li>

<li>The Host name (required) is the computer's Host name (must be less than 15 characters, should not include underscores, according to [http://tools.ietf.org/html/rfc952]).</li>

<li>The IP Address is the computer's IP address (format x.x.x.x). This field is currently not used by FOG.</li>

<li>The Description is any text description you would like associated with the computer.</li>

<li>The OSID is the number representing the operating system. It can be found in the table "supportedOS" in the field osID.</li>

<li>The ImageID is the number representing the images file linked to this image. The image definition must already exist and this number can be found in the table "images" in the field imageID.</li>

<li>The bold fields are required.</li>

<li>The file must be saved as a CSV without a header row.</li>
</ul>

===== Uploading the File =====

<ol>
<li>After the file is prepared and saved, you will need to log into the FOG Management Portal.</li>
<li>Then click on the Hosts icon.</li>
<li>On the left-hand menu, click on Upload Hosts.</li>
<li>Browse for your file, then click Upload CSV.</li>
</ol>

==== Managing Hosts ====

===== General =====

Once hosts have been added to the FOG database you can modify or delete them. Finding a host which you wish to edit can be done in two ways, the first is by listing all the hosts that exist. This is done by clicking on the "List All Hosts" button. The second way to locate a host is to use the search function. To search for hosts click on the "New Search" button, if you would like to search for all hosts you can enter a "*" or "%". The search function will search in the host's name, description, IP and MAC address.

Once a host is located, it can be edited by clicking on the edit button. Clicking on the edit button will display all the properties that were shown during host creation with the addition of snapin, printers, active directory, service settings, hardware, virus history, and login information.

The entire host object can be removed from the FOG system by clicking on the delete option at the bottom of the Host Menu.

===== Multiple MAC Address Support =====

(Content not yet complete.)

==== Host Status ====

New in version 0.29 of FOG is the Host Status which will basically display an indicator icon next to the host within the FOG UI showing the status of the machine. This function basically does a ping based on the host's name. So in order for this to work you must have an internal DNS server that is tied in with your DHCP server, so that when a DHCP address is given out, the DNS server is notified with the new IP. If that is setup correctly, you must make sure your FOG server is able to ping a host from the command line using:

ping somehostname

If the server isn't able to ping the client, then the status of the host in the UI with always show as unreachable. If you can ping the client using the FQDN, like

#Replace forproject.org with your domain suffix
ping somehostname.fogproject.org

Then you will need to adjust the DNS '''Search domains:''' setting on your sever. After making this change you will need to restart the apache server for it to take affect.

If after this, you still can't ping your clients, the problem may be due to a firewall issue with the clients. In this case, client specific configuration changes might be needed.

==== Creating Host Groups ====

FOG allows you to create groups of hosts which then allows you to take action on a whole grouping of hosts. Hosts can be created either on the "List All Hosts" section or by doing a search for hosts. To create a group select the computer you would like to be member of the group by placing a check in the box next to the hostname, or by clicking the check all button in the title row. After the hosts are selected scroll to the bottom of the screen and then enter a name in the create to group box or select a group to add the hosts to. Then click on the "Process Group Changes" button.

=== Groups ===

==== Overview ====
Groups in FOG are used to organize your hosts into real world logical clusters. This is intended to ease management of the computers. A single host can be a member of infinitely many groups, so if a computer happens to be a member of the group called "Third Floor", it could also be a member of "Math Department", or "Dell PCs." Groups make using FOG possible for organizations with a very large number of PC's.

==== Creating Groups ====

Groups are created in the hosts section of FOG based on searches, for information on how to create groups, please see Creating Host Groups.

==== Managing Groups ====

After a group has been created, it can be managed from the groups section of FOG. Locating groups is very similar to locating hosts, you can either list all groups or you can search for groups. When searching for groups your search criteria is matched against the group name or the group description. Once a group is located it can be modified by clicking on the "Edit" button on the right hand side of the table.

Under the section "Modify Group [Groupname]" there are options to change the group name, group description or to delete the group. If you wish to update the group name or the group description make your change then click on the "Update" button within that section. If you would like to remove the group then simply click on the "Delete" button within this section.

===== Group Basic Tasks =====

This section will allow you to start a task on this group of hosts without going to the tasks section of fog. From this section you can start a unicast deploy to all hosts within the group.

===== Group Membership Setup =====

This page allows you to view / delete membership of the group. This section will list all of the members of the group and give you the option to remove members from the group.

===== Group Image Associations =====

The groups page also allows you to update the image association for all the members of the group. This can be done in the "Image Association for [groupname]" section. Select the image association from the drop-down box and select "Update Images" and then all your host objects for that group will be modified.

===== Group Operating System Associations =====

You can also change the Operating System association for all hosts in the group via the '''OS Assoc''' Button in the Group Menu. Clicking the update button will apply the changes to all members of the group.

===== Group Snapins =====

You can add or remove snapins to all hosts in a group, but because the nature of groups, it is not possible to see what snapins are currently associated with a group. This is because the snapins are not directly associated with the group, the are associated with the host and it is possible for all members of the groups to have different snapins linked with each host. What fog does allow you to do is batch add a snapin to all the hosts within a group. At the same time you can batch remove a snapin from all the hosts within a group. This functions can be done via the '''Add Snapins''' and '''Remove Snapins''' button in the Group Menu.

===== Group Service Settings =====

The '''Service Settings''' page allows you to enable or disable certain service modules on all hosts in the group, as well as change some service settings for group such as screen resolution, and auto log off settings.

===== Group Active Directory Setup =====

Active Directory integration settings can also be distributed to all members of a group via this page. The section "Modify AD information for [groupname]" allows you to do so. This section provides the same options as the host screen but allows you to mass update all of your hosts.

===== Group Printers =====

The '''Printers''' page allows you to add or remove printer associations to all hosts within the group. This page also allows you to set the management level all hosts within the group.

===== Group Membership Information =====

The most important thing to remember about groups in FOG is that they do not contain their own properties. When you make changes to a group, you are really make changes to every host object within the group. For example, if you change the OS association for a group, then go back to the one of the host objects that is a member of that group, it will have the new OS association on that object.

=== Images ===

==== Overview ====

Image objects in FOG are the representation of the physical files that contain the disk or partition images that are saved on the FOG server.

==== Creating Images Objects ====

Image objects in FOG are created in the Images section of the FOG management portal. To create a new image click on the "New Image" button on the left hand menu. An image object requires a name and a image file path.

When creating images you have a few choices in how you want that image to 'act'. The possible partition types include:

<ul>
<li>Single Partition</li>
<li>Multiple Partition - Single Disk</li>
<li>Multiple Partition - All Disks</li>
<li>Raw Image</li>
</ul>

'''Single Partition''' - Single Partition images support only single NTFS partitions. These partitions are resizable, meaning that an image from a 200GB hard disk can be put on a 10GB hard disk as long as the data is less than 10GB. This image type is destructive, which means that your partitions will be modified, and if the task doesn't finish without error it is possible that your computer may not be bootable.

'''Multiple Partition - Single Disk''' - Single Disk will back up all the supported partitions on the first disk drive detected by FOG, but the partitions are NOT resizable by FOG. This means that the image must be restored to a disk of the same or larger capacity. It is possible to backup NTFS drives with vendor specific 'restore' partitions with this type of image.

It is possible to backup Linux systems with this type of image given the following criteria:

<ul>
<li>There is a Grub boot loader present.</li>
<li>LVM is not used.</li>
<li>The partitions include '''ext2''', '''ext3''', '''reiserfs''', or '''swap'''.</li>
<li> The swap partition should be moved out of the extended partition (for ubuntu 9.04) </li>
</ul>

Linux support is still pretty primitive, and has only been tested with a default Ubuntu 8.04 Installation.

'''Multiple Partition - All Disks''' - All Disks will back up all the supported partitions on all disk drives detected by FOG, but the partitions are NOT resizable by FOG. This means that the image must be restored to a disk of the same or larger capacity.

'''Raw Image''' - Raw Image will do a raw sector-by-sector copy of your hard disk, which means that if you have a 80GB hard drive, dd will process 80GB of data, and you will end up with a VERY LARGE image that is VERY SLOW to create and restore.

All of these images can be deployed using multicast or unicast to clients.

==== Modifying Image Objects ====

Image object can be located either by a search or by listing all image objects.

==== Adding Existing Image Objects ====

To restore an image to the FOG database:
<ol>
<li> Create a new Image definition through the management browser</li>
<li> Specify image name (SampleXPImage)</li>
<li> Specify storage group (default)</li>
<li> Specify image file path (SampleXPImage)</li>
<li> Specify image type</li></li>
<li> Log into the box hosting FOG, and move/rename your image to match browser input
<li> Create hierarchy if necessary. FOG, by default, puts images in /images/, so for the above example, you would need to create a folder structure like so: /images/SampleXPImage</li>
<li> Drop your image file into the folder (be sure it's named the same as image name above)</li></li>
</ol>

=== Storage Management ===

==== Overview ====

The Storage Manager section of FOG was added in version 0.24 of FOG and introduces the concept of '''Storage Groups.''' Basically, a storage group is a group of NFS servers that share images and share the load of computers being imaged. Any member of a storage group is referred to as a '''Storage Node.''' You may have as many storage groups as you wish and as many storage nodes within those groups as you wish. In each storage group, there is one storage node which is designated as the '''Master''' of that group. Basically what this means it that is the node where all image uploads go, this node handle multicasting tasks for the group, and is the image replicator the for the group. This means that whatever images are stored on this node are what gets distributed to the entire group.

What this new system of storage management gives us is a distributed model for FOG which allows for more unicast transfers at a single time. We also gain data redundancy. We also take stress off of the main FOG server.

Below is a brief overview of Storage Groups

[[Image:Nfsgroup.jpg]]

This image shows a single Storage Group and the flow of data within the group. The queue size of the system is the sum of the queue size of all the storage nodes within the system. So if you have 4 nodes each with a queue size of 10, then the queue size of the system is 40, which means 40 clients can be imaged (unicast) at one time.

[[Image:StorageGroups.jpg]]

This image shows that it is possible to have multiple storage groups on your network, which are isolated from each other. This image also demonstrates, that uploads always go to the master node and multicast session always send data from the master node. Images are pushed out from the master node of the group to all other members of the group.

'''Key Benefits'''
*Increased throughput
*Redundant Storage
*Scalability

==== Adding a Storage Node ====

Definition: Storage Nodes provide extra [http://www.fogproject.org/wiki/index.php?title=InstallationModes NFS/FTP storage space] which increases available multicast throughput and redundancy within a network. They do not provide PXE, TFTP, or DHCP services at secondary sites. To enable additional PXE and TFTP services at secondary sites see this section: [[#Including_multiple_PXE_.2F_TFTP_servers|#Including multiple PXE / TFTP servers]]

Video Tutorial: http://www.youtube.com/watch?v=X72WthDGwsw&fmt=18

To add an additional storage node to the network, the computer should be prepared in the same way the main FOG server would be prepared (disable firewall, SELinux, etc). You can also safely mix operating systems for the nodes of you storage group, some nodes can be running fedora, and some can be running Ubuntu. It is important to update your storage nodes when you upgrade to a new version of FOG. Installation of a storage node is done with the same installer for a normal FOG server. Installation can be started by running the installer script, the steps are detailed below.

===== Installing the Node =====

#Run the installation script, ./installfog.sh
#Select your operating system.
#When prompted for Server Installation Mode, select '''S''', for storage node.
#Enter the IP address of the storage node.
#Confirm you interface
#Then you will need to enter the IP address or host name of the node running the FOG database
#Then you will be prompted for a username (typically fogstorage)
#and a password that is located on the FOG server, that will allow the storage node to access the main FOG server's database. This information is located in the FOG management portal for convenience (on the main for server). It can be accessed via '''Other Information''' -> '''FOG settings''' -> section '''FOG Storage Nodes'''.
#You will then be prompted to confirm your installation settings, if they are correct press '''Y''' end hit '''Enter'''.
#When installation completes, the install will produce a username and password that will be needed to add the storage node to the FOG management portal. Username is "fog", password is in /opt/fog/.fogsettings

===== Adding the Node to the Management Portal =====

#Log into the FOG Management Portal
#Navigate to the '''Storage Management''' section.
#Click on '''Add Storage Nodes'''.
#For the '''Storage Node Name''', enter any alpha numeric string to represent the storage node.
#Enter any description you wish
#Enter the IP address of the storage node you are adding. This must be the IP address of the node, DO NOT use a hostname here or the node will not function correctly.
#Enter the maximum number of unicast clients you would like this node to handle at one time. The value that we recommend is 10.
#Is Master Node is a very dangerous settings, but for right now leave it unchecked, for more details please see: [[#Master Node Status]].
#Next, select the storage group you would like this member to be a part of, in our example we will pick '''Default'''
#Next, specify the image location on the storage node, typically '''/images/''', your image location should always end with a '''/'''.
#Next, you will want to check the box, to enable the node.
#The last two fields take the username and password that are generated during the installation of the storage node. username is "fog", password is in /opt/fog/.fogsettings
#Then click '''Add''' to have the node join the storage group.

==== Monitoring The Master Node ====

On all storage nodes there is a new service (as of version 0.24) called FOGImageReplicator which is a very basic script which, if the node is the master, copies all of its images to all other nodes in the storage group. The coping is done every ten minutes by default, which means your images are NOT instantly duplicated to all nodes.

If you would like to view the status of the image replication, you can do so on the storage node by switching to tty3, by typing ctl + alt + f3. Output is also logged to a file in the '''/opt/fog/log''' directory.

==== Master Node Status ====

The '''Master Node''' in a storage group is the node that distributes images files to all other nodes in the storage group. So, if you have all your images distributed across 3 nodes in a storage group, '''if you add a new storage node that has no images stored on it, making that node master will cause it to take over and push it's image store of nothing to all other nodes, wiping out all of your images'''. So it is important to be very careful and backup your images when you change a node's master status.

==== Including multiple PXE / TFTP servers ====

A traditional Master Storage Node, [[#Adding_a_Storage_Node|as described above]] only provides File Storage redundancy. While this can help increase multicast throughput on a single network, all the machines under FOG management must be within the same subnet/VLAN so that DHCP broadcast requests can be directed to the Main server. (see note below)

'''Note:''' depending on the network, it may be possible to configure [http://en.wikipedia.org/wiki/UDP_Helper_Address iphelper] to forward packets to the Main FOG server

The following instructions are intended to help configure additional Storage Nodes to operate independently on separate networks, while still syncing with and taking commands from a single Main FOG server.

Click here for instructions on setting up [[Multiple_TFTP_servers|multiple PXE / TFTP servers]]

=== Users ===

==== Overview ====

FOG has only two levels of users, '''regular''' users and '''mobile''' users. Regular users have access to the mobile portal and the full management portal. Mobile users have access to only the mobile management portal.

==== Creating Accounts ====

All accounts are created under the "Users" section of the FOG portal. To create a new account click on the "New User" button on the left hand side of the page. All accounts must have a unique username, and a password. After filling in the required information click on the "Create User" button.

==== Modifying Users ====

FOG accounts can be modified from within the users section. First you must locate the account you wish to modify by clicking on the "List all Users" button on the left hand side of the page. When a user is located, click on the edit button on the right hand side of the table.

=== Tasks ===

==== Overview ====

Tasks are all the actions that you can take on a computer, and in FOG there a numerous tasks that can be done including:

<ul>
<li>Upload - Unicast</li>
<li>Upload - Unicast (Debug)</li>
<li>Download - Unicast</li>
<li>Download - Unicast (Debug)</li>
<li>Download - Unicast (Without Snapins)</li>
<li>Download - Multicast</li>
<li>Debug</li>
<li>Deploy All Snapins</li>
<li>Deploy Single Snapin</li>
<li>Memory Test</li>
<li>Wake Up</li>
<li>Fast Wipe</li>
<li>Normal Wipe</li>
<li>Full Wipe</li>
<li>Disk Surface Test</li>
<li>File Recovery</li>
<li>Virus Scan</li>
<li>Hardware Inventory</li>
</ul>

In the tasks section of FOG you can perform tasks on single hosts or groups of hosts. This section also allows you to monitor selective tasks, and stop/cancel tasks.

==== General Tasks ====

The general/common Tasks in FOG include unicast image upload, and unicast image send, as well as a multicast image send. In FOG, sending an image to the server is considered an image upload, and deploying an image to the client is called a send. Both of these tasks can be started directly from the search, list all hosts, and list all groups pages.

To perform a simple image upload, click on the upward facing arrow next to the host. Uploads are only possible on a host, not a group. Uploading an image will also overwrite any image file that may already exist for that host without any notification or confirmation.

Please note that uploading images of Windows Vista and Windows 7 requires special command to be run on the clients prior to image upload. Please see [[What do I have to do to an image before uploading?]] for more details.

For a video demonstration of an image upload, please see: http://www.youtube.com/watch?v=jPPZr0abVfg&fmt=18

To perform a simple image send, click on the downward facing arrow next to the host. An image send can be done on a host or a group. When sending an image to multiple computers FOG works in queue mode, which means that it will only send to 10 (by default) computers at one time. This is done to keep the server from being overworked. As soon as the a machine finishes, another from the queue joins.

To perform a multicast image send you must search for a group of hosts on the "Task Management" page. Multicast tasks can only be performed on a group of hosts. Multicast tasks will send to all the computers in the group at once, and the task will not start sending until all members of the group have connected with the server. After starting a multicast task, status can be view by clicking on [ctl]+[alt]+f2. A log is also kept for multicast transfers which is stored at /opt/fog/log.

==== Advanced Tasks ====

The advanced Tasks in FOG include everything that is not a simple upload, simple send or mutlicast send.

=====Debug=====

Debug mode boots the linux image to a bash prompt and allows the user to issue all commands by hand.

=====Upload - Unicast (Debug)=====

Does the same thing that debug mode does, with the exception that the environment is setup to upload the image. To start the imaging process just type:

fog

=====Send - Unicast (Debug)=====

Does the same thing that debug mode does, with the exception that the environment is setup to send the image. To start the imaging process just type:

fog

=====Send - Unicast (Without Snapins)=====

This task does a normal send task with the exception that if any snapins are associated with the host, they are not deployed to the host.

=====Deploy All Snapins=====

This task will send all the snapins associated with a host to the host without imaging it.

=====Deploy Single Snapin=====

This task will send a single snapin that is associated with the host to the host without imaging it. (Note: The snapin must be associated with the host already)

=====Memory Test=====

Boots to Memtest86, a memory testing tool. This a task will not exit with out user intervention at the client side. The task must also be manually stopped via the management front end.

=====Wake Up=====

Wakes up host or group of hosts using Wake-on-Lan.

=====Fast Wipe=====

This task does a quick and dirty wipe of the drive. This task writes zeros to the first ~40MB of the disk. This task should NOT be used if you don't want your data to be recoverable.

=====Normal Wipe=====

This tasks writes random data to the entire surface area of the disk.

=====Full Wipe=====

This tasks writes random data, multiple times to the entire surface of the disk.

=====Disk Surface Test=====

This task will look for bad blocks on the hard disk and report them back to the client console.

=====File Recovery=====

This task will load an application that can be used to recover lost files from the hard disk.

=====Virus Scan=====

This task will update and load ClamAV and scan the partition for viruses. It will either scan and report or scan and quarantine files, it will also report back to the management portal with the results of the scan.

=====Hardware Inventory=====

[http://freeghost.sourceforge.net/videotutorials/InventoryUpdate.swf.html Video Tutorial]

The hardware inventory task will execute the same task as the fog.reginput client side task. Since the host is already registered, all it will do is update the computers inventory and restart. It is visioned that this task could be run on a regular interval on a group of all computers in your network, or some sub group of computers in your network. Then on the next reboot of those computers an inventory would be performed.

==== Scheduling ====

As of version 0.27 of FOG, select tasks can be scheduled using a static date/time combination or using a cron style repetitive task scheduling. Task scheduling can be performed on either single hosts, or on groups of computers. One thing to note about task scheduling that isn't intuitive is that it '''requires an image to be associated with the host, even for non-image based tasks!''' The reason for this is because tasks are only run on the master storage node associated with that host, and the only way to tie a storage node to a host is via an image. We did this to prevent multiple storage nodes to try running the same task for a specific host.

===== Single Execution Scheduling =====

Single task execution will run a task at a single date and time, then the task will be discarded. To scheduled a single execution task, you would go to the tasks section of fog, then select the host or group you would like to schedule the task, then select the task you would like to schedule. You will then be presented with the screen show below.

[[Image:Sched.png]]

To schedule a single execution task, click on white text box below "Schedule Single Task Execution?" and a pop up calendar will load and allow you to select your date and time for the task. Click on the date to close the calendar, then start you task.

===== Cron Style Task Scheduling =====

Cron style task execution allows you to do complex repetitive task scheduling. After a cron task executes, it is not removed, as single executions tasks are. Cron style tasks, as the name suggests are similar to the Linux cron task scheduler format. Cron style tasks are created as single execution tasks are, except when presented with scheduling options, select the option "Schedule Cron Style Task Execution". Below that check box are a series of text boxes including:

min -> Minute
hour -> Hour
dom -> Day of Month
month -> Month
dow -> Day of Week

To give an example of how this works, if you wanted a upload task to run at '''10:00pm everyday''' you would enter the following:

0 22 * * *

This basically says run the task a '''0''' minutes into the hour, on the '''22nd hour (10:00pm)''', on '''every day of the month''', on '''every month of the year''', on '''every day of the week'''.

To take this example further, lets say you only wanted to upload the image '''every other day''', we could do this by adding:

0 22 */2 * *

The '''*/2''' now tells the scheduler to only run on '''even days of the month'''.

We could even ask the scheduler to only do a backup on '''even weekdays''' by adding:

0 22 */2 * 1-5

The 1-5 we just added says only run on days 1 through 5, which relate to Monday - Friday.

Now we will ask the scheduler to only backup in the month of February.

0 22 */2 2 1-5

Another basic example could be if you wanted to run an inventory update on the first of every month you could use:

30 1 1 * *

This task would then run at '''1:30''' on the '''1st of every month'''.

The FOG scheduler doesn't support 100% of the operations that cron supports, below are the operations that are supported:

4 - Listing a static number
4,5,6,7 - Listing a group of numbers
4-7 - ranges of numbers
4-7,10 - ranges and lists
*/5 - * divided by a number
* - Wildcard

For more information on cron please see http://en.wikipedia.org/wiki/Cron

=== Printers ===

==== FOG Version ====

Relates to FOG Version 0.12 or higher.

==== Known Issues ====

Setting of the default printer will only work if the fog tray icon is running.

==== Overview ====

The printers section of FOG allows you to create printer definitions that you can later associate with hosts. The FOG service looks at these associations and during service it will attempt to install any printers listed. This service has three settings which define how the printers are managed, printer management can be set to:

<ul>
<li>No Printer Management</li>
<li>Add Only</li>
<li>Add and Remove</li>
</ul>

All hosts default to '''No Printer Management''' which means that the FOG service does nothing to the hosts printers. '''Add Only''' does as the name implies, and will only add printers to the host machine, it will not remove any existing printers that may be installed. '''Add and Remove''' will take full control of the hosts printing system and only allow for the printers that are specified by the FOG management console to exist on the host.

==== Adding New Printers ====

[http://freeghost.sourceforge.net/videotutorials/printer.swf Video Tutorial]

In order for the printer to be added to the host computer, the printer drivers must be stored in a public area, or included on the host computer. This public area can be a Novell Network share where public has read-only access, a Windows share that is public read-only to everyone, or a Samba share (possibly residing on the FOG server) that is public read-only to everyone. This share must be accessible via a UNC path as the service may attempt to install the printers before drive mapping occurs. In this share the printer drives and .inf file must exist. FOG supports install IP based (Jet-Direct) printers, public access NDS printers, Local printers, windows share based printers, (and we think, but could use a confirmation as it hasn't been tested) AD based printers.

If you wish to see what printers are included with Windows XP, navigate to c:\windows\inf\ntprint.inf. Open this file with a text editor and you will be able to install all the printers listed using the ntprint.inf file.

To create a new printer definition click on the Printer icon on the system menu bar. Then on the left hand menu, click on '''Add New Printer'''. The form you are presented with will require you to enter:

<ul>
<li>'''Printer Model''' - This must match the name in the INF file.</li>
<li>'''Printer Alias''' - This can be anything you wish and it is what the end user will see.</li>
<li>'''Printer Port''' - This is something like '''LPT1:''', or '''IP_1.1.1.2'''.</li>
<li>'''Printer INF File''' - This is the path to the INF file for the printer driver.</li>
<li>'''Printer IP''' - (optional) This is ip address of an IP based printers only, this can take the form of '''1.2.3.4:9100''' or '''1.2.4.5'''. If the port doesn't exist already, it will create one named ''' IP_x.x.x.x''', where x.x.x.x is the ip address. That is what should be entered in the port field.</li>
</ul>

After all the required information is entered, click on the '''Add Printer''' button.

==== Linking Printers to Hosts ====

[http://freeghost.sourceforge.net/videotutorials/printer.swf.html Video Tutorial]

Linking printers to hosts can be done from either the hosts section or the groups section. In the hosts section find the host you would like to add a printer to, click on the edit button associated with that host. In the host menu, click on the '''Printers''' button. First select how you would like the host to be managemed, either '''No Printer Management''', '''Add Only''', or '''Add and Remove'''. Then in the section below, select the printer you would like to install from the drop down list and click on the '''Update''' button.

==== Creating a Samba Based Printer Store on FOG ====

If you do not have a public sever where you can store your printer drivers for the FOG Printer Manager, then it is very easy to set one up on the FOG server using Samba, so all your Windows Clients will be able to connect.

[[Creating a Samba Based Printer Store on FOG]]

=== The FOG Client Service ===

==== Overview ====

The FOG Client Service is a Windows Service that is intended to be installed on the client computers during the image creation process. The FOG service communicates with the FOG server to provide certain service to the client computers including:

*Auto Log Off (0.16)
*Hostname Changes
*Active Directory Integration
*Directory Cleaner (0.16)
*Display Manager (0.16)
*Green FOG (0.16)
*Host registration
*Task Restarting
*Snapin Installation
*User Tracker
*Printer Manager
*User Cleanup (0.16)
*Client Updater
*User Tracker

==== Module specific configuration settings ====

The FOG Client Service is very modular in nature, which means you can install portions of the services provided, and leave off others. This also means that it is very easy to create new sub services if you know a little C#. All configuration data is held in a local INI file. Which is typically stored in

c:\program files\fog\etc\config.ini

This file holds, in the general section:

<ul>
<li>FOG Server IP address</li>
<li>FOG Service installation root</li>
<li>FOG Service working directory</li>
<li>FOG Log file path</li>
<li>Flag indicating if GUI messages should be displayed</li>
<li>The max log file size</li>
</ul>

==== Installation ====

[http://freeghost.sourceforge.net/videotutorials/FogServiceInstall.swf.html Video Tutorial]

The FOG service should be installed on the computer to be imaged before uploading the image to the FOG Server.

The FOG service is located in the '''FOG Service/bin''' directory or if the FOG server is already installed it can be downloaded from:

http://[serverip]/fog/client/

Double-click on the '''setup.exe''' to start the installation wizard. At the end of the wizard you will need to enter the IP address or hostname of your FOG server.

[[Image:fogservice.jpg]]

Then restart the computer, if you don't restart the computer you will have issues with the service GUI appearing correctly.

===== Quiet Installation =====

As of version 0.29 and higher, the FOG client now supports a quiet installation mode. This can help automate deployments, by allowing the command to be run without user interaction from batch files. To do this the setup.exe file must be run from the command line with the arguments '''fog-defaults=true /qb'''.

So the full command would be:

setup.exe fog-defaults=true /qb

==== Functions and Operation ====

=====Auto Log Out=====

Added in Version 0.16

This module of the FOG Service will log a user off of a client pc after X minutes of inactivity. This module will display a screen saver-like GUI after 3/4 of the inactive time is up. So if the time out value is 40 minutes, the GUI will be displayed at 30 minutes of inactivity. When the time is up, the client computer will reboot. This service module can be configured via the management portal via:

FOG Service Configuration -> Auto Log Out

To enable the module globally, place a check in the box next to '''Auto Log Out Enabled?'''. The time to auto log off can changed globally via '''Default log out time:''' The minimum recommended value for this setting is 4 minutes.

The background image for the auto log off module can be modified via:

Other Information -> FOG Settings

The settings can be changed by modifying the value for '''FOG_SERVICE_AUTOLOGOFF_BGIMAGE'''. This settings will accept a jpg file that is local to the client computer like:

c:\images\image.jpg

This setting will also accept files located on a web server such as:

http://www.somedomain.com/image.jpg

Provided with FOG is a simple php script that will display a random images that is located on the FOG server. To use this option set '''FOG_SERVICE_AUTOLOGOFF_BGIMAGE''' to

http://x.x.x.x/fog/public/randomimage.php

Then simply put the images you would like to use in the following directory on the fog server:

/var/www/html/fog/public/imagepool

Images used for the auto log off module must be in jpg format, and must be 300px by 300px.

=====Hostname Changer=====

This module of the FOG Service is used to change the hostname of the client computer and to allow the client to (optionally) join a Active Directory Domain after imaging. This process only runs shortly after service startup, which means typically only when you start your computer. The service communicates with the FOG server over port 80 and determines the hostname that is present in the FOG database for the host. The hosts are matched to the FOG database by their MAC addresses. If the hostnames are found to be different, the client changes the computers hostname and restart the computer.

The config.ini file contains configuration options for this module.

netdompath=

Allows you to set the path to the netdom.exe file. In some cases the file does not exist on the system. It can be downloaded from: [http://www.microsoft.com/downloads/details.aspx?FamilyId=49AE8576-9BB9-4126-9761-BA8011FABF38&displaylang=de Microsoft Download Center]

=====Host Register=====

As of version 0.29, this module will only add additional mac address to a host that is already registered, and add them to the pending mac address table, where they need to be approved in the FOG UI.

=====Task Reboot=====

This module periodically checks in with the FOG server to see if the client has an imaging task assigned to it. If a task is found AND no one is logged into the workstation, then the client will restart and join the task.

The config.ini file contains configuration options for this module. As of version 0.13 of FOG you can change:

forcerestart=0

to

forcerestart=1

This will make the computer restart if a task is found, regardless of whether a user is logged into the computer.

You can change how often the service will check in with the server by changing:

checkintime=xxx

where xxx is the number of seconds the service will wait between check-ins.

=====Directory Cleaner=====

Added in version 0.16

This module will clean out (delete) the contents of a directory on user log off. This useful when you don't want any settings cached between users. This module will only delete the contents of a directory and not the root directory itself, so if you specify '''c:\trash''', the service will remove all files and folders located within c:\trash but leave the folder c:\trash.

=====Display Manager=====

Added in version 0.16

This module is used to restore screen resolution between clients. This will restore a fixed resolution and refresh rate when a user logs into a computer.

=====Green FOG=====

Added in version 0.16

This module will simply shutdown/restart the client computer at a fixed schedule if no user is logged in. The schedule can be defined via the management portal.

=====Snapin Client=====

This module periodically checks in with the FOG server to see is the client has an snapin set to be deployed to it. If a snapin is found AND no imaging task is associated with the client, then the client will download the snapin and install it in the background.

The configuration file contains settings for this module including:

checkintime=xxx

where xxx is the number of seconds the service will wait between check-ins. It is important to note that currently the fog client will wait 5 minutes when first connected / established before it starts checking and installing any snapins from the server.

=====User Tracker=====

This module attempts to track user access to the host computer by the Windows user name. It attempts to track logins and logoffs as well as well as the state of the computer at service startup. The service will even attempt to track users when they are not on the network by writing all entries to a journal file, then replying the journal the next time the client is on the network.

There are no configuration settings for this module.

=====User Cleanup=====

This module will remove all users not white listed in management portal on log off. This module is useful when using services like dynamic local user. All entries in the management white list are treated as prefixes to usernames, which means that they will white list all users that start with whatever was entered in the management front end. For example, if you enter '''admin''' in the management white list, then users '''admin''', and '''administrator''' will NOT be removed from the computer.

=====Printer Manager=====

This module checks on service startup to see what printers should be installed/removed from the client PC.

There are no configuration settings for this module.

=====Client Updater=====

This module waits (randomly) between 60 and 500 seconds after service startup to check the local fog server for client updates, and if any are found the service will download and install them. Updates will NOT take effect until after the service is restarted.

There are no configuration settings for this module.

==== Keeping Clients up to date ====

===== Overview =====

As of version 0.12 of FOG, we have included a client updater module. This module is no different from any of the other sub service modules. This service waits anywhere between 60 and 500 seconds after the FOG service starts up, and then attempts to check with the server for newer FOG service modules. If new modules are found the client will download them, and they will be active on the NEXT service startup. These modules are controlled from the FOG Management Console.

Only certain modules can be updated, only those that are a sub class of AbstractFOGService. This means you should '''NEVER''' attempt to update the FOGService executable (FOGService.exe file), or the AbstractFOGService.dll file. It is recommended that you not update the ClientUpdater.dll, because if the ClientUpdater.dll file becomes corrupt or not functional, your clients will not be able to update from that point on. Below are a list of the .dll files that can be updated.

<ul>
<li>UserTracker.dll</li>
<li>TaskReboot.dll</li>
<li>SnapinClient.dll</li>
<li>PrinterManager.dll</li>
<li>HostRegister.dll</li>
<li>HostnameChange.dll</li>
<li>GUIWatcher.dll</li>
<li>ClientUpdater.dll</li>
<li>config.ini</li>
</ul>

Care must also be taken when updating the config.ini file, if the IP address is incorrect or the syntax of the file is incorrect, it could leave the FOG service crippled on the client computers.

===== Posting Updates =====

To add new modules that can be pushed down to clients, first install a client with the new service or new module and confirm that it works as you would like. Log into the FOG management console, then go to the Infomation/Misc section (the little "i" icon). Click on '''Client Updater''' on the left-hand menu. Now click on the browse button to select the module (.dll) file you would like to post, then click on the upload button. After uploading the file should appear in the table above. If you are adding a new module, you will probably want to upload a new config.ini file to include new configuration settings required by that new module.

==== FOG Tray ====

The FOG Tray is a Windows application that runs on user login that docks in the system tray. The FOG Tray, like the FOG service, is very modular in nature. New modules can be dropped in the FOG tray directory and on next load they will be loaded. This tray icon has the ability to communicate with the FOG service, this allows FOG more interactivity with the end-user.

What happens is that when the FOG service's printer manager module gets a request to set a default printer, the service attempts to contact the FOG Tray. If communication is established, then the service will ask the tray to set the default printer. On the other hand the end user can right click on the "F" icon in the system tray, then select printers, then update my printers. What this will do is attempt to send a request from the FOG Tray to the FOG Service and have the service check for printer updates (new printers or printers to be removed). If one is found the service will install any new printers assigned in the FOG Management portal.

This application is in its very early stages and currently doesn't have a lot of functionality. It is currently only used to allow end users to update their printers and to allow the setting of default printers (from the FOG service). Our vision for the FOG Tray is to add modules that would allow users to install printers that are published as public (via the management portal) without the printer being directly assigned to their host. We would also like to do the same thing for snapins where some of your snapins could be defined as public where anyone could install them on their computer.

==== Troubleshooting ====

If you have problems with the FOG Service, please refer to the log file that is located at:

c:\fog.log

If the PXE boot does not work

If booting from the fog server through pxe comes up with an error file not found, edit /etc/default/tftpd-hpa

Change TFTP_DIRECTORY to

TFTP_DIRECTORY="/tftpboot"
Then

/etc/init.d/tftpd-hpa restart

=== Snap-ins ===

==== Overview ====

The FOG Service has the ability to install snapins to the clients. Snapins can be anything from whole applications like Microsoft Office to registry keys or desktop icons. Snapins can even be used to uninstall applications or remove unwanted files. For the end use's point of view, they will not even noticed that a snapin is being installed until it is complete. At this point a message will notify them that a new application has been installed on their computer. Snapins can be in MSI (0.17) or EXE formats, and can be created with any snapin creation tool like InstallRite or already packaged MSI files (0.17). You can also push commands to the computer that include .vbs scripts / .cmd (commands) and .bat (batch scripts).

==== Creating a Snapin / Overview ====

FOG doesn't provide a tool to create snapins, but instead allows you to push files and execute them on the remote computers. It is highly recommended that you push the actual installer to the computer instead of using a program such as InstallRite.

If you have never silently installed software to a computer, or created an answer file for a program please look at the website Appdeploy [http://www.appdeploy.com/articles/ Link] This website has an trove of information on how to push software to a computer remotely.

===== Creating a Snapin for larger applications with SFX Maker =====

Some larger applications such as Microsoft Office and Adobe Products (Acrobat / Creative Suite) require multiple files to install properly. If you have an application that is not a single .exe please use SFX Maker. This tool is free for non commercial use, and most programs fall under the GPL. [http://www.isoft-online.com/ SFX Maker's Website]

For instructions on how to use this software please see the youtube videos below.

[http://www.youtube.com/watch?v=ZSMJLnRjn94 Office 2003 Install]
[http://www.youtube.com/watch?v=Qzc1Q9NW_cE Office 2007 Install]

SFX Maker takes an entire folder and encapsulates it or "folds" it into a single .exe which then "unfolds" to its original state and launches a file or command.

===== Creating a Snapin with InstallRite =====

If for some reason you do wish to use Installrite please be aware it comes with issues and limitations (not compatible on all windows operating systems / can cause issues with the computer it is pushed to). Below is an example of how to build a package with that software

In this example we will use Epsilon Squared's InstallRite which can be downloaded from http://www.epsilonsquared.com/installrite.htm. This application will package up your snapin as an exe file which will be uploaded to the FOG server.

<ol>
<li>To run InstallRite navigate to c:\program files\Epsilon Squared\InstallRite\InstallRite.exe</li>
<li>Click on "Install new software and create an InstallKit"</li>
<li>On the Configure screen, click Next.</li>
<li>On the Snapshot screen click next to create a new system snapshot.</li>
<li>On the next screen,click the browse button to select the application you wish to install, then click next.</li>
<li>When installation is complete InstallRite will come into focus, click the next button. InstallRite will scan your system again.</li>
<li>Enter a name for your snapin.</li>
<li>Click "Build Install Kit"</li>
<li>Select "Quiet Installation Mode", Never reboot, even if needed, and "Never prompt the user and only overwrite older files"</li>
<li>Click OK and it will build your snapin.</li>
</ol>

==== Preparing the FOG Server ====

If your snapin is larger than 2MB you will need to make two changes to the FOG server to allow uploads of larger than 2MB.

===== Fedora =====

#On the FOG Server click on Applications -> Accessories -> Text Editor.
#Select Open and navigate to "/etc/php.ini"
#Change UPLOAD_MAX_FILESIZE to 1900MB (On a 32Bit OS don't set this value above 2GB)
#Change POST_MAX_SIZE to the same value.
#Save and close the text editor.
#Click on Applications ->System Tools -> Terminal and type "service httpd restart"

===== Ubuntu =====

#sudo gedit /etc/php5/apache2/php.ini
#Change
##memory_limit = 1900M
##post_max_size=1900M
##upload_max_filesize=1900M
#Save Changes
#sudo /etc/init.d/apache2 restart

===== VMWare =====

#sudo vim /etc/php5/apache2/php.ini
#Edit the following lines in the document (read below for assistance with working in VIM)
##memory_limit = 1900M
##post_max_size=1900M
##upload_max_filesize=1900M

*To edit content in vim you will need to press the '''"I"''' key on your keyboard to enter input mode.
*Hitting the '''Escape''' key will bring you out of input mode.
*Once out of input mode type ''':w''' and then '''enter''' to save the file
*Restart FOG once the file has been saved

==== Uploading the Snapin ====

[http://freeghost.sourceforge.net/videotutorials/CreateSnapin.swf.html Video Tutorial]

<ol>
<li>In the FOG Management Portal click on the Snapin Icon (Puzzle Pieces).</li>
<li>On the left-hand menu click on the New Snapin Button.</li>
<li>Enter a Snapin Name and Description.</li>
<li>Browse to the snapin file you wish to upload.</li>
<li>If you want the computer to restart after the snapin is installed click on the "Reboot after install"</li>
<li>Click "Add"</li>
</ol>

As of version 0.17, fog supports using typical msi files as snapin files.

If the snapin file is a msi file you must perform these additional steps:

<ol>
<li>Set '''Snapin Run With:''' to the path of msiexec.exe (ie: c:\windows\system32\msiexec.exe)</li>
<li>Set '''Snapin Run With Arguments:''' to '''/i'''</li>
<li>Set '''Snapin Arguments:''' to '''/qn'''</li>
</ol>

If the snapin file is a .vb script you must perform these additional steps:

<ol>
<li>Set '''Snapin Run With:''' to the path of cscript.exe (ie: c:\windows\system32\cscript.exe)</li>
</ol>

'''Documentation on list of support snapin's and command line arguments''' [[http://www.fogproject.org/wiki/index.php?title=Supported_Snapin%27s_and_Command_Line_Switches]] There are MANY more supported applications that can be installed via command line arguments. You might have better luck installing them directly via .EXE / .MSI / or scripting them via .VBS . For more info on this consult the forums --[[User:Ssx4life|Ssx4life]] 09:04, 8 October 2009 (MST)

==== Linking the Snapin to Hosts ====

In order for a snapin to be deployed it must be linked with a host. To do this perform the following:

<ol>
<li>In the FOG Management Portal, click on the Hosts Icon.</li>
<li>Search for and select a host and click on the edit button.</li>
<li>Scroll down to the snapin section.</li>
<li>Select the snapin you just created from the drop-down box and click the "Add Snapin" button.</li>
</ol>

The next time you image the computer the FOG Service will attempt to install that snapin. If you have problems, please see the fog log file located at c:\fog.log on the client PC.

=== Client Side Tasks ===

==== FOG Version ====

Applies to version 0.12 or higher.

==== Overview ====

FOG attempts to keep management centralized, but in an attempt to make deploying machines as easy as possible FOG has added a few basic client side tasks. These tasks can be run from the client computer during the PXE boot process. When the client boots and the FOG banner is displayed the pxe client will display a prompt like '''boot:''' or something similar. At this point you have 3 seconds to start typing one of the following commands.

<ul>
<li>fog.memtest</li>
<li>fog.reg</li>
<li>fog.reginput</li>
</ul>

==== fog.memtest ====

This command will run the memtest86+ on the client computer.

==== fog.reg ====

This command will run the basic host registration and inventory process without any user input. It will register any new/unregistered hosts with the FOG server and pull a basic hardware inventory from them. The hostname of the computer will be the same as the MAC address without the ":".

If a host is already registered, then only an inventory will be performed.

==== fog.reginput ====

[http://freeghost.sourceforge.net/videotutorials/RegImage.swf.html View Host Registration Video]

This command will run the full host registration process with user input, inventory and give the option to push down an image, all at the same time. During this process the user registering the host will be prompted for the computer host name, ip address, operating system ID, image ID, Primary User of the computer, asset tag 1, and asset tag 2.

If a valid hostname, os id, and image id are given and the option is selected to image the workstation after registration, the host will reboot and an imaging send will began.

If a host is already registered, then only an inventory will be performed, this prevents end-users from re-registering a machine with a different hostname, etc.

This tasks was designed for institutions that may get shipments of hundreds of computers that need to be deployed very quickly. They can be unboxed, inventoried, imported into FOG and imaged very quickly.

===== Operating System ID =====

As of Version 0.17 of fog, you can now enter '''?''' at the Operating System ID prompt to get a listing of the valid operating system id values.

The following are valid values for operating system IDs:

<ul>
<li>1 - Windows 2000 / Windows XP</li>
<li>2 - Windows Vista</li>
<li>3 - Windows 98</li>
<li>4 - Windows (Other)</li>
<li>5 - Windows 7</li>
<li>50 - Linux</li>
<li>99 - Other</li>
</ul>

===== Image ID =====

Image IDs can be found in the management console, in the Images section. Search for the image, and click on the edit button associated with the image,
the image id will be in the Address/url bar in the format of &imageid=xx.

As of version 0.17, you can enter '''?''' at the Image ID prompt to get a listing of all your images and their ID numbers.

=== Active Directory Integration ===

==== Setup ====

===== Overview =====

FOG has the ability to register a host with Active Directory, in a limited sense. Versions of FOG up to and including 0.28 rely on the netdom.exe executable that is provided as part the support tools on the Windows installation media. In order for Active Directory integration to function, your image will need to have the FOG service installed, along with the Windows Support Tools.

Versions of FOG from (and including) 0.29 have this functionality built in and do NOT require netdom.exe or the support tools to be installed.

It is also very important that before uploading your image that the computer is NOT a member of any domain.

===== Security =====

'''Important - Please read!'''

In order to add a computer to a domain, FOG requires a username and password of an account that has rights to the OU where the computer objects are stored in the domain tree. This user account should have rights to join computers to the Domain, as well as sufficient rights to create/manage computer objects. FOG attempts to keep your password secure by encrypting it, but since FOG is open source, it is possible for someone to decrypt your password if you don't change the FOG "Passkey." It is highly recommended that you change this Passkey before implementing the AD integration in a production environment. Changing the Passkey requires you to recompile the FOG Service's Hostname change module, but don't panic this isn't hard and only need to be done one time. Please see the documentation below.

===== Preparing the Image =====

Before uploading an image to FOG that you would like to use with Active Directory, please ensure that the image:

<ul>
<li>is NOT a member of the domain, change the computer membership to workgroup instead.</li>
<li>has support tools installed (Not required for FOG versions from 0.29).</li>
<li>has the FOG service installed.</li>
</ul>

===== FOG Setup =====

To setup a host to use AD, navigate to the hosts section of the FOG management portal.

<ol>
<li>Search for, and select a host. </li>
<li>Click on the Edit button</li>
<li>Scroll down to the Active Directory section.</li>
<li>Check the box next to Join Domain after image task</li>
<li>Enter the (fully qualified) domain name e.g. mydomain.com</li>
<li>Enter the Organizational Unit where you would like to have the computer stored in AD. Leave if blank for the default. (Must be in LDAP format).</li>
<li>Enter the user name that has access to the computer objects. Include the name of your domain, i.e. mydomain\username</li>
<li>Enter the encrypted password. This password must be encrypted with the [[FOGCrypt]] utility. This utility is located in the FOGCrypt folder of the FOG download package. It is a Windows command line application. </li>
<li>Click Update.</li>
</ol>

The next time you image that computer the service will attempt to register the host with the domain information provided. If you have problems please refer to the FOG Service log file located in c:\fog.log

===== Making AD Integration Easier =====

As of version 0.20 of FOG, we have made it a bit easier to manage AD settings in FOG, by allowing for default settings for AD. This will allow the easy population of the domain, OU, username, and password. To set this feature up perform the following:

# Go to '''Other Information''' -> '''FOG Settings'''
# Set your default values for the following:
## FOG_AD_DEFAULT_DOMAINNAME
## FOG_AD_DEFAULT_OU
## FOG_AD_DEFAULT_USER
## FOG_AD_DEFAULT_PASSWORD (MUST BE ENCRYPTED!)

To test everything out, go to a host that doesn't have anything setup for AD, and click on the edit button for that host. Go to the host menu, and select Active Directory. Click on the '''Join Domain after image task:''' button and all your default values should be populated.

==== Securing Active Directory Integration ====

===== Overview =====

In order to add a computer to a domain, FOG requires a username and password that has rights to the OU where the computer objects are stored in the domain tree. FOG attempts to keep your password secure by encrypting it, but since FOG is open source and the methods used to encrypt the password are open for all to see, it is possible for someone to decrypt your password if you don't change the FOG "Passkey." It is highly recommended that you change this Passkey before implementing the AD integration in a production environment. Changing the Passkey requires you to recompile the FOG Service's Hostname change module, but don't panic this isn't hard and it only needs to be done one time.

===== The Development Environment =====

The hostname change module is written in c#, so in order to recompile it you will need to download Microsoft's Visual Studio Express Edition for C#. This can be downloaded from:

http://www.microsoft.com/express/vcsharp/

Install Visual Studio with the standard options.

===== Getting the Source =====

After Visual Studio Express is installed now we need to get the source code for the hostname change module. This is part of FOG download/installation package. This package can be downloaded from:

http://sourceforge.net/project/showfiles.php?group_id=201099

Extract this package, then navigate to "FOG Service\src\FOG_HostNameChanger\"

Double-click on HostNameChange.sln to open the project.

If you are asked to convert the project to the latest version, click the Finish button.

If you are using Visual Studion 2010, you need to change the target .NET framework to .NET 2.0. Do this by going to Project > hostnamechanger properties. On the Application tab, change the Target Framework to .NET 2.0

Once the project has opened, on the right-hand panel, in the "Solution Explorer", double-click on MOD_HostNameChanger.cs.

After do so, you should get the source code to display in the main panel, scroll down to the line:

private const String PASSKEY = "FOG-OpenSource-Imaging";

Change '''FOG-OpenSource-Imaging''' to anything you like, just remember what you change it to, as you will need it later.

Then click File -> Save All.

Then click Build -> Build Solution.

This will recompile the hostname change module with your unique key.

Now navigate to "FOG Service\src\FOG_HostNameChanger\bin\Release"

Copy only the file HostnameChange.dll to "FOG Service\src\FOG Service\bin\Release" (overwrite existing file).

Navigate to "FOG Service\src\FOG Service\"

Open the solution by double-clicking "FogService.sln"

If you are asked to convert the project to the latest version, click the Finish button.

If you are using Visual Studion 2010, you need to change the target .NET framework to .NET 2.0. Do this by going to Project > FOGService properties. On the Application tab, change the Target Framework to .NET 2.0

Change the build configuration from debug to release

Right click on "FOG Service Install" and click "Build"

Navigate to "FOG Service\src\FOG Service Installer\Release"

Select the 2 files, right-click -> Send To -> Compressed Folder

Copy the .zip file to your FOG Server "/var/www/html/fog/client". Overwrite the existing file.

===== Encrypting Your Password =====

Now that we have changed the passkey, we need you update the FOGCrypt ini file to use this new passkey.

Navigate to the FOGCrypt\etc directory from the FOG download package.

Open the config.ini file and change the passkey value to your new passkey, then save the file.

Now open a command window and navigate using the cd command to the FOGCrypt directory.

Type:

FOGCrypt [password]

Where [password] is the AD user's password that has rights to the Computers section of the AD tree.

The output from this command is what you will enter in the FOG management portal.

=== FOG Reports ===

==== FOG Version ====

Relates to FOG Version 0.12 or higher.

==== Overview ====

FOG Reports allow you to export data from FOG in two major formats including CSV, and PDF.

#'''Snapin Log''' - This report will report on snapin installation history.
#'''Imaging Log''' - This report will report on images deployed to hosts.
#'''Virus History''' - This report lists any viruses that were found on locate computers.
#'''Inventory''' - This report will report on the inventory information collect for network clients.
#'''Equipment Loan''' - This report can be used for equipment loaned to staff members.
#'''User Login History''' - This report contains information about user logins.

==== Running Reports ====

Running a report can be done from the Reports section of FOG, then by picking a report from the left-hand menu.

==== Importing User Created Reports ====

The reporting section of FOG allows for the end user to create and upload custom reports into FOG. A FOG report is a simple php script that is processed by the server. To import a report simply click on the '''Upload a Report''' button in the reports section, select the report then click on the upload button. The report will then show up on the left-hand menu.

Please be cautious when uploading reports from an unknown source as the writer of the report has full access to the FOG system and database! Make sure your sources are trustworthy before importing a report!

==== Creating Custom Report ====

Custom reports are simple php scripts in FOG. Custom reports can be created based on the following template:

[http://freeghost.sf.net/other/ReportTemplate.tar.gz Report Template]

=== Other Settings ===

==== [[Boot Image Key Map]] ====

==== FOG Client Kernel ====

===== Overview =====

In FOG, there aren't really drivers you need to find and download for your clients to work, this is because we ship a Linux kernel that has the majority of hardware device built into it. What this means is if you have a device that doesn't work with FOG you need to either build a new kernel yourself or try a newer kernel that has been released via our kernel updater.

===== Kernel Types =====

We currently build two "lines" of kernels, one called KS or KitchenSink. This kernel tries to include drivers for as many devices as possible, sometimes as the cost of performance, and this is the kernel that we ship with FOG by default. The other "line" is the PS kernel or the Peter Sykes kernel, which is a based on a config submitted by a user. This kernel line tries to be faster, but may not include as many drivers as the KS kernel.

===== Updating the Kernel =====

It is possible to update your client kernel from within the UI of FOG. To do this perform the following steps:

#Log into the FOG Management UI.
#Go to '''Other Information'''
#Select '''Kernel Updates'''
#Select the Kernel you would like to download, typically the newest kernels are on the top of the list.
#Click the download icon
#Select a file name for your kernel, to make it the default kernel leave the name as '''bzImage'''
#Click the '''Next''' Button

=== Mobile Management Interface ===

==== Overview ====

The FOG Mobile web interface is a very basic, stripped down interface for FOG. It is designed to be given to lower level technicians using low powered, mobile devices such as iPod touches, iPhone, PDAs, and internet tablets. The idea behind this interface is to make it easy for techs to re-image a computer while making the rounds at a site.

==== Using the mobile Interface ====

The mobile interface can be access via:

http://x.x.x.x/fog/mobile

The portal requires a valid user name in password, which can be created via the FOG portal.

[[Image:Ipod login.JPG]]

Once logged into the portal, users can search for hosts and image them, and view/cancel active tasks.

[[Image:Ipod results.JPG]]

[[Image:Ipod active.JPG]]

They can not change image associations, nor modify any properties of a host.

Using FOG with an unmodifiable DHCP server/ Using FOG with no DHCP server

2012-06-13T22:01:05Z

Chad-bisd: /* Additional Info */ added device to list

=Overview=
This combines FOG with a proxyDHCP server. What a proxyDHCP service does is listen to DHCP requests and respond to clients identifying themselves as PXE Clients. It leaves the role of assigning IP addresses to the other DHCP servers, but provides the necessary information so the client can PXE boot. ProxyDHCP is a solution for those of you who are working with an unmodifiable DHCP server or wish to avoid the hassle of editing the already existing DHCP server, or even as a portable imaging solution.

=How ProxyDHCP works=
<ol><li>When a PXE client boots up, it sends a DHCP Discover broadcast on the network, which includes a list of information the client would like from the DHCP server, and some information identifying itself as a PXE capable device.</li>
<li>A regular DHCP server responds with a DHCP Offer, which contains possible values for network settings requested by the client.Usually a possible IP address, subnet mask, router (gateway) address, dns domain name, etc.</li>
<li>Because the client identified itself as a PXEClient, the proxyDHCP server also responds with a DHCP Offer with additional information, but not IP address info. It leaves the IP address assigning to the regular DHCP server. The proxyDHCP server provides the next-server-name and boot file name values, which is used by the client during the upcoming TFTP transaction.</li>
<li>The PXE Client responds to the DHCP Offer with a DHCP Request, where it officially requests the IP configuration information from the regular DHCP server.</li>
<li>The regular DHCP server responds back with an ACK (acknowledgement), letting the client know it can use the IP configuration information it requested.</li>
<li>The client now has its IP configuration information, TFTP Server name, and boot file name and it initiate a TFTP transaction to download the boot file.</li>
</ol>

=Environment=
Tested working with:
{| class="wikitable"
|-
! OS Version
! FOG Version
|-
| Ubuntu 10.04 LTS x64
| Fog 0.29
|-
| Ubuntu 10.04 LTS x32
| Fog 0.32
|}

* dnsmasq
* LTSP Server, further documentation at [https://help.ubuntu.com/community/UbuntuLTSP/ProxyDHCP Ubuntu LTSP/ProxyDHCP].

=Setup and Configuration=
<ol>
<li>First get your desired linux flavor installed</li>

<li>Install FOG (use instructions on wiki user manual)</li>

<li>Make sure you do a normal server installation, don't setup a DHCP router address or a DNS server address, also don't use FOG as a DHCP server.</li>

<li>If you set a MySQL password make sure you change it in /var/www/fog/commons/config.php and also in /opt/fog/service/etc/config.php</li>

<li>Edit /etc/exports to look like this:

<pre>
/images *(ro,async,no_wdelay,insecure_locks,no_root_squash,insecure)
/images/dev *(rw,async,no_wdelay,no_root_squash,insecure)
</pre></li>

<li>Install dnsmasq using: <pre>sudo apt-get install dnsmasq</pre></li>

<li>Create /etc/dnsmasq.d/ltsp.conf using the following settings, modify as needed:
<pre>
# Sample configuration for dnsmasq to function as a proxyDHCP server,
# enabling LTSP clients to boot when an external, unmodifiable DHCP
# server is present.
# The main dnsmasq configuration is in /etc/dnsmasq.conf;
# the contents of this script are added to the main configuration.
# You may modify the file to suit your needs.

# Don't function as a DNS server:
port=0

# Log lots of extra information about DHCP transactions.
log-dhcp

# Dnsmasq can also function as a TFTP server. You may uninstall
# tftpd-hpa if you like, and uncomment the next line:
# enable-tftp

# Set the root directory for files available via FTP.
tftp-root=/tftpboot

# The boot filename.
dhcp-boot=pxelinux.0

# rootpath option, for NFS
dhcp-option=17,/images

# kill multicast
dhcp-option=vendor:PXEClient,6,2b

# Disable re-use of the DHCP servername and filename fields as extra
# option space. That's to avoid confusing some old or broken DHCP clients.
dhcp-no-override

# PXE menu. The first part is the text displayed to the user. The second is the timeout, in seconds.
pxe-prompt="Press F8 for boot menu", 3

# The known types are x86PC, PC98, IA64_EFI, Alpha, Arc_x86,
# Intel_Lean_Client, IA32_EFI, BC_EFI, Xscale_EFI and X86-64_EFI
# This option is first and will be the default if there is no input from the user.
pxe-service=X86PC, "Boot from network", pxelinux

# A boot service type of 0 is special, and will abort the
# net boot procedure and continue booting from local media.
pxe-service=X86PC, "Boot from local hard disk", 0

# If an integer boot service type, rather than a basename is given, then the
# PXE client will search for a suitable boot service for that type on the
# network. This search may be done by multicast or broadcast, or direct to a
# server if its IP address is provided.
# pxe-service=x86PC, "Install windows from RIS server", 1

# This range(s) is for the public interface, where dnsmasq functions
# as a proxy DHCP server providing boot information but no IP leases.
# Any ip in the subnet will do, so you may just put your server NIC ip here.
# Since dnsmasq is not providing true DHCP services, you do not want it
# handing out IP addresses. Just put your servers IP address for the interface
# that is connected to the network on which the FOG clients exist.
# If this setting is incorrect, the dnsmasq may not start, rendering
# your proxyDHCP ineffective.
dhcp-range=192.168.1.10,proxy

# This range(s) is for the private network on 2-NIC servers,
# where dnsmasq functions as a normal DHCP server, providing IP leases.
# dhcp-range=192.168.0.20,192.168.0.250,8h

# For static client IPs, and only for the private subnets,
# you may put entries like this:
# dhcp-host=00:20:e0:3b:13:af,10.160.31.111,client111,infinite</pre></li>

<li>Restart dnsmasq with <pre>sudo dnsmasq restart</pre></li></ol>

'''Note:''' After getting everything working, you can change the timeout to 0 on the line: <pre>pxe-prompt="Press F8 for boot menu", 3</pre>

=Serving ProxyDHCP to multiple subnets=
If you are serving ProxyDHCP to multiple subnets some changes must be made to your switches/routers and your server config.

<ol>
<li>Modify your /etc/dnsmasq.d/ltsp.conf file by adding the subnet mask option to line: <pre>dhcp-range=192.168.1.10,proxy</pre> to make it <pre>dhcp-range=192.168.1.10,proxy,255.255.0.0</pre> which will serve all 192.168.x.x subnets. If you are using 10.x.x.x addressing, use subnet mask "255.0.0.0" (8-bit) and if you are using 172.16.x.x, use subnet mask "255.240.0.0" (12 bit). Basically set the subnet mask so that all subnets on which ProxyDHCP should answer are covered.

If you don't do this, the ProxyDHCP server will not respond to DHCP requests for hosts outside of it's own subnet.</li>
<li>Add an IP Helper/DHCP Relay record to your router or switch so the DHCP broadcasts are sent to your normal DHCP server AND the Fog server.</li>
</ol>

=References=
I gathered a lot of my ideas from peoples' questions on the FOG forums and the Ubuntu documentation on the [https://help.ubuntu.com/community/UbuntuLTSP/ProxyDHCP LTSP proxyDHCP] server, so thanks to them.

=Additional Info=
A ProxyDHCP server can also help deal with PXE Clients that do not work with seperate DHCP and TFTP servers using option 66 &67 (Windows), or next-server and filename (Linux). This can resolve situations where the clients are getting the tftp server IP address and filename, but are having issues with the TFTP Transaction, such as: PXE-T01: File not found, and other errors.

This has successfully resolved issues with:
{| class="wikitable"
|-
! Device !! NIC
|-
| Acer Iconia Tab w500p || Asix AX88772B USB to Fast Ethernet adapter
|-
|Compal JHL91 || Realtek RTL8139
|}

[[Category:Customization]][[Category:Dhcp]][[Category:Pxe]]

Setting up ProxyDHCP

2011-11-04T02:30:52Z

Chad-bisd: Redirected page to Using FOG with an unmodifiable DHCP server/ Using FOG with no DHCP server

#REDIRECT [[Using FOG with an unmodifiable DHCP server/ Using FOG with no DHCP server]]

Category:Ufr

2011-10-28T15:39:29Z

Chad-bisd: added another note for admins to remove call to the Db-spammer template after they block/review a user.

=Users for Review=

This is a hidden category which may contain a list of users who should be reviewed by the admins and blocked, possibly indefinitely, due to spamming.

'''ADMINISTRATORS''': Please do not delete this category if empty. An empty category means all users identified as potential spammers have been blocked.

'''ADMINISTRATORS''': After review, please remove the call to the <nowiki>{{Db-spammer}}</nowiki> template from the user page. If a blocked user is still showing up here, please edit their user page to remove the call to the <nowiki>{{Db-spammer}}</nowiki> template.

__HIDDENCAT__

Template:Db-spammer

2011-10-28T15:20:18Z

Chad-bisd: bolded another note to administrators and asked them to remove the tag once they have review/blocked the user.

<div style="border:2px solid black;color:#ff0000;background-color:#ffffff;font-weight:bold;">
This user appears to be a spammer/bot. All [[Special:Contributions/{{PAGENAME}}|contribs]] by this [[User:{{PAGENAME}}|user]] should be reviewed. '''ADMINISTRATORS''', please consider blocking this user indefinitely.

Remove this tag when the user is either blocked, or identified as a legitimate editor.

</div>

<noinclude>
'''ADMINISTRATORS''': Please do not delete this template. It is an effort to help easily identify spammers and make them for review/deletion without having to constantly scan recent changes.

Usage: Replace the contents with, or add this to the top of the user page for suspected spammer or spambot.

<nowiki>{{Db-spammer}}</nowiki>

</noinclude>
<includeonly>
[[Category:Ufr]]
</includeonly>

Category:Candidates for speedy deletion

2011-10-28T15:07:58Z

Chad-bisd: added administrator note.

Pages in this category qualify for immediate deletion by an admin.

'''ADMINISTRATORS''': Please do not delete this category if empty. An empty category means no articles have been identified as definite SPAM and marked for speedy deletion.

__HIDDENCAT__

Template:Db-spam

2011-10-28T13:52:36Z

Chad-bisd: changed style on message

<div style="border:2px solid black;color:#ff0000;background-color:#ffffff;font-weight:bold;font-size:large;">
This article is spam and needs to be deleted.
</div>
<includeonly>
[[Category:Candidates for speedy deletion]]
</includeonly>

User:Chad-bisd

2011-10-26T06:55:21Z

Chad-bisd: Undo revision 4344 by Jacksongir1 (talk)

Hello. My name is Chad Swanson. I started using FOG in August 2011 after using Novell Zenworks Configuration Management, v11 for almost a year. I'm a fan of open source software. I consume the products and give back by trying to support those that also use open source products, and by contributing as much as I can to the developers that create those projects.

Thanks,
Chad Swanson

Adding Storage to a FOG Server

2011-10-17T06:11:33Z

Chad-bisd: fixed discuss value in call to Merge template

{{Merge|target=Moving your images directory/Adding Storage to the Images directory|discuss=Talk:Adding Storage to a FOG Server}}

== Overview ==

This tutorial will cover how to add an additional hard disk to a server and mount it as /images. For example if you installed the host operating system on a drive that was 80GB, now you wish to add a new 1TB hard disk to mount as /images keeping the rest of the OS on the 80GB disk.

In this tutorial we are assuming you are using Ubuntu and that the disk you are installing is not formatted. If the drive is formatted, it may mount automatically, if you does, right click on it and select dismount.

=== Preparing new disk ===

*Connect the new drive to the host system.
*Determine device name by typing
sudo fdisk -l
It should look something like /dev/sdb (without a number after it), we will refer to this as [yourdevice].

'''Make sure this is correct because we will be destroying everything on this device, so make sure the disk capacity matches, etc.'''

*Lets wipe out the MBR and then some, type
sudo dd if=/dev/zero of=[yourdevice] count=20 bs=512

=== Partitioning ===

*Now lets partition it
sudo fdisk [yourdevice]
n
p
1
1
[press enter]
t
83
a
1
w

=== Formating and Mounting ===

*Put a filesystem on it
sudo mkfs.ext3 [yourdevice]1 (add a 1 to the end of your device name!)
*Your device is setup! Lets move your old images directory.
sudo mv /images /images.old
*Create the new mountpoint
sudo mkdir /images
*Now lets mount your new driver as /images
sudo mount -t ext3 /dev/sdb1 /images
*Make sure the new driver is mounted
mount
You are looking for '''[yourdevice] on /images'''
*Copy your old images and data to the new device
sudo cp -av /images.old/* /images/
*Create the .mntcheck file in the new images folder
sudo touch /images/.mntcheck
*Now make sure your new device gets mounted at system startup
sudo gedit /etc/fstab
*Add the following line:
[yourdevice]1 /images ext3 defaults 0 0
[yourdevice] should have the number 1 at the end of it.
*Change permissions on the device
sudo chmod 777 -R /images
*Now restart and make sure the new image volume mounts.

[[Category:Storage]][[Category:HowTo|AddStorage]]

Template:Merge

2011-10-17T06:05:02Z

Chad-bisd:

{{Mbox|image=[[Image:Merge-arrows.gif|50px|alt=|link=]]|text=It has been suggested that this article or section be merged with ''[[{{{target}}}]]''. ([[{{{discussion|{{{discuss|:{{TALKPAGENAME}}}}}}}}|Discuss]])
}}
<noinclude>
This template can be used to mark an article as a candidate for merging into another article. Do not use <nowiki>{{subst:}}</nowiki>.
</noinclude>
<includeonly>
[[Category:Articles for merging]]
</includeonly>

Error mounting NFS server 127.0.0.1

2011-10-17T06:03:57Z

Chad-bisd:

{{Merge|target=Error mounting NFS server 172.0.0.1|discuss=Talk:Error mounting NFS server 127.0.0.1}}

* Set FOG_PXE_IMAGE_DNSADDRESS to your DNS server ip address.
* Set FOG_USE_SLOPPY_NAME_LOOKUPS to 1.

Error mounting NFS server 172.0.0.1

2011-10-17T05:59:35Z

Chad-bisd:

{{Merge|target=Error mounting NFS server 127.0.0.1|discuss=Talk:Error mounting NFS server 127.0.0.1}}

== error monting nfs share 127.0.0.1 ==
This seems to be an error related to the FOG settings configuration.

Under FOG Settings > make sure NFS server settings points to <your static ipaddadress>

User talk:Jzhang88

2011-10-13T19:18:03Z

Chad-bisd: Created page with "Curious why you deleted my Template:Db-spam. This is what I used to mark articles for deletion and remove their content. ~~~~"

Curious why you deleted my [[Template:Db-spam]]. This is what I used to mark articles for deletion and remove their content. [[User:Chad-bisd|Chad-bisd]] 12:18, 13 October 2011 (MST)

Talk:Adding Storage to a FOG Server

2011-10-13T16:19:22Z

Chad-bisd:

i tried to install an new HD into my FOG server and i followed all the instructions but the new drive doesn't mount automatically nor does it seem to mount as /images. obviously i am missing something - any ideas?

This is for discussion about the article itself, not for asking questions about how to use/fix Fog. Please use the forums on the official website http://www.fogproject.org/ and we'll be glad to help. [[User:Chad-bisd|Chad-bisd]] 09:19, 13 October 2011 (MST)

Hook System

2011-10-02T22:41:35Z

Chad-bisd: Undo revision 4196 by Erscott (talk) ----- Spam added by user Erscott

Talk:Hook System Basics

2011-09-30T16:53:59Z

Chad-bisd: Created page with "I redirect this to the Hook System article until content is added or this article is removed as extraneous. Thanks, ~~~~"

I redirect this to the [[Hook System]] article until content is added or this article is removed as extraneous. Thanks, [[User:Chad-bisd|Chad-bisd]] 09:53, 30 September 2011 (MST)

Hook System Basics

2011-09-30T16:53:29Z

Chad-bisd: Redirected page to Hook System

#REDIRECT [[Hook System]]

[[Category:Development]]

Talk:Hook System Classes

2011-09-30T16:52:51Z

Chad-bisd: Created page with "I set this to redirect to the Hook System article until something is added or this page can be deleted as extraneous. Thanks, ~~~~"

I set this to redirect to the [[Hook System]] article until something is added or this page can be deleted as extraneous. Thanks, [[User:Chad-bisd|Chad-bisd]] 09:52, 30 September 2011 (MST)

Hook System Classes

2011-09-30T16:52:02Z

Chad-bisd: Redirected page to Hook System

#REDIRECT [[Hook System]]

[[Category:Development]]

FOGController

2011-09-30T16:49:09Z

Chad-bisd: /* Overview */ added Category:Development

== Overview ==
FOGController is a new Chainable PHP Class developed for use in FOG web applications.
This Class acts as an abstraction layer between PHP's data and its database entry.

The Class is an abstract Class, providing a base for FOG Classes to build from.
All you need to do is describe to the Class the relationship between your Database fields and common names used when accessing the data.

* Please note all of this is developmental and could change at any moment
[[Category:Development]]

== Variables & Methods ==
'''Variables and their defaults'''
<pre>
abstract class FOGController
{
// Table
protected $databaseTable = '';

// Name -> Database field name
protected $databaseFields = array();

// Do not update these database fields
protected $databaseFieldsToIgnore = array(
'createdBy',
'createdTime'
);

// Allow setting / getting of these additional fields
protected $additionalFields = array();

// Required database fields
protected $databaseFieldsRequired = array(
'id',
'name'
);

// Store data array
protected $data = array();

// Auto save class data on __destruct
protected $autoSave = false;

// DEBUG mode - print all Errors & SQL queries
protected $debug = false;
}
</pre>

'''Methods'''
<pre>
$this public function __construct($data)
$this public function __destruct()
$this public function set($key, $value)
$this public function get($key)
$this public function add($key, $value)
$this public function remove($key, $object)
boolean public function save()
boolean public function load($field = 'id')
boolean public function destroy($field = 'id')
void public function error($txt, $data = array())
void public function info($txt, $data = array())
boolean public function isValid()
boolean private function isTableDefined()
string public function __toString()
</pre>

== Example ==
This is an example of FOG's up coming OS Class in v0.33

'''OS.class.php'''
<pre>
class OS extends FOGController
{
// Table
protected $databaseTable = 'os';

// Name -> Database field name
protected $databaseFields = array(
'id' => 'osID',
'name' => 'osName',
'description' => 'osDescription'
);
}
</pre>

Only $databaseFields is required.

Providing $databaseTable gives access to FOGControllers save() and load() functions.

'''Example: Add new OS'''
<pre>
// New OS Object
$OS = new OS();

// Set name -> Set description -> Save to database (returns true on success)
if ($OS->set('name', 'Windows 8')->set('description', 'more junk')->save())
{
// id property is added after a successful save
$FOGCore->setMessage(sprintf('OS Added: ID: %s, Name: %s', $OS->get('id'), $OS->get('name')));
}
else
{
$FOGCore->setMessage(sprintf('Failed to add: %s', $OS->get('name')));
}

// Redirect back to self
$FOGCore->redirect();
</pre>

'''Example: Update an Existing OS'''
<pre>
// OS ID Variable
$id = '1';
// Load OS - auto loads from database when ID is passed
$OS = new OS($id);

// Is OS valid? (was it loaded from the database correctly)
if ($OS->isValid())
{
print_r($OS);
}
</pre>

== Class ==
'''FOGController.class.php'''
<pre>
<?php

// Blackout - 1:28 PM 23/09/2011
abstract class FOGController
{
// Table
protected $databaseTable = '';

// Name -> Database field name
protected $databaseFields = array();

// Do not update these database fields
protected $databaseFieldsToIgnore = array(
'createdBy',
'createdTime'
);

// Allow setting / getting of these additional fields
protected $additionalFields = array();

// Required database fields
protected $databaseFieldsRequired = array(
'id',
'name'
);

// Store data array
protected $data = array();

// Auto save class data on __destruct
protected $autoSave = false;

// DEBUG mode - print all Errors & SQL queries
protected $debug = true;

// Database Class
protected $db;

// Construct
public function __construct($data)
{
try
{
// Error checking
if (!count($this->databaseFields))
{
throw new Exception('No database fields defined for this class!');
}

// Database
$this->db = $GLOBALS['db'];

// Add incoming data
if (is_array($data))
{
// Iterate data -> Set data
foreach ($data AS $key => $value)
{
$this->set($key, $value);
}
}
// If incoming data is an INT -> Set as ID -> Load from database
elseif (is_numeric($data))
{
if ($data <= 0)
{
throw new Exception(sprintf('ID less than or equal to 0: Data: %s', $data));
//return false;
}

$this->set('id', $data)->load();
}
// Unknown data format
else
{
throw new Exception('No data array or ID passed!');
}
}
catch (Exception $e)
{
$this->error('Create Class Failed: Class: %s, Error: %s', array(get_class($this), $e->getMessage()));
}

return $this;
}

// Destruct
public function __destruct()
{
// Auto save
if ($this->autoSave)
{
$this->save();
}
}

// Set
public function set($key, $value)
{
try
{
$databaseFieldsRev = array_flip($this->databaseFields);

if (!array_key_exists($key, $this->databaseFields) && !in_array($key, $this->additionalFields) && !array_key_exists($key, $databaseFieldsRev))
{
throw new Exception('Invalid data being set');
}

if (array_key_exists($key, $databaseFieldsRev))
{
$key = $databaseFieldsRev[$key];
}

$this->data[$key] = $value;
}
catch (Exception $e)
{
$this->error('Set Failed: Class: %s, Key: %s, Value: %s, Error: %s', array(get_class($this), $key, $value, $e->getMessage()));
}

return $this;
}

// Get
public function get($key)
{
return (isset($this->data[$key]) ? $this->data[$key] : '');
}

/*
public function __set($key, $value)
{
return $this->set($key, $value);
}

public function __get($key)
{
return $this->get($key);
}
*/

// Add
public function add($key, $value)
{
try
{
$databaseFieldsRev = array_flip($this->databaseFields);

if (!array_key_exists($key, $this->databaseFields) && !in_array($key, $this->additionalFields) && !array_key_exists($key, $databaseFieldsRev))
{
throw new Exception('Invalid data being set');
}

if (array_key_exists($key, $databaseFieldsRev))
{
$key = $databaseFieldsRev[$key];
}

$this->data[$key][] = $value;
}
catch (Exception $e)
{
$this->error('Add Failed: Class: %s, Key: %s, Value: %s, Error: %s', array(get_class($this), $key, $value, $e->getMessage()));
}

return $this;
}

// Remove
public function remove($key, $object)
{
try
{
$databaseFieldsRev = array_flip($this->databaseFields);

if (!array_key_exists($key, $this->databaseFields) && !in_array($key, $this->additionalFields) && !array_key_exists($key, $databaseFieldsRev))
{
throw new Exception('Invalid data being set');
}

if (array_key_exists($key, $databaseFieldsRev))
{
$key = $databaseFieldsRev[$key];
}

foreach ((array)$this->data[$key] AS $i => $data)
{
if ($data->get('id') != $object->get('id'))
{
$newDataArray[] = $data;
}
}

$this->data[$key] = (array)$newDataArray;
}
catch (Exception $e)
{
$this->error('Remove Failed: Class: %s, Key: %s, Object: %s, Error: %s', array(get_class($this), $key, $object, $e->getMessage()));
}

return $this;
}

// Save
public function save()
{
try
{
// Error checking
if (!$this->isTableDefined())
{
throw new Exception('No Table defined for this class');
}

// Variables
$fieldData = array();
$fieldsToUpdate = $this->databaseFields;
$fieldToName = array_flip($this->databaseFields);

// Remove unwanted fields for update query
foreach ($this->databaseFields AS $name => $fieldName)
{
if (in_array($name, $this->databaseFieldsToIgnore))
{
unset($fieldsToUpdate[$name]);
}
}

// Build insert key and value arrays
foreach ($this->databaseFields AS $name => $fieldName)
{
$insertKeys[] = $this->db->sanitize($fieldName);
$insertValues[] = $this->db->sanitize($this->get($name));
}

// Build update field array using filtered data
foreach ($fieldsToUpdate AS $name => $fieldName)
{
$updateData[] = sprintf("`%s`='%s'", $this->db->sanitize($fieldName), $this->db->sanitize($this->get($name)));
}

// Insert & Update query all-in-one
$query = sprintf("INSERT INTO `%s` (`%s`) VALUES ('%s') ON DUPLICATE KEY UPDATE %s",
$this->db->sanitize($this->databaseTable),
implode("`, `", $insertKeys),
implode("', '", $insertValues),
implode(', ', $updateData)
);

// INFO
$this->info($query);

if (!$this->db->query($query))
{
// Query failed
throw new Exception($this->db->error());
}

// Database query was successful - set ID if ID was not set
if (!$this->get('id'))
{
$this->set('id', $this->db->insert_id());
}

// Success
return true;
}
catch (Exception $e)
{
$this->error('Database Save Failed: Class: %s, ID: %s, Error: %s', array(get_class($this), $this->get('id'), $e->getMessage()));
}

// Fail
return false;
}

// Load
public function load($field = 'id')
{
try
{
// Error checking
if (!$this->isTableDefined())
{
throw new Exception('No Table defined for this class');
}
if (!$this->get($field))
{
throw new Exception(sprintf('Operation field not set: %s', strtoupper($field)));
}

// Variables
$fieldToName = array_flip($this->databaseFields);

// Build query
if (is_array($this->get($field)))
{
// Multiple values
foreach ($this->get($field) AS $fieldValue)
{
$fieldData[] = sprintf("`%s`='%s'", $this->db->sanitize($this->databaseFields[$field]), $this->db->sanitize($fieldValue));
}

$query = sprintf("SELECT * FROM `%s` WHERE %s",
$this->db->sanitize($this->databaseTable),
implode(' OR ', $fieldData)
);
}
else
{
// Single value
$query = sprintf("SELECT * FROM `%s` WHERE `%s`='%s'",
$this->db->sanitize($this->databaseTable),
$this->db->sanitize($this->databaseFields[$field]),
$this->db->sanitize($this->get($field))
);
}

// INFO
$this->info($query);

// Did we find a row in the database?
if (!$queryData = $this->db->query($query)->fetch()->get())
{
throw new Exception($this->db->error());
}

// Loop returned rows -> Set new data
foreach ($queryData AS $key => $value)
{
$this->set($fieldToName[$key], (string)$value);
}

// Success
return true;
}
catch (Exception $e)
{
$this->error('Database Load Failed: Class: %s, ID: %s, Error: %s', array(get_class($this), $this->get('id'), $e->getMessage()));
}

// Fail
return false;
}

// Destroy
public function destroy($field = 'id')
{
try
{
// Error checking
if (!$this->isTableDefined())
{
throw new Exception('No Table defined for this class');
}
if (!$this->get($field))
{
throw new Exception(sprintf('Operation field not set: %s', strtoupper($field)));
}

// Variables
$fieldToName = array_flip($this->databaseFields);

// Query row data
$query = sprintf("DELETE FROM `%s` WHERE `%s`='%s'",
$this->db->sanitize($this->databaseTable),
$this->db->sanitize($this->databaseFields[$field]),
$this->db->sanitize($this->get($field))
);

// INFO
$this->info($query);

// Did we find a row in the database?
if (!$queryData = $this->db->query($query)->fetch()->get())
{
throw new Exception('Failed to delete');
}

// Success
return true;
}
catch (Exception $e)
{
$this->error('Database Destroy Failed: Class: %s, ID: %s, Error: %s', array(get_class($this), $this->get('id'), $e->getMessage()));
}

// Fail
return false;
}

// Error
public function error($txt, $data = array())
{
if ($this->debug)
{
$txt = (is_array($data) && count($data) ? vsprintf($txt, $data) : $txt);

$GLOBALS['FOGCore']->error(sprintf('Class: %s, Error: %s', get_class($this), $txt));
}
}

// Info
public function info($txt, $data = array())
{
if ($this->debug)
{
$txt = (is_array($data) && count($data) ? vsprintf($txt, $data) : $txt);

$GLOBALS['FOGCore']->info(sprintf('Class: %s, Info: %s', get_class($this), $txt));
}
}

// isValid
public function isValid()
{
// TODO: Add $this->databaseFieldsRequired checks

if ($this->get('id') || $this->get('name'))
{
return true;
}

return false;
}

// isTableDefined
private function isTableDefined()
{
return (!empty($this->databaseTable) ? true : false);
}

// Name is returned if class is printed
public function __toString()
{
return $this->get('name');
}
}
</pre>

Category:Development

2011-09-30T16:45:41Z

Chad-bisd: Created page with "Articles and pages relating to the development of the FOG product."

Articles and pages relating to the development of the FOG product.

Editing the ramdisk/init file

2011-09-30T16:40:05Z

Chad-bisd: Redirected page to Modifying the Init Image

#REDIRECT [[Modifying the Init Image]]

Category:Articles for merging

2011-09-30T07:23:55Z

Chad-bisd: Created page with "__HIDDENCAT__"

__HIDDENCAT__

Template:Mbox

2011-09-30T07:00:00Z

Chad-bisd:

<div style="border:1px solid black;background-color:#dddddd;">{{{image}}}<nowiki> </nowiki>{{{text}}}</div>

File:Merge-arrows.gif

2011-09-30T06:43:52Z

Chad-bisd:

Category:Storage

2011-09-30T06:12:26Z

Chad-bisd: Created page with "All articles related to the storage subsystem used by Fog"

All articles related to the storage subsystem used by Fog

Category:HowTo

2011-09-30T06:11:36Z

Chad-bisd: Created page with "A general category to help list all the helpful How-To type documents for easy location and reference."

A general category to help list all the helpful How-To type documents for easy location and reference.