===============================================================================
== General Documentation                                                     ==
===============================================================================

This document contains release specific notes for the accompanying JumpBox.
More general information and documentation can be found on the JumpBox 
Documentation Wiki at http://www.jumpbox.com/


== Description of the concept ==

JumpBox virtual appliances are the easiest path to running server based
applications. A JumpBox bundles the operating system with the application and 
all its dependencies into a single ready to run bundle. This allows you to focus 
on working with the application while not having to worry about getting it 
installed. It also means that the application can be deployed on any x86 
platform regardless of what platform the application is written for. All that is 
required is the JumpBox, some virtualization software like VMware, a
network that assigns dynamic IP addresses (most do), and a computer with enough 
RAM and disk space.


== System requirements ==

  * Windows, Mac or Linux with Virtualization software including:
    * VMware (http://www.vmware.com)
      * You can also download the free VMware player.
        (http://www.vmware.com/products/player/) 
    * Parallels (http://www.parallels.com)
    * Any Virtualization platform that can import OVFs or VMDK based virtual
      machines.
  * Up to 14GB Free disk space for growable disks.
  * Minimum 1GB RAM, 2GB recommended. 
  * A network that assigns dynamic IP address (most do)


== Accounts ==

When you first boot your JumpBox the console will display an IP address that you 
should open with a web browser. That will then guide you through the setup process 
to configure a user account. This account will grant you access to the JumpBox 
administration interface and it will also be the account you use to log into the 
application for the first time.

Immediately after JumpBox configuration you will be directed to the "Welcome
Page".  The welcome page contains the username you need to login to the
application bundled with the JumpBox.  Typically, the username will be 'admin'
but deviations from this are always noted on the welcome page. This welcome 
page should remain accessible at:
  http://IPADDRESS/jb/welcome.html

  
== Account Passwords ==

In general, there are three accounts on a JumpBox to start with:
 * Application Administrator
 * Linux System 'admin' User
 * JumpBox Admin Portal User
After initial configuration, all three users will have the password chosen
during configuration.  If, during the course of using the JumpBox, any of these
passwords are changed the other ones are NOT changed with it.  We do not keep
these passwords in sync after the initial configuration.  The only other
situation where these passwords are modified is during a JumpBox Restore.


== Backup Limitations ==

The JumpBox backup and restore utilities perform a FULL backup of the entire 
application state and any additional items you have specified as shown in the
"Backup Customization" section of this document.  By default, these backups 
run at 1:30 AM.  While the backup is running, the application will be 
inaccessible to ensure a consistent application state in the backup.

For users who have added large amounts of data to their JumpBoxes, our backup
tool may be inadequate.  The time it takes to backup could become disruptively
long or the JumpBox could have insufficient disk space to perform a backup
at all.  Users with these issues should consider utilizing their existing backup
infrastructure where available.  JumpBox Engineers can help identify the data 
that needs backing up and might be able to provide advice when installing 
third party backup agents.  Please ask on the JumpBox forums or via email if 
you have purchased support.

Details on the size restrictions and backup times vary considerably between
applications so please see the application specific part of this documentation
for details.

The S3 based backup mechanism currently has a 5GB limit on the backup file size.
If your backup exceed this you will receive an error.  We are working on a
resolution to this problem, though this falls into the realm where you are
encouraged to utilize a third party backup solution.


== Backup Customization ==

The JumpBox now provides a way for users to specify additional files or
directories on the JumpBox that need to be backed up by the JumpBox backup
mechanism.  This can be accomplished on a registered JumpBox by correctly
specifying the additional items in the /jumpbox/etc/user.yml.  SSH into the
JumpBox and refer to this file for usage details.  There is also a tool to
validate the user.yml file, this tool is:
  /jumpbox/bin/validate_user_yml
It will check the syntax of the file and indicate what will be backed up.

NOTE: The user.yml file must be correctly indented with two spaces for each
indent level.  So a correct example of a complete user.yml file would look 
like the following:

---
filebackup:
  # This is a comment
  /etc/php5/apache2/php5.ini: {}
  /usr/local:
    exclude_file: /admin/usr-local.exclude


== Application Specific Documentation ==

This JumpBox Platform README may be accompanied by additional information in
an application specific section below.  Also found below is JumpBox platform and
application specific Release Notes.  These may contain important information so
make sure to skim to those sections.

Additional application information is available on the JumpBox Wiki:
  http://wiki.jumpbox.com/


== Virtual Machine Resources ==

This JumpBox has default settings that may be too low for some user's needs.
You may consider raising the amount of RAM allocated to the JumpBox or adding
a virtual CPU if your platform supports it.


== Virtualization Platforms ==

For details on how to use your JumpBox on a specific virtualization platform
please visit the JumpBox Documentation Wiki: 
  http://wiki.jumpbox.com/doc/virtualization


== JumpBox Help and Information ==

If you have trouble with your JumpBox please check our wiki for tutorials, FAQs
and other important information:
    http://wiki.jumpbox.com/

If you are still experiencing difficulty post a question on our forums at:
    http://www.jumpbox.com/forums/

For details on purchasing support from JumpBox see:
    http://www.jumpbox.com/support/

To keep up to date with JumpBox see our blog at:
    http://www.jumpbox.com/blog/

== Notices ==

JumpBox is a registered trademark of JumpBox Inc.  All other marks and names
mentioned herein may be trademarks of their respective companies.


===============================================================================
== JumpBox Runtime Release 1.7                                               ==
===============================================================================

Release 1.7-58 Notable Changes
------------------------------
 - Many upstream updates from Ubuntu.
 - The kernel is now updated to the backported Natty kernel to resolve the ESX
   4.1 issues some users were still experiencing.

Release 1.6-41 Notable Changes
------------------------------
 - Upstream updates from Ubuntu.  This contains updates up to USN-1080-1.

Release 1.6-39 Notable Changes
------------------------------
 - Upstream updates from Ubuntu.  This is now Ubuntu Lucid 10.04.2 and contains
   updates up to USN-1065-1.

Release 1.6-31 Notable Changes
------------------------------
 - This is still an Ubuntu Lucid based release, however a number of things have
   changed, these are outlined below.
 - This release now uses the linux-generic-pae kernel for compatibility with
   vmware ESX 4.1, this unfortunately breaks compatibility with older
   virtualization platforms that lack PAE support.
 - Non VMware disks and configuration files have been removed.  This means that
   compatibility with other platforms can only be achieved by the use of those
   platforms VMDK import processes or through the use of OVFs.  Please check the
   JumpBox Blog and Website for more information on these changes.
 - [Update] All JumpBoxes now have three disks.  A two GB root disk, a two GB
   /usr disk and a 10GB /storage disk.

Release 1.5-23 Notable Changes
------------------------------
 - This has been a production release for at least several versions, our
   apologies for not indicating as much in these release notes.
 - All JumpBoxes now have a larger, 2GB, root disk by default.
 - The hostname is now displayed in the virtual console after setup.

Release 1.5-17 Notable Changes
-------------------------------
 - *** THIS IS A BETA RELEASE, FOR EVALUATION USE ONLY ***
 - Has known issue with error handling when setting invalid email relay.
 - The default amount of RAM allocated to the JumpBox has been increased to a
   minimum of 512 MB, some JumpBoxes may use more.
 - Fixed intermittent NFS related backup issue from 1.5-13.
 - Time sync with the host has been disabled and replaced by the NTP time
   server, this requires that the JumpBox have network access.  If outbound
   networking is not available you can use your own NTP server or reenable the
   virtual host based time sync on VMware based platforms.
 - We have fixed the "First Boot Method" for getting a larger storage disk as 
   described here:
       http://wiki.jumpbox.com/doc/runtime/faq/larger_storage_disk

Release 1.5-13 Notable Changes
-------------------------------
 - *** THIS IS A BETA RELEASE, FOR EVALUATION USE ONLY ***
 - This is the first Ubuntu Lucid Lynx 10.04 LTS based release of a JumpBox.
 - Has known intermittent issue with NFS based backups and restores.  Retrying
   in the event of failure works.

===============================================================================
== ProjectPier Release Notes                                                 ==
===============================================================================

Wed Nov 14 10:10:48 MST 2012 - 1.7.4
 - This is a maintenance release. The included version of the application has
   not changed.

Tue Aug  7 15:06:00 MST 2012 - 1.7.3
 - This is a maintenance release. The included version of the application has
   not changed.

Thu May  3 09:20:34 MST 2012 - 1.7.2
 - Project Pier has been updated to version 0.8.8 SP2. 
 - This releae brings a long list of changes including new contacts and 
   subprojects features. See the full release notes for detail:
   http://www.projectpier.org/projectrelease/projectpier-088stable
 - You should be able to restore a backup from JumpBox version 1.6.0 or higher 
   to upgrade. If you are on a lower version you can upgrade to 1.6.0 first and
   then backup again and restore to 1.7.2.

Wed Dec  7 10:12:02 MST 2011 - 1.7.1
 - This is a maintenance release. The included version of the application has
   not changed.

Wed Aug 10 10:18:52 MST 2011 - 1.7.0
 - This is a maintenance release. The included version of the application has
   not changed.

Thu Apr 28 09:55:33 MST 2011 - 1.6.1
 - This is a maintenance release. The included version of the application has
   not changed.

Mon Jan 17 11:01:45 MST 2011 - 1.6.0
 - Project Pier has been updated to version 0.8.6. 
 - Release notes: http://www.projectpier.org/node/1891
 - This is the first update to this application in almost two years and is a 
   major overhaul including a completely new user interface. 
 - Note: some application functionality like tags and file attachements have
   been moved to plugins. If you upgrade and are missing a feature you should
   check to see if it's been made a plugin.
 - You should be able to restore a backup from JumpBox version 1.1.2 or higher 
   to upgrade. If you are on a lower version you can upgrade to 1.1.2 first and
   then backup again and restore to 1.6.0.

Tue Nov  2 14:03:22 MST 2010 - 1.5.0
 - This is a maintenance release. The included version of the application has
   not changed.
 - The JumpBox is now based on the 10.04 Lucid version of Ubuntu Linux 

Wed Jul 14 13:18:29 MST 2010 - 1.1.8
 - This is a maintenance release. The included version of the application has
   not changed.

Fri Apr  2 10:51:53 MST 2010 - 1.1.7
 - This is a maintenance release. The included version of the application has
   not changed.

Mon Nov 16 12:50:22 MST 2009 - 1.1.6
 - This is a maintenance release. The included version of the application has
   not changed.
 - The application has been moved to the root URL.

Mon Jul 27 22:52:23 MST 2009 - 1.1.5
 - This is a maintenance release. The included version of the application has
   not changed.

Fri Mar 13 10:02:13 MST 2009 - 1.1.4
 - This is a maintainence upgrade. The included version of ProjectPier has not
   changed.
 - A number of improvements have been made in the JumpBox administration 
   portal. These include improvements to SSL mode and the backup system.
 - Restoring from 0.9 and newer JumpBox backups should work.

Tue Sep 30 12:40:39 MST 2008 - 1.1.3
 - No application specific updates.  Check the Platform Release section for
   details.

Mon Aug  4 19:25:07 MST 2008 - 1.1.2
 - ProjectPier has been updated to ProjectPier version 0.8.0.3. Restoring from
   0.9 and newer JumpBox backups should work.

Sun Jul 27 17:59:48 MST 2008 - 1.1.1
 - Security update. The version of the included application has not changed, 
   but the JumpBox has been released to fix a vulnerability in PHP.

Thu Jun 26 10:44:23 MST 2008 - 1.1.0
 - Initial release of this application on the JumpBox 1.1.0 Platform.
 - The ProjectPier version did not change.  Users should be able to restore from 
   this JumpBox version 1.0 and later.

Wed Feb 27 14:04:38 MST 2008 - 1.0.2
 - ProjectPier has been updated to ProjectPier version 0.8.0.2.   Restoring from 
   0.9 and newer JumpBox backups should work.

Tue Feb 19 14:16:21 MST 2008 - 1.0.1
 - ProjectPier has been updated to ProjectPier version 0.8.0.1.   Restoring from 
   0.9 and newer JumpBox backups should work.

Wed Jan 30 09:17:14 MST 2008 - 1.0
 - First production release of the ProjectPier Jumpbox.  Includes ProjectPier 
   version 0.8.0.  You should be able to restore from the 0.9 ProjectPier 
   JumpBox.

Wed Nov  7 13:49:39 MST 2007 - 0.9
 - ******** WARNING ******** 
   **  This is release is either beta or experimental. It should not be relied
   **  upon for production use.
   ******** WARNING ******** 
 - Initial Experimental public release of ProjectPier Version 0.8.0 JumpBox.

