=============================================================================== == 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) * Microsoft Hyper-V (see wiki for details) * Xen OpenSource 3.0+ in HVM mode (http://www.xen.org) * Up to 12GB 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.5 == =============================================================================== 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. =============================================================================== == Sakai Release Notes == =============================================================================== Fri Sep 3 13:45:00 MST 2010 - 1.5.0 - This is a maintenance release. The included version of Sakai has not changed. - The JumpBox for Sakai is now based on Ubuntu 10.04 (Lucid). Wed Mar 31 13:00:17 MST 2010 - 1.1.1 - Sakai has been updated to rSmart Sakai CLE 2.6.3. - It should be possible to restore from backups created by any version of this JumpBox. - This release contains numerous bugfixes and improvements, and two security fixes. - Complete release notes are available at the following URL: http://www.rsmart.com/files/rsmart/rSmart_Sakai_CLE_2.6.3_release_notes.pdf Mon Oct 26 15:00:54 MST 2009 - 1.1.0 - Initial release of Sakai. - The Sakai CLE is a free, community source, educational software platform distributed under the Educational Community License (a type of open source license). The Sakai CLE is used for teaching, research and collaboration. Systems of this type are also known as Course Management Systems (CMS), Learning Management Systems (LMS), or Virtual Learning Environments (VLE). - Complete release notes are available at the following URL: http://confluence.sakaiproject.org/confluence/display/DOC/Release+Notes+(2.5) - Allow at least five minutes between running backups on this JumpBox.