= Emulab Documentation =

=== About this Wiki ===

This Wiki is a new addition to Emulab, and is definitely a work in
progress. Registered Emulab users are encouraged to help us improve
this documentation anytime you see something that needs fixing, or if
you want to add something new. Just use the ''Login'' button in the
upper right and you will be taken over to the Emulab login page, and
then returned back here. (Note that we get notification of all changes
to the wiki, so we can see if anything incorrect or inappropriate is
added).

If you have any problems with the wiki, or with anything else about Emulab, 
please file a [/trac/emulab/newticket Ticket].

'''Got questions? Join the''' [http://groups.google.com/group/emulab-users Emulab Users Forum].

=== Getting Started on the Testbed ===
        * [wiki:Auth How to get an account on the Testbed]
            * Starting or joining projects, authorization, and policies. Also see our [wiki:SecReqs Security Requirements] and [wiki:AdminPolicies Adminstrative Policies] for additional information.
        * [wiki:FAQ Frequently Asked Questions (FAQ)]
	    * Probably our most important reference document. Check here before asking for help. Includes sections on "Getting Started" on Emulab, using the testbed, hardware setup, software setup, security issues, and troubleshooting. Over 50 questions and answers.  
        * [wiki:Tutorial Emulab "Getting Started" Tutorial]
            * The basics of creating experiments, and a quick intro to frequently used features, avoiding common pitfalls, and quick solutions to the most common problems people encounter. 

=== Advanced Usage ===
        * [wiki:AdvancedExample Advanced Tutorial]
            * Examples of the more esoteric features of Emulab. 
        * [wiki:Windows Windows Nodes]
            * Using windows nodes in Emulab experiments.
        * [wiki:vnodes Virtual nodes]
            * Running experiments using virtual, rather than physical, machines.
        * [wiki:xen Xen-based virtual nodes]
	    * Experimental support for Xen-based virtual nodes.
        * [wiki:wireless Wireless]
            * Using Emulab's wireless testbed.
        * [wiki:plab Emulab PlanetLab Interface]
            * Documentation for our interface to [http://www.planet-lab.org/php/aup/ PlanetLab].
        * [wiki:eucalyptus Eucalyptus on Emulab]
            * Create your own Eucalyptus Cloud on Emulab
        * [wiki:pgeniNodes ProtoGENI nodes]
            * Coming soon!

=== Reference Material ===
    * [wiki:KnowledgeBase The Emulab Knowledge Base]
        * A larger version of the [wiki:FAQ FAQ]
    * [http://www.emulab.net/pubs.php3 Emulab Publications]
    * [wiki:Groups All about project subgroups]
    * [wiki:nscommands Testbed NS Command Extensions]
    * [wiki:netbuilddoc Netbuild GUI Reference Manual]
         * How to use our original GUI application for creating topologies.
    * [wiki:InstallRoot Installation Documentation]
         * How to install a new Emulab or upgrade an existing one.
    * [wiki:Swapping Node Usage Policies] and everything else about swapping, idling, and fair use of resources.
    * [wiki:HWRecommend Build your own Emulab]
         * What we recommend for hardware if you decide to build your own Emulab.
    * [wiki:software Software Overview]
         * An overview of what runs on boss, ops, and your experimental nodes.
    * [wiki:UtahHardware Hardware Overview]
         * An overview of the hardware at Utah's Emulab. Site specific hardware found [[BOSS(hardware.php, here)]]
    * [wiki:MiscDoc Misc Documentation]

=== Implementation Documentation ===
    * [wiki:NodeBootStates A short note on node booting and related state transitions]
    * [wiki:ClientSelfConfig The (someday) complete story of client configuration via TMCD]
    * [wiki:DelayImplementation Everything you (n)ever wanted to know about link shaping]
    * [wiki:EventSystemImpl Shocking revelations about the Emulab event system implementation]
    * [wiki:DeathByDHCP The sordid tale of configuring the control net via DHCP]
    * [wiki:ClientSideStuff Details of files that Emulab installs on a client OS to make it play nice]
    * [wiki:CiscoVoodoo Stuff your parents didn't tell you about Cisco switches]

=== Miscellaneous ===
    * [wiki:GitRepository Get the Emulab source code]
    * [wiki:OtherEmulabs Other Emulabs in the wild]
    * [wiki:Classes University Classes that have used Utah's Emulab]
    * [http://www.emulab.net/expubs.php Published papers that have used Emulab (or its sister sites)]
    * [http://www.emulab.net/docwrapper.php3?docname=sponsors.html Emulab's Sponsors]
    * [http://www.emulab.net/news.php3 Current and Past News]
    * [http://www.emulab.net/doc/changelog.php3 ChangeLog for Emulab source code]
    * [https://users.emulab.net/trac/protogeni ProtoGeni Wiki] 
    * [https://users.emulab.net/trac/emulab-priv Internal Site]