=============================================================================== == General Documentation == =============================================================================== == 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 Virtual PC 2007 & Virtual Server 2005 R2 * Virtual Iron Version 4+ * Xen OpenSource 3.0+ in HVM mode (http://www.xen.org) * Up to 12GB Free disk space for growable disks. * Minimum 512MB RAM, 1GB 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 consistant application state in the backup. For users who have added large amounts of data to their JumpBoxes, our backup tool may be inadaquate. 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. == 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. == Running on VMware == 1. Download the JumpBox appliance to your computer 2. Extract the archive to a location that has adequate disk space 3. Open the JumpBox.vmx file with VMware 4. Boot the virtual machine 5. When the appliance is finished starting type the IP address it displays into a web browser. 6. Fill out the form and accept the license. 7. You can now access the appliance using the same IP address. * On Windows you can also access the appliance using the hostname you specify during setup * On Mac OS X you can also access the appliance using the .local name. == Running on VMware ESX == VMware Converter Method ----------------------- Without obtaining OVFs directly from JumpBox, VMware converter is probably the most convenient way of getting a JumpBox into any recent version of ESX or ESXi. Recent versions of VMware Converter should be able to import a JumpBox directly into any recent version of ESX. Use the following process: 1. Unzip your downloaded JumpBox of choice. 2. Start VMware Converter 3. Begin a Conversion 4. Select source type: "VMware Workstation ..." 5. Browse to find the JumpBox.vmx file unzipped in step 1 6. Choose your desired destination type and proceed 7. If you have directly imported to ESX, you should now be able to boot your JumpBox, if you have created and OVF, you may now import that. The two likely destination types are: * Virtual Appliance - Creates a reusable OVF/OVA that can then be loaded into ESX. * VMware Infrastructure virtual machine - Loads the JumpBox directly into the specified ESX server. For additional details, please see the "Converting Virtual Machines" section of the VMware Converter User's Guide that corresponds to the version you are using. Old Manual Method ----------------- This method was used prior to the availability of a free VMware Converter utility and is only provided here for reference. Try the Converter method first. This version of JumpBox comes with two VMware GSX-like disk images that need to be imported into your ESX server: disks/root/root.vmdk disks/data/data.vmdk ESX includes a command line tool, available on your ESX server's maintenance console, called vmkfstools. This tool can be used to import the JumpBox disk images into your ESX server file store. The process is described in http://kb.vmware.com/kb/900 at the bottom of the page where it mentions Importing GSX Server and Workstation Virtual Disks to ESX Server. For example vmkfstools -i /mnt/otrs-0.9.2/disks/root/root.vmdk vmhba0:0:0:1:root.dsk vmkfstools -i /mnt/otrs-0.9.2/disks/data/data.vmdk vmhba0:0:0:1:data.dsk The exact command will depend on your the location of your unzipped JumpBox and ESX filestore options. Once the disk files are imported, you can create a new virtual machine using those disk images. Ensure that you allocate at least 256MB of RAM and add a network card. It may also be possible for you to navigate to the JumpBox.vmx file that came with your JumpBox and right click on it and choose "Add to Inventory" You should now be able to start your JumpBox. == Running on Parallels == 1. Download the appliance to your computer 2. Extract the archive to a location that has adequate disk space 3. Open the JumpBox.pvs file with Parallels 4. Boot the virtual machine by clicking the green arrow 5. When the JumpBox is finished starting, type the IP address it displays into a web browser. 6. Fill out the setup form and accept the license. 7. You can now access the JumpBox with your web browser using the same IP address. * On Windows you can also access the appliance using the hostname you specify during setup * On Mac OS X you can also access the appliance using the .local name. == Running on Microsoft Virtual PC == 1. Download the appliance to your computer 2. Extract the archive to a location that has adequate disk space 3. Open the "Application JumpBox.vmc" file with Virtual PC (double clicking on the configuration file should work) 4. When the JumpBox is finished starting, type the IP address it displays into a web browser. 5. Fill out the setup form and accept the license. 6. You can now access your JumpBox with your web browser using the same IP address. == Running on Microsoft Virtual Server == Starting the JumpBox in Virtual Server is a little more difficult than in Virtual PC. Fortunately, Virtual Server can read the same configuration file mentioned above. Just do the following: 1. Unzip your JumpBox. 2. Connect to the Virtual Server management console with Internet Explorer. 3. Click on Add under Virtual Machines on the left hand side. 4. Enter the full path to the configuration file in the "Fully qualified path to file" box (the path should look something like: C:\Documents and Settings\admin\Desktop\otrs-0.9.1\otrs JumpBox.vmc). Then click the Add button. 5. Now, you need to connect the Virtual Network Adapter to a real Network adapter. Do so by scrolling down to the Network Adapters section and clicking on the Network Adapters link, choose the Network Interface you want your JumpBox to use then click on the OK button. 6. You should be ready to go! Scroll back to the top of the JumpBox Status page and click on the thumbnail to start it up. == Running on Xen == The JumpBox requires the OpenSource version of Xen 3.0 or greater running in HVM mode. You should read the notes in the top part of the JumpBox.xen configuration file. You will probably want to enable the VNC console and set a new password. Under some circumstances you may have to enter custom paths to the hvm kernel and device files. This was confirmed to work with the default Xen installation on RedHat's Fedora 8. To start the JumpBox change into the JumpBox directory and issue the following command: sudo xm create -c JumpBox.xen If you have enabled the VNC console you can use a VNC viewer to see the boot screen and the JumpBox console message. Use the screen you specified in the config file or the DOMID for the JumpBox as shown by 'xm list'. On linux, the following command works (if you have vncviewer installed): vncviewer HOSTNAME:DOMID HOSTNAME is the name or IP address of the Xen Host and not the JumpBox. Example: vncviewer 192.168.1.101:1 == Running on Virtual Iron == The general procedure for JumpBox installation on Virtual Iron is outlined below. A working knowledge of Virtual Iron's Virtualization Manager is assumed. These instructions have only been tested on Virtual Iron Single Server Edition 4.04 but are likely to be similar on other Virtual Iron products 1. Unzip the JumpBox distribution, and note the location of the resulting files. 2. Login to the Virtualization Manager. 3. Select an appropriate disk group, or create a new one, where the JumpBox virtual disks will be stored. 4. Click "Import." In the file dialog box, navigate to the directory where the JumpBox files (JumpBox.vmx etc.) are located. There will be a subdirectory named "disks"; enter it. 5. There will be a subdirectory named "root"; Enter it. No files will appear in the dialog box. Instead, in the "File Name" textbox, enter "root.hdd" (without quotes) and click "Import." 6. The import should proceed normally. Once it is complete, click "Import." 7. Enter the "disks" and then the "data" directory. 8. Click the "data.vhd" entry, and click "Import." The import should complete normally. 9. Create a new "basic" Virtual Server, then edit its configuration. 10. Choose "Other Linux" for "Operating System." 11. Select the "Storage" tab. Assign the two imported drives to the virtual server. If necessary, use the "Move Up" button to ensure that "root.hdd" is the first (boot) drive. 12. Select the Networks tab, and configure networking appropriately. You must configure at least one ethernet interface. 13. Launch a virtual server console for this Virtual Server. The JumpBox console screen will display, showing the IP address. From this point, you should be able to operate the JumpBox as for other virtualization environments. == 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.1 == =============================================================================== Release 1.1-240 Notable Changes ------------------------------- - A bug that prevented direct download backups from working for larger backups has been fixed. A manual work around is available for users encountering this bug, please email support@jumpbox.com for details. Release 1.1-239 Notable Changes ------------------------------- - Ubuntu Updates have been applied including everything up to USN-830-1. This includes an important update to openssl that effects client usage of SSL. - Changes to the JumpBox Administration Portal - It is now possible to disable mail relay hosts for both postfix and sendmail based JumpBoxes. - Several issues were resolved with the Webalizer based web stat cron job. Release 1.1-236 Notable Changes ------------------------------- - Ubuntu Updates have been applied including everything up to USN-819-1. - The Samba daemon is now disabled on startup. - Enhancements to the JumpBox "Public Address" functionality. /etc/hosts and the mailserver will now be aware of public address if FQDN is used. Release 1.1-222 Notable Changes ------------------------------- - A bug that occured when initially choosing a backup frequency of 'never' has been resolved. - Upstream Ubuntu packages are updated to early May 2009. Release 1.1-219 Notable Changes ------------------------------- - A bug in the user.yml custom backup feature has been corrected. - Upstream Ubuntu packages and gems should be updated to April 2009. - The admin user account is now enabled at setup time rather than when SSH is enabled. Release 1.1-205 Notable Changes ------------------------------- - A bug that effected custom SSL Certifcate was fixed. - A bug that prevented the backups from properly failing when mounting the backup mount has been resolved. - Unattended backups have been modified to email the JumpBox Administrator email address in the event of a problem while running the backup. The email is also stored locally in the admin users mail spool just in case outbound email from the JumpBox cannot be delivered. - When SSL is enabled the application will now only be available over SSL. This resolves some issues with some applications behaving strangely under SSL. - Many updates to upstream packages have been applied. Release 1.1-194 Notable Changes ------------------------------- - Updated some upstream packages. Release 1.1-192 Notable Changes ------------------------------- - A unique SSL certificate for the JumpBox Administration Portal is generated on initial boot. The expiration date of the self signed certificate is 10 years from initial boot. - An issue that complicated moving the JumpBox to a new directory with VMware has been resolved. Portability is still complicated by snapshots and suspends. Consider trying the JumpBox backup and restore tools where possible. Release 1.1-188 Notable Changes ------------------------------- - The initial JumpBox Configuration process is no longer encrypted. After the setup process, however, the admin portal will still be encrypted. Your browser may show a warning or error when you try to access it. It is ok to accept the certificate. For details, see: http://www.jumpbox.com/faq/sslwarning Release 1.1-167 Notable Changes ------------------------------- - A long standing bug where backup validation failed if the configured backup server was inaccessible has been fixed. Release 1.1 Notable Changes --------------------------- - This is now a Production release. - A bug in direct upload restore on Windows was resolved. - Several bugs that caused problems in Internet Explorer 6 and 7 were resolved. - A bug handling Samba paths for backup and restore was resolved. - After setup, the Application is now properly advertised via Bonjour/mDNS. - Mail server now only listening on localhost. - User customizable backups added. See "General Documentation" section. Release 1.1B5 Beta Notable Changes ---------------------------------- - *** THIS IS A BETA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE MADNESS!!! *** - A serious upstream OpenSSL/OpenSSH related bug has been resolved. - A bug that prevented the JumpBox from booting on Microsoft VirtualPC has resolved. Release 1.1B4 Beta Notable Changes ---------------------------------- - *** THIS IS A BETA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE MADNESS!!! *** - The JumpBox platform has been updated to Ubuntu Base 8.04 LTS. - We resolved a bug that prevented scheduled backups from running. - The Restore list will now only show backups that the specific JumpBox version can restore from. Release 1.1B3 Beta Notable Changes ---------------------------------- - *** THIS IS A BETA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE MADNESS!!! *** - A bug that prevented JumpBox setup under certain circumstances has been resolved. - There is a known bug that breaks the JumpBox Navigation Bar link from the Application to the JumpBox Administration page if your IP address changes either via DHCP or manually. You can access the JumpBox Admin Portal by typing a URL like: https://IPADDRESS:3000/ A fix has been implemented and is currently being tested. - There is also a known bug involving the backup and restore of the Webalizer web statistics feature. The backup/restore of Webalizer data it not yet functioning. We are working on a fix. Release 1.1B2 Beta Notable Changes ---------------------------------- - *** THIS IS A BETA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE MADNESS!!! *** - Many "behind the scenes" changes have been made to the JumpBox Administration Application. Hopefully you never notice a difference. Release 1.1B1 Beta Notable Changes ---------------------------------- - *** THIS IS A BETA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE MADNESS!!! *** - There are many new features added to the JumpBox platform including: - The ability to set an Mail (SMTP) Relay Host. - The ability to recover a lost admin password over email. - Backup to Amazon's S3 service is now available - The ability to restore from another running JumpBox. Hey, Look here, read what is says. It is REALLY cool! - The Application can now be configured to be accessed over SSL, either with a unique self signed certificate or with a commercially purchased certificate. - We have incorporated Webalizer based Web Statistics for your JumpBox Application. - The ability for the Aministrator to put the Application in Maintenance Mode. - Many other behind the scenes improvements have been made. Release 1.1A1 Alpha Notable Changes ----------------------------------- - *** THIS IS AN ALPHA RELEASE, EVALUATION USE ONLY, ANYTHING ELSE *** *** WOULD BE SHEER MADNESS!!! *** - A new One Time backup option has been added, Direct Download backup. - Many "behind the scenes" changes have been made to the JumpBox Administration Application. Hopefully you never notice a difference. Release 1.0.3 Beta Notable Changes ---------------------------------- - The disks on the JumpBox have been restructured. A larger (10GB) growable data disk has been added for VMware, Parallels and Virtual PC/Virtual Iron. Xen users will experience trouble with this release due to this change. Release 1.0.2 Notable Changes ----------------------------- - Changes have been made to the JumpBox Navigation Bar URLs to make putting the JumpBox behind a web proxy easier. - The JumpBox disk files have been changed so that they now work with Microsoft Virtual PC and Virtual Server products as well as Virtual Iron. Release 1.0.1 Notable Changes ----------------------------- - DHCP is no longer required. The JumpBox console is now an interactive text application that allows you to set a static IP for your JumpBox. - Fixed a bug that failed to properly test write permissions on a backup volume thus improving the robustness of the backup mechanism. - Apache logs will be saved for 4 weeks rather than 52 weeks. Release 1.0 Notable Changes --------------------------- - Registration no longer requires an internet connection. - Bonjour/Avahi fixes to make JumpBox visible by Bonjour. - Fixed saved backup bug so it will save the specified number of backups. - Changes to Backup/Restore system should make restores possible from more old versions. Known Issues ------------ - IE 6 Setup Hang issue. We have seen a few instances of MS Internet Explorer 6 hanging on initial setup. When you first access a JumpBox at http://IPADDRESS/ you are redirected to the Administration Interface at https://IPADDRESS:3000/ to begin configuration. Under certain circumstances IE will fail to do this redirect. You can work around this by typing https://IPADDRESS:3000/ into the URL bar. - Direct Restore Safari Issue. There is an issue when trying to do direct upload restores to the JumpBox using the Safari web browser. This occurs when trying to upload larger backups that take more than two minutes to upload. The solution is to use an alternative web browser, like Firefox, to perform the restore. This is a limitation in the Safari browser. - General limitations on the direct download backup mechanism - Each application will have different size limitations with the direct download backup mechanism. A good general rule of thumb is that the direct download backup mechanism will only work if no more than 33% of the /storage partition (as shown on the JumpBox Administration Portal Info Page) is in use. Other backup mechanisms should continue to function properly beyond that. - There are no other known issues at this point. If you encounter any trouble please visit our forums (http://www.jumpbox.com/support/). To keep up to date with the latest JumpBox news you can subscribe to our blog: http://www.jumpbox.com/blog. =============================================================================== == Tracks Release Notes == =============================================================================== Tue Aug 10 12:36:30 MST 2010 - 1.1.5 - This is a maintenance release. The included version of the application has not changed. Tue Apr 20 17:02:46 MST 2010 - 1.1.4 - Tracks has been updated to version 1.7.1. - This is a minor improvement release. - It should be possible to restore from backups created by any prior version of the JumpBox for Tracks. - Complete release notes are available at the following URL: http://www.getontracks.org/downloads/comments/tracks-1.7.1/ Mon Feb 15 16:19:37 MST 2010 - 1.1.3 - This is a maintenance release. The included version of the application has not changed. Mon Aug 31 14:44:49 MST 2009 - 1.1.2 - This is a maintenance release. The included version of the application has not changed. Mon Jul 27 22:52:33 MST 2009 - 1.1.1 - This is a maintenance release. The included version of the application has not changed. Mon Mar 16 13:25:43 MST 2009 - 1.1.0 - Initial public release of Tracks 1.7 - Tracks is a web-based application to help you implement David Allen’s Getting Things Done methodology. - Release notes are available at the following URL: http://www.getontracks.org/downloads/comments/tracks-1.7/