Overview
Before installing FogBugz On-Premises, you will need to do additional configurations to your server(s) and users to ensure all prerequisite server features are enabled and configured, and required service users have been created, enabled, and configured.
Prerequisites
- Your hardware configuration meets the System Requirements for FogBugz On-Premises.
- You have the latest FogBugz On-Premises ISO. Contact the Support Team if you don't have it. Your current license needs to be checked before we provide you the latest ISO.
- A Microsoft SQL Server is available and accessible to host FogBugz SQL Database. The installer does NOT install Microsoft SQL Server.
Information
Parameters Required During Install
During the install process, the install script will require some parameters. Please have them prepared beforehand.
- Installation Directory: The location on the disk where FogBugz On-Premises will be installed.
- Service Username: The username for the user under which your FogBugz On-Premises application pools will run. This user needs to be a Local Administrator. This is the same user that will be used to connect to the SQL Server if Windows Authentication is used.
- If using a domain account the Windows account used for FogBugz installation must have the following permissions:
- Adjust memory quotas for a process.
- Allow log on locally.
- Log on as a batch job.
- Replace a process-level token.
Please note that on Windows, deny permissions override allow permissions, and as such you'll need to make sure the account used is also not in any group that denies any of these permissions.
- If using a domain account the Windows account used for FogBugz installation must have the following permissions:
- Service Password: The password for the user under which your FogBugz On-Premises application pools will run.
- SQL Server Instance: The SQL Server instance where your FogBugz On-Premises databases will be hosted.
- SQL Server Username: (Optional) If using SQL authentication, the username for the SQL authentication account which will be used to create and access your FogBugz On-Premises databases.
- SQL Server Password: (Optional) If using SQL authentication, the password for the SQL authentication account which will be used to create and access your FogBugz On-Premises databases.
- Fully Qualified Domain Name (FQDN): The FQDN where you plan to access FogBugz (e.g. fogbugz.yourdomain.com).
- Administrator Email: The email address for the initial site administrator account created during your FogBugz On-Premises installation.
- SMTP Server: (Optional) The host for the SMTP server where FogBugz will use to send emails.
- SMTP Port: (Optional) The port over which FogBugz will connect to your SMTP server.
- SMTP User: (Optional) The SMTP user FogBugz will use to access your SMTP server.
- SMTP Password: (Optional) The password for the SMTP user.
- SMTP SSL: (Optional) Whether or not FogBugz should use SSL when connecting to your SMTP server.
Environment Settings
The following server features need to be enabled and configured
- Ensure the Web Server (IIS) Role is enabled on the server where the FogBugz On-Premises will be installed.
- In Windows Server 2012/2016, this can be installed with Add Roles & Features.
- Ensure .NET 3.5 is installed on the server where the FogBugz On-Premises will be installed.
- In Windows Server 2012/2016, this can be installed with Add Roles & Features.
- Ensure the PowerShell execution policy has been set to
RemoteSigned
orUnrestricted
on the server where the FogBugz On-Premises will be installed.
- Command
Get-ExecutionPolicy
returns your current policy. - The policy can be changed using the following command (case sensitive):
Set-ExecutionPolicy RemoteSigned
- This is required to run the FogBugz On-Premises installation PowerShell script and can be reversed once the installation is complete.
- Command
- Configure FQDN for Fogbugz On-Premises
- Your FogBugz On-Premises FQDN consists of a Site Identifier and a Host in the form of
http://{site identifier}.{host}
- This FQDN must be configured on your DNS server to resolve to your FogBugz On Premises web server. Example FQDNs that fit this pattern are:
fogbugz.yourdomain.com
fogbugz.yourserver
- Additionally:
localhost:80
must be bound to your FogBugz On-Premises web site in IIS on your FogBugz On Premises web server.
- For development environments or environments where the production DNS server is not accessible, you can use the Windows hosts file
C:\Windows\System32\Drivers\etc\hosts
to override the default DNS settings, by adding a new entry at the end of the file. For example:127.0.0.1 fogbugz.yourdomain.com
to configure it on a local development environment.
- Your FogBugz On-Premises FQDN consists of a Site Identifier and a Host in the form of
Service and User Accounts
- The Windows account executing the install script needs to be Local Administrator on the given server (start the PowerShell prompt with Run as Administrator).
- IMPORTANT! Create a Windows Local Administrator account (e.g., fogbugz-onprem) under which the FogBugz On-Premises application pools will run.
- Please have the credentials for this account available at the time of installation.
- Authentication for the database access in FogBugz On-Premise
- If you plan to use Windows Authentication, please grant access to this Windows account on your target SQL server instance.
- If you plan to use SQL Authentication, please create a SQL user (e.g., fogbugz-onprem) on the target SQL Server instance.
- In both cases, the account must be granted the
dbcreator
role. Account permission can be reduced todb_owner
on your FogBugz On-Premises databases once the installation is complete. - If, after the installation, you need to reduce the role of the database user from
db_owner
to even lesser access levels likedb_datareader
anddb_datawriter
roles (for ex. due to security policy), it should not have any negative impact as long as it is ensured that the FogBugz application (user account) has the right toINSERT
,UPDATE
andDELETE
records in the database.
NOTE: Bothdb_datareader
anddb_datawriter
roles are must-haves. - Please have the credentials for this account available at the time of installation.
Common Errors and How to Avoid Them
- Error: 'Paths are missing or misconfigured.' While Installing FogBugz
- FogBugz Installation Error: "Unexpected Puppet exit code=1"
Note: For information on how to avoid these errors, please refer to the linked articles.
FogBugz For Your Server (FBYS) Customers
Migrate your data
If you are a FogBugz For Your Server (FBYS) customer, follow these directions to migrate your data. We recommend scheduling the installation and the migration for separate days to minimize downtime.
Exporting Database Schema
When you are upgrading from a previous version like FogBugz For Your Server (FBYS) with the help of the FogBugz team, you might be requested to send us a bare schema export of your current FBYS database.
- It is needed to prepare a script that will correct any schema drift, which may have occurred with your FogBugz For Your Server database over time.
- This schema export must include index creation. To generate this export from SQL Server Management Studio:
- Right-click on your FogBugz database and select Tasks > Generate Scripts.
- Under Choose Objects, select Tables (which will select all Tables) and click the Next button.
- Under Set Scripting Options, click the Advanced button.
- Ensure the Script Indexes option is set to
True
. - Save the database schema to a .sql file with a Unicode text.
- Send us this .sql file (only if requested).
- Right-click on your FogBugz database and select Tasks > Generate Scripts.