The following outlines the typical installation process, including potential issues and their workarounds.

What to Expect

The full list of actions taken during the installation of Manuscript On Premises is described in our process overview document. Importantly, depending on the configuration of your web server, the installation may require one or more restarts, so please consider the effect on existing services when planning. If you are installing Manuscript On Premises on your current FogBugz server, please note that installations of FogBugz For Your Server and Manuscript On Premises cannot coexist.

Before starting the installation, please make sure all the points on the pre-installation checklist have been addressed. You’ll also need the installation ISO, which you can obtain by contacting us.

Installing

  1. Mount the Manuscript On Premises ISO or insert a physical copy of the image.
  2. From a PowerShell prompt Run as Administrator, navigate to the root directory of the mounted ISO (i.e. D:>), run SetupWizard.ps1 and follow the prompts. You’ll be asked for several configuration parameters.
    • If you are installing an additional site alongside an existing Manuscript On Premises installation, you’ll want to select the option to “Add another site to an existing Manuscript On Premises Installation” at the first prompt when running SetupWizard.ps1
    • During this process, please double-check your settings. Don’t let a typo ruin your day 🙂
  3. Restart the machine or PowerShell prompt as advised, and re-run SetupWizard.ps1 (choose to resume your setup operation).
  4. Once the SetupWizard completes, the password reset URL will be launched in the default browser. For a new installation, this will allow you to set the password for the Administrator account created during the installation.
  5. Log into Manuscript On Premises using the administrator email address configured in SetupWizard.ps1
  6. Ensure there are no admin notifications under the Gear Menu.

Upgrading from FogBugz For Your Server? Once the installation is successful, you can import your data into On Premises.

Upgrading

  1. Mount the Manuscript On Premises ISO or insert a physical copy of the image.
  2. From a PowerShell prompt Run as Administrator, navigate to the root directory of the mounted ISO (i.e. D:>), run SetupWizard.ps1 and follow the prompts. Make sure you choose to upgrade your existing installation of Manuscript rather than install a new one.
  3. Restart the machine or PowerShell prompt as advised, and re-run SetupWizard.ps1 (choose to resume your setup operation).

Potential Issues and Resolutions

Depending on the configuration of your server, you may experience unexpected failures during the SetupWizard. If re-running the wizard does not fix the error or the error does not have a known resolution, below, please contact us for help.

  • If SetupWizard.ps1 does not believe that your domain user is a Local Admin, please grant that user explicit Local Admin privileges as opposed to through a group/role.
  • If HeartbeatPinger will not install:
    1. Remove the heartbeatpinger folder from <Your Installation Directory>installed-components
    2. Re-run SetupWizard.ps1 (you should be able to resume the previous install)
  • If SetupWizard.ps1 repeatedly asks you to restart the PowerShell console after the installation of JDK:
    1. Manually install JDK using <ISO>/autosetup/resources/jdk-7u80-windows-x64.exe
    2. re-run SetupWizard.ps1.
  • If you see an error related to“Could not retrieve fact FQDN”, this may mean that your machine is not on a domain and you are experiencing an error in Puppet. This is fixed in a later version of Puppet. In the meantime:
    1. set a primary DNS suffix that matches the Manuscript URL (less the host) under System > Advanced system settings > computer name > Change… > More…
  • If a password reset URL isn’t automatically launched:
    1. Select a reset code from the PasswordResetCode table in the trial1 database
      SELECT * FROM PasswordResetCode
    2. visit the password reset URL yourself in the case sensitive format
      {Manuscript URL}/?RP{ixPerson}X{PasswordResetCode}
  • The configured Manuscript On Premises websites in IIS bind on *:80 and will automatically stop the Default Web Site. If you run another website on Default Web Site, you may need to introduce more specific bindings to the Manuscript On Premises websites in IIS, the Default Web Site, or both. Please note that Heartbeat Pinger uses localhost:80, which must be bound to FB GEN ALL. If you have further questions about this, please don’t hesitate to contact us.
  • Manuscript On Premises currently ships with Java 7, which does not support TLS 1.1 or TLS 1.2. If you are installing Manuscript behind an existing SSL-terminating load balancer, you must make sure that TLS 1.0 is supported. It is possible to upgrade Java after the fact, and for more details, please contact us.