Skip to content
This repository has been archived by the owner on Mar 23, 2021. It is now read-only.

Commit

Permalink
Merge pull request #71 from goldsmcb/master
Browse files Browse the repository at this point in the history
4.1 Update
  • Loading branch information
StevenStrand committed May 9, 2016
2 parents 8c3de9b + 2e285e1 commit 5607a39
Show file tree
Hide file tree
Showing 192 changed files with 19,786 additions and 13,635 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
.DS_Store
.svn

NetSUSLPInstaller.run
.name
compiler.xml
misc.xml
modules.xml
NetSUS.iml
vcs.xml
workspace.xml
profiles_settings.xml
cgolds.xml
6 changes: 6 additions & 0 deletions CHANGELOG.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# NetSUS Changelog

## 4.1

* New and improved User Interface and minor changes to the User Experience
* Added LDAP administration group login support
* Added ability to rename the advertised NetBoot name
* Documentation updated, improved, and converted to markdown format

## 4.0

Expand Down
112 changes: 54 additions & 58 deletions README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,58 +1,54 @@

NetSUS Downloads
======

Installer:
http://content.jamfcloud.com/NetSUSLP_4.0.0.run

OVA:
http://content.jamfcloud.com/NetSUSLP_4.0.0.ova




# What is NetSUS?

The NetBoot/SUS/LP server allows you to host an internal software update server (SUS), a NetBoot server, and a LDAP Proxy server **all on the same Linux system**. For a list of supported Linux distributions see [Requirements](#requirements).

<p align="center"><img src="docs/images/attachments/dashboard.png" height="270"></p>

* **Software Update Server** - Unlike a standard SUS, the SUS hosted by the NetBoot/SUS/LP server allows you to control which software updates should be installed on each computer in your organization.

* **NetBoot Server** - The NetBoot/SUS/LP server allows you to host a NetBoot image. You can boot computers to a NetBoot image in place of a recovery partition or external drive when imaging.

* **LDAP Proxy** - Use the NetBoot/SUS/LP server as a lightweight proxy that acts as a middleware layer between LDAP clients and LDAP directory servers.

* **Web Application** - The NetBoot/SUS/LP server includes a web application that can be used to easily manage your NetBoot and Software Update Servers as well as your LDAP Proxy. The dashboard page is shown above.

## Documentation

For a getting started guide and step-by-step walkthroughs check out the **[documentation for the current release](docs/README.md)**

## <a name="requirements"></a>Requirements

#### Supported Linux distributions:

* Ubuntu 10.04 LTS Server
* Ubuntu 12.04 LTS Server
* Ubuntu 14.04 LTS Server
* Red Hat Enterprise Linux (RHEL) 6.4 or later
* CentOS 6.4 or later

#### To install the NetBoot/SUS/LP server using an installer, you need:

* The NetBoot/SUS/LP Server Installer (.run), available at:
<https://jamfnation.jamfsoftware.com/viewProduct.html?id=180&view=info>
* 300 GB of disk space available
* 1 GB of RAM

#### To set up the NetBoot/SUS/LP server as an appliance, you need:

* The OVA file for the NetBoot/SUS/LP server, available at:
<https://jamfnation.jamfsoftware.com/viewProduct.html?id=180&view=info>
* Virtualization software that supports Open Virtualization Format
* 300 GB of disk space available
* 2 GB of RAM

**Only Intel-based Macs can use a NetBoot server hosted by the NetBoot/SUS/LP server.**


# NetSUS Downloads

Installer:
http://content.jamfcloud.com/NetSUSLP_4.0.0.run

OVA:
http://content.jamfcloud.com/NetSUSLP_4.0.0.ova


# What is NetSUS?

The NetBoot/SUS/LP server allows you to host an internal software update server (SUS), a NetBoot server, and a LDAP Proxy server **all on the same Linux system**. For a list of supported Linux distributions see [Requirements](#requirements).

<p align="center"><img src="docs/images/attachments/dashboard.png" height="270"></p>

* **Software Update Server** - Unlike a standard SUS, the SUS hosted by the NetBoot/SUS/LP server allows you to control which software updates should be installed on each computer in your organization.

* **NetBoot Server** - The NetBoot/SUS/LP server allows you to host a NetBoot image. You can boot computers to a NetBoot image in place of a recovery partition or external drive when imaging.

* **LDAP Proxy** - Use the NetBoot/SUS/LP server as a lightweight proxy that acts as a middleware layer between LDAP clients and LDAP directory servers.

* **Web Application** - The NetBoot/SUS/LP server includes a web application that can be used to easily manage your NetBoot and Software Update Servers as well as your LDAP Proxy. The dashboard page is shown above.

## Documentation

For a getting started guide and step-by-step walkthroughs check out the **[documentation for the current release](docs/README.md)**

## <a name="requirements"></a>Requirements

#### Supported Linux distributions:

* Ubuntu 10.04 LTS Server
* Ubuntu 12.04 LTS Server
* Ubuntu 14.04 LTS Server
* Red Hat Enterprise Linux (RHEL) 6.4 or later
* CentOS 6.4 or later

#### To install the NetBoot/SUS/LP server using an installer, you need:

* The NetBoot/SUS/LP Server Installer (.run), available at:
<https://jamfnation.jamfsoftware.com/viewProduct.html?id=180&view=info>
* 300 GB of disk space available
* 1 GB of RAM

#### To set up the NetBoot/SUS/LP server as an appliance, you need:

* The OVA file for the NetBoot/SUS/LP server, available at:
<https://jamfnation.jamfsoftware.com/viewProduct.html?id=180&view=info>
* Virtualization software that supports Open Virtualization Format
* 300 GB of disk space available
* 2 GB of RAM

**Only Intel-based Macs can use a NetBoot server hosted by the NetBoot/SUS/LP server.**
Empty file modified docs/README.md
100644 → 100755
Empty file.
17 changes: 1 addition & 16 deletions docs/accounts.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,16 +1 @@
# AccountsThe following table lists the default credentials for all accounts associated with the NetBoot/SUS/LP server:

Account | Username | Password
------- | -------- | --------
Web Application | webadmin | webadmin
Shell (used to administer the NetBoot/SUS/LP server from the command line) | shelluser | shelluser
AFP share | afpuser | afpuser
SMB user | smbuser | smbuser

You can change the usernames and passwords for the web application and shell accounts. You can also change the passwords for the AFP and SMB shares.

## Changing the Web Application or Shell Credentials
1. Log in to the NetBoot/SUS/LP server web application.
2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .3. In the "NetBoot/SUS/LDAP Proxy Server" section, click **Accounts** <img height="20" src="images/thumbnails/user_icon.png"> .4. Change the credentials using the fields and tabs provided.5. Click **Save**. A message displays, reporting the success or failure of the change.

## Changing the Password for the AFP or SMB Share1. Log in to the NetBoot/SUS/LP server web application.2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .3. In the "Shares" section, click **AFP** or **SMB** <img height="20" src="images/thumbnails/categories_icon.png"> .4. Enter and verify the new password.5. Click **Save**. A message displays, reporting the success or failure of the change.
# AccountsThe following table lists the default credentials for all accounts associated with the NetBoot/SUS/LP server:Account | Username | Password------- | -------- | --------Web Application | webadmin | webadminShell (used to administer the NetBoot/SUS/LP server from the command line) | shelluser | shelluserAFP share | afpuser | afpuserSMB user | smbuser | smbuserYou can change the usernames and passwords for the web application and shell accounts. You can also change the passwords for the AFP and SMB shares.## Changing the Web Application or Shell Credentials1. Log in to the NetBoot/SUS/LP server web application.2. In the side navigation menu or in the mobile dropdown menu, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .3. In the "NetBoot/SUS/LDAP Proxy Server" section, click **Accounts** <img height="20" src="images/thumbnails/user_icon.png"> .4. Change the credentials using the fields and tabs provided.5. Click **Save**. A message displays, reporting the success or failure of the change.## Changing the Password for the AFP or SMB Share1. Log in to the NetBoot/SUS/LP server web application.2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .3. In the "Shares" section, click **AFP** or **SMB** <img height="20" src="images/thumbnails/categories_icon.png"> .4. Enter and verify the new password.5. Click **Save**. A message displays, reporting the success or failure of the change.
Expand Down
Empty file modified docs/getting_started.md
100644 → 100755
Empty file.
Binary file modified docs/images/attachments/certificates.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/attachments/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/attachments/ldap_proxy.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/attachments/netboot.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/attachments/netboot_lower.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/images/attachments/proxy_diagram.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/attachments/sus_branch_lower.png
Binary file not shown.
Binary file modified docs/images/attachments/sus_branch_upper.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/attachments/sus_no_branch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/attachments/sus_no_branches.png
Binary file not shown.
Binary file added docs/images/attachments/sus_sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/attachments/sus_with_branch.png
Binary file not shown.
Binary file modified docs/images/thumbnails/settings_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 18 additions & 7 deletions docs/ldap_proxy.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# LDAP Proxy ServerThe LDAP Proxy Server is a proxy server that allows you to expose an access point to an LDAP Server. In doing so it allows you to adjust the distinguished name to whatever you choose. You may find the following diagram helpful when filling out your proxy information.
# LDAP Proxy Server
The LDAP Proxy Server is a proxy server that allows you to expose an access point to an LDAP Server. In doing so it allows you to adjust the distinguished name to whatever you choose. You may find the following diagram helpful when filling out your proxy information.

<p align="center"><img height="140" src="images/attachments/proxy_diagram.png"></p>
1. Log in to the NetBoot/SUS/LP server web application.2. Click **LDAP Proxy** in the side navigation menu.On a smartphone, this option is in the pop-up menu.3. Enter your **Exposed Distinguished Name** that you intend to use to reach the proxy. For more information, see [Exposed Distinguished Name](#edn)4. Enter your **Real Distinguished Name** that you use to connect to the LDAP Server. For more information, see [Real Distinguished Name](#rdn)

5. Enter your **LDAP URL** with the port of the LDAP Server. For more information, see [LDAP URL](#lu)6. Click **Add**
<img height="140" src="images/attachments/proxy_diagram.png">

<p align="center"><img src="images/attachments/ldap_proxy.png" width="500"></p>7. Enter as many other LDAP Connections as you want to configure
1. Log in to the NetBoot/SUS/LP server web application.

8. Click **Enable LDAP Proxy**
2. Click **LDAP Proxy** in the side navigation menu or in the mobile dropdown menu.

3. Enter your **Exposed Distinguished Name** that you intend to use to reach the proxy. For more information, see [Exposed Distinguished Name](#edn)

4. Enter your **Real Distinguished Name** that you use to connect to the LDAP Server. For more information, see [Real Distinguished Name](#rdn)

5. Enter your **LDAP URL** with the port of the LDAP Server. For more information, see [LDAP URL](#lu)

6. Click **Add**

<img src="images/attachments/ldap_proxy.png" width="500">

7. Enter as many other LDAP Connections as you want to configure

8. Click **Enable LDAP Proxy**

## <a name="edn"></a>Exposed Distinguished Name

Expand Down
18 changes: 1 addition & 17 deletions docs/netboot.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,17 +1 @@
# Setting Up the NetBoot Server
To set up a NetBoot server, you need a NetBoot image (.nbi folder). For more information, see the following Knowledge Base article:[Creating a NetBoot Image and Setting Up a NetBoot Server](https://jamfnation.jamfsoftware.com/article.html?id=307)

1. Log in to the NetBoot/SUS/LP server web application.2. Click **NetBoot Server**.On a smartphone, this option is in the pop-up menu.3. Upload a NetBoot image: * Click **Upload NetBoot Image**.

<p align="left"><img src="images/attachments/netboot.png" width="500"></p>
* You will be connected to the SMB share where NetBoot images are stored. * Enter credentials for the SMB share and click **Connect**. * Copy a NetBoot image (.nbi) to the SMB share.

**Important:** The name of the folder cannot contain any spaces.4. Return to the NetBoot/SUS/LP server web application and refresh the page.5. Choose the NetBoot image from the pop-up menu.6. Choose subnets for the NetBoot image by entering a subnet and a netmask. Then click **Add Subnet**.

**Important**: One of the subnets must include the IP address of the NetBoot server.7. Click **Enable NetBoot**. If NetBoot is successfully enabled, the NetBoot status icon turns green.

## Using the NetBoot Server with the Casper Suite**Note**: The instructions in this section are for the Casper Suite v9.0 or later. However, if you are using the Casper Suite v8.x, these instructions can still be followed loosely.
Like standard NetBoot servers, you can add the NetBoot server hosted by the NetBoot/SUS/LP server to the JSS. This allows you to use a policy or Casper Remote to boot managed computers to a NetBoot image.
When adding the NetBoot server to the JSS, enter the IP address specified in the NetBoot/SUS/LP server web application and choose the “Use default image” option from the NetBoot Image pop-up menu.
For more information on adding a NetBoot server to the JSS, see the “NetBoot Servers” section in the Casper Suite Administrator’s Guide.
For more information on using a policy or Casper Remote to boot computers to a NetBoot image, see the “Booting Computers to NetBoot Images” section in the Casper Suite Administrator’s Guide.
# Setting Up the NetBoot ServerTo set up a NetBoot server, you need a NetBoot image (.nbi folder). For more information, see the following Knowledge Base article:[Creating a NetBoot Image and Setting Up a NetBoot Server](https://jamfnation.jamfsoftware.com/article.html?id=307)1. Log in to the NetBoot/SUS/LP server web application.2. Click **NetBoot Server** in the side navigation menu or in the mobile dropdown menu.3. Upload a NetBoot image: * Click **Upload NetBoot Image**. <img src="images/attachments/netboot.png" width="500"> * You will be connected to the SMB share where NetBoot images are stored. * Enter credentials for the SMB share and click **Connect**. * Copy a NetBoot image folder (.nbi extension) to the SMB share. The nbi folder must contain a .plist file and .dmg file to function properly. **Important:** The name of the folder cannot contain any spaces.4. Return to the NetBoot/SUS/LP server web application and refresh the page.5. Choose the NetBoot image from the pop-up menu.6. **Optional:** Enter a name for your Netboot Server. The name cannot contain spaces. If left blank the name will default to the name of your .nbi folder uploaded previously. For common issues on this setting please see the troubleshooting section below. 7. Choose subnets for the NetBoot image by entering a subnet and a netmask. Then click **Add**. **Important**: One of the subnets must include the IP address of the NetBoot server. <img src="images/attachments/netboot_lower.png" width="500">8. Click **Enable NetBoot**. If NetBoot is successfully enabled, the NetBoot status alert turns green.## TroubleshootingThe best place to gather information on why your NetBoot Server might not be working is the "dhcpd" service logs in your system's default log locaion. For example:On Debian family distributions you would enter the command`grep "dhcpd" /var/log/syslog`On Red Hat family distributions you would enter the command`grep "dhcpd" /var/log/messages`Either of these commands will output a list of logs related to the dhcpd service to your console window. ## Using the NetBoot Server with the Casper Suite**Note**: The instructions in this section are for the Casper Suite v9.0 or later. However, if you are using the Casper Suite v8.x, these instructions can still be followed loosely.Like standard NetBoot servers, you can add the NetBoot server hosted by the NetBoot/SUS/LP server to the JSS. This allows you to use a policy or Casper Remote to boot managed computers to a NetBoot image.When adding the NetBoot server to the JSS, enter the IP address specified in the NetBoot/SUS/LP server web application and choose the “Use default image” option from the NetBoot Image pop-up menu.For more information on adding a NetBoot server to the JSS, see the “NetBoot Servers” section in the Casper Suite Administrator’s Guide.For more information on using a policy or Casper Remote to boot computers to a NetBoot image, see the “Booting Computers to NetBoot Images” section in the Casper Suite Administrator’s Guide.
Expand Down
12 changes: 6 additions & 6 deletions docs/settings.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You may need to restart the AFP or SMB share for troubleshooting purposes.

1. Log in to the NetBoot/SUS/LP server web application.

2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .
2. In the side navigation menu or in the mobile dropdown menu, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .

3. In the "Shares" section, click **AFP** or **SMB** <img height="20" src="images/thumbnails/categories_icon.png">.

Expand All @@ -21,7 +21,7 @@ The User Menu now adds additional functionality to be able to Disable GUI.

1. Log in to the NetBoot/SUS/LP server web application.

2. In the top-right corner of the page, click the username drop down.
2. In the side navigation menu or in the mobile dropdown menu, click the username drop down.

3. In the drop down list select Disable GUI.

Expand Down Expand Up @@ -62,7 +62,7 @@ The Network settings allow you to configure the following:

1. Log in to the NetBoot/SUS/LP server web application.

2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .
2. In the side navigation menu or in the mobile dropdown menu, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .

3. In the "NetBoot/SUS/LDAP Proxy Server" section, click **Network** <img height="20" src="images/thumbnails/network_icon.png">.

Expand All @@ -80,7 +80,7 @@ The Date/Time settings allow you to do the following:

1. Log in to the NetBoot/SUS/LP server web application.

2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .
2. In the side navigation menu or in the mobile dropdown menu, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .

3. In the "NetBoot/SUS/LDAP Proxy Server" section, click **Date/Time** <img height="20" src="images/thumbnails/clock_icon.png"> .

Expand All @@ -94,13 +94,13 @@ Certificates Settings allows you to modify the server settings with either a Tom

1. Log in to the NetBoot/SUS/LP server web application.

2. In the top-right corner of the page, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .
2. In the side navigation menu or in the mobile dropdown menu, click **Settings** <img height="20" src="images/thumbnails/settings_icon.png"> .

3. In the "NetBoot/SUS/LDAP Proxy Server" section, click **Certificates** <img height="30" src="images/thumbnails/certificates_icon.png"> .

4. Enter the "Private Key", "Certificate", and "Chain" fields with the appropriate unencrypted certificate information.

<p align="center"><img src="images/attachments/certificates.png" width="500"></p>
<img src="images/attachments/certificates.png" width="500">

5. Click **Save**.

Expand Down
Loading

0 comments on commit 5607a39

Please sign in to comment.