Skip to content

Commit

Permalink
Cleaned up README.txt. Added dwalton to CREDITS
Browse files Browse the repository at this point in the history
  • Loading branch information
dwalton76 committed Oct 28, 2013
1 parent e306842 commit b9018ad
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 22 deletions.
8 changes: 7 additions & 1 deletion CREDITS
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
# Curt
#

N: Daniel Walton
E: [email protected]
D: ONIE-server
S: Apex, NC
S: USA

N: Ed Swierk
E: [email protected]
D: Discovery mechanism contributions
Expand Down Expand Up @@ -47,4 +53,4 @@ N: Pete Bratach
E: [email protected]
D: documentation
S: San Francisco, CA
S: USA
S: USA
29 changes: 8 additions & 21 deletions contrib/onie-server/README.txt
Original file line number Diff line number Diff line change
@@ -1,32 +1,21 @@

Description
-----------
This program is a DHCP server, web server and HTTP proxy all rolled into one.
The goal of this program is help install an OS on a bare-metal switch, using only
a windows, linux or OSX laptop/PC.
This program is a DHCP server, web server and HTTP proxy all rolled into one. The goal of this program is help install an OS on a bare-metal switch, using only a windows, linux or OSX laptop/PC.


Instructions
------------
- Download the OS you would like to install and save it as onie-installer.
The onie-installer image must go in the same directory as the onie-server.py file.
- Start the ONIE server program via "python onie-server.py"
If you are on a Mac or Linux use sudo:
sudo python onie-server.py
- Download the OS you would like to install and save it as onie-installer. The onie-installer image must go in the same directory as the onie-server.py file.
- Start the ONIE server program via "python onie-server.py". If you are on a Mac or Linux use sudo "sudo python onie-server.py"
- Answer a few questions to start the DHCP, HTTP and proxy servers
- ONIE should request a DHCP address and then begin downloading the onie-installer image via the web server


HTTP Proxy Server
-----------------
Some operating systems support downloading updates or new packages via HTTP. onie-server.py launches a HTTP proxy server so point your switch towards that proxy in order to download updates or new packages to your switch. The proxy server listens on the IP address of your laptop (the interface connected to your bare-metal switch) on port 8080.

Updating/Adding Packages
------------------------
This is optional but if you like you can use apt to update or add packages
to your switch. apt downloads data via HTTP so we need to point apt at the
HTTP proxy server that you just started. The proxy server listens on
the IP address of your laptop (the interface connected to your bare-metal switch)
on port 8080.

There are detailed instructions here on how to tell apt to use a http proxy:
For example on debian based operating systems you can use "apt" to download updates and new packages via HTTP. There are detailed instructions here on how to tell apt to use a http proxy:
https://help.ubuntu.com/community/AptGet/Howto#Setting_up_apt-get_to_use_a_http-proxy

In a nutshell you do:
Expand All @@ -39,6 +28,4 @@ export http_proxy=http://10.1.1.1:8080

Shutting Down The Servers
-------------------------
Once you have finished installing Cumulus Linux on your switch you can
press ENTER in the window where you are running onie-server.py to
shutdown the DHCP, web and proxy servers.
Once you have finished installing the operating system on your switch you can press ENTER in the window where you are running onie-server.py to shutdown the DHCP, web and HTTP proxy servers.

0 comments on commit b9018ad

Please sign in to comment.