Creating a Windows Aptana IDE installer

From Aptana Development

This page describes the requirements of the Windows installer, and how to create one from the Aptana sources

Contents

Requirements

Installer

  1. User should be allowed to choose to install for "Just Me" or "All Users" which would impact where these configurations are stored.
  2. Aptana cannot be installed over itself, so a user must uninstall the old version before installing a new version, or encourage them to update:
    1. Aptana cannot be installed over itself. You must: 1) Uninstall the previous version, 2) Choose a new install location, or 3) Run Aptana, and choose "Update Aptana" from the Help menu.
  3. Place contents of zipped version of source into Program Files\Aptana
  4. Add "jre" folder at root of Aptana program files folder. This contains Sun JRE 1.4.2. This can be copied from an existing Aptana installation.
  5. Create Aptana Start Menu folder
    1. Add link to Aptana executable
    2. Add Link to Aptana website (http://www.aptana.com)
    3. Add Link to Aptana forums (http://www.aptana.com/forums)
  6. Add page allowing user to choose file associations for Aptana
    1. .js (default on)
    2. .sdoc (default on)
    3. .css (default on)
    4. .html (default on)
    5. .htm (default on)
    6. Internet Explorer View Source (default off)
  7. After install is finished, edit a configuration file
    1. Add RECENT_WORKSPACES=$prop.user.home$/aptana/workspace (replacing the var with wherever the user's home directory is) to file $USER_INSTALL_DIR$/configuration/.settings/org.eclipse.ui.ide.prefs
  8. See Windows Installer Registry Notes for more details
  9. Configure firewall. Open ports:
    1. 5370 "Jaxer"
    2. 5371 "Jaxer"
    3. 5374 "Jaxer"
    4. 5375 "Jaxer"
    5. 5376 "Jaxer"
    6. 5377 "Jaxer"
    7. 5378 "Jaxer"
    8. 5379 "Jaxer"
    9. 5380 "Jaxer"
    10. 5381 "Jaxer"
    11. 5382 "Jaxer"
    12. 5383 "Jaxer"
    13. 8081 "Apache"

Application Files

Windows 98/2000/XP

  • Application Files: Program Files/Aptana/Aptana Studio/
  • User Data: My Documents/Aptana Studio (workspace)
  • Application Data Roaming: Documents and Settings/Application Data/Aptana/Aptana Studio/ (We will assume roaming in general)
  • Application Data Non-Roaming: Documents and Settings/Local Settings/Application Data/Aptana/Aptana Studio/

That works out to:

  • osgi.instance.area.default=@user.home/My Documents/Aptana
  • osgi.configuration.area=@user.home/Application Data/Aptana/Aptana Studio/configuration
  • osgi.user.area=@user.home/Application Data/Aptana/Aptana Studio/user

Vista

Uninstaller

  1. User should be able to uninstall Aptana via Add/Remove Programs
  2. Installer should clean up Program Files directory, removing everything except user-created items

Enhancements

  • Allow user to select additional plugins to download during install. Perforce, sublclipse, radrails, etc. as part of download
  • Install JRE 1.6 on Vista machines instead of 1.4.2
  • Install/uninstall Firebug/Debugger extension

Building

  1. TBD

Testing

Install

  1. Aptana is installed to C:\Program Files\Aptana\Aptana IDE Beta (or equivalent)
  2. Shortcuts created (test for both admin and non-privileged user)
    1. Start Menu
      1. Link to website
      2. Shortcut to IDE
      3. Link to Forums
    2. Quick Launch Bar
      1. Shortcut to IDE
    3. Desktop
      1. Shortcut to IDE
  3. File associations created
    1. CSS
    2. SDOC
    3. HTML
    4. HTM
    5. JS
    6. "View source" in IE should open in Aptana
  4. On first run, Aptana will prompt for a workspace location.
    1. Win XP and below: C:\Documents and Settings\username\My Documents\Aptana IDE Beta
    2. Vista: C:\username\Documents\Aptana IDE Beta
  5. Attempt to install RadRails via the update manager. Ensure that this completes successfully.

Uninstall

  1. On uninstall, only user files should be left in Program Files\Aptana
    1. Should allow user the choice of deleting both those files and the settings in Applications

References

Notes

  • Follow the components rules: Dont mix user and machine specific entries in a single component. Ensure that only one .exe exists in each component. Ensure that components are UNIQUE i.e. dont have a .dll that exists in more than one component.
  • Use smoke.exe to check installer (from WiX 3.0 download)