Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
137 lines (85 sloc) 7.47 KB

title: Otter Installation Guide keywords: otter sequence: 100

<style> .documentation-content-wrapper .upcoming { background-color: #fff; position: relative; } .screenshot { opacity: .4; } .documentation-content-wrapper .upcoming.buildmaster::before { content: ' -- Placeholder screenshot from BuildMaster -- '; background-color: #f15a24; } .documentation-content-wrapper .upcoming::before { z-index: 1; width: 100%; background-color: #3fa9f5; padding: 2px 4px; color: white; content: ' -- Placeholder screenshot from ProGet -- '; text-align: center; } </style>

Getting Otter up-and-running takes just a few minutes: just download and run the installer. This guide will provide step-by-step instructions, as well provide some detail as to what's happening behind the scenes.

1. Pre-Installation Check List {#pre-install}

Otter doesn't have any intense server requirements, and supports all modern version of Windows that Microsoft supports (see Windows lifecycle fact sheet). The recommended requirements are:

{.docs}

  • Minimum – 2 Core CPU, 2 GB RAM, 1 GB for storage
  • Recommended Average/Typical – 2 Core CPU, 4 GB RAM, 10 GB storage
  • Recommended Large – 4 Core CPU, 8 GB, 16 GB Storage

Before installing, consider the following:

{.docs}

  • .NET Framework 4.5.2 – Otter requires .NET 4.5.2, and Windows will prompt about this if you don't already have it
  • Web Server – Otter has its own web server, but can also be hosted in Microsoft IIS as well; if you want to use IIS, make sure it's installed & configured first)
  • Database Server – Otter does require Microsoft SQL Server, but the Otter installer can install SQL Express
  • Firewall (Inbound) – Otter is a web application and can be installed on the port of your choosing

2. Download Otter {#download}

You can download the installer from inedo.com.

3. Verify the Installer {#verify}

We always sign our installer packages. This signature can be seen when you run the installer and get a security warning, or right-click on the file for Properties and then look at Digital Signatures.

We've never had any issues with compromised installers (it's hosted on Amazon S3, which is quite reliable), but it doesn't hurt to make sure the signature is there. See KB#1113: Anti-malware False Positives, Code Signing, and Safety of Inedo Products for more information.

4. Run the Installer {#run}

The installer requires administrative privileges to run and will attempt to escalate. It will then unpack the temporary files and begin installation verification.

5. License Agreement {#license-agreement}

Take a quick read of our Otter license agreement. Really, it's quick!

Otter License agreement

6. Edition / License Key {#edition-key}

After accepting the license agreement, select the edition of Otter you'd like to use (Free, Enterprise Trial, or Enter Key).

Otter Edition License Key

7. License Registration {#registration}

After selecting the edition, just enter your name and email. The installer will try to get this from the currently logged in user. We promise to not fill your inbox with pictures of Otters Who Look Like Benedict Cumberbatch{target="_blank"}

Otter License Registration

8. Target Directory {#directory}

Deploy to your favorite location, or just stick with the default of Program Files.

Otter Target Directory

9. Database Configuration {#database-configuration}

If you ran the installer with the embedded SQL Express, then you'll be able to select the option to install SQL Express.

Otter Database Configuration

Otherwise, you'll need to point to an existing server using a standard SQL Connection string. Note that if no database is specified in the connection string (which is the default), a database named ProGet will be created.

10. Web Server Configuration {#web-server-configuration}

By default, the installer will configure Otter to use its own web server.  This is the easiest to start with, and you can always switch to IIS hosting later.

Otter Web Server Configuration

If IIS is installed on the server, you will have the option of installing Otter in IIS. This will create an application pool and website in the local IIS configuration.

11. User Account {#user-account}

By default, the installer will use the NetworkService account to run the Otter Service and Web Application. We recommend sticking with this, and changing the account later if you need to.

Otter User Account

12. Summary {#summary}

Make sure everything here looks OK, and then click Install.

Otter Installation Summary

If any of the items indicate an error, you can click on it to go back to that page and fix it.

13. Patiently Wait

If you chose to have SQL Server Express installed, then the actual installation process will take a little while. On embarrassingly low-end servers (e.g. Intel Celeron processor and 256MB of RAM), we've seen this take as long as fifteen minutes.

Otter Patiently Wait

While you wait, you can always peruse Otters Who Look Like Benedict Cumberbatch{target="_blank"}.

Clicking cancel (especially during the SQL Express installation) is not advised, as you may have to manually remove some bits of SQL Server using Add/Remove programs. Once everything's done, you'll be ready to start using Otter. {.announcement}

14. All Done

Click the absurdly large Launch Otter button, and your web browser will start up with http://localhost:&laquo;port-you-chose&raquo;/.

Note that on slower systems, the services take a little bit to spin up, so if you see a blank page, just refresh the page until it loads.

Once Otter loads, we suggest going through the Getting Started with Otter tutorial.

You can’t perform that action at this time.