Otter Documentation

Configuration Files

  • Last Modified: 2019-02-14

Starting with Otter 2.0.9, Otter uses a common configuration file path for its web and service components. Previously, the information stored in this file was duplicated in the Web.config and the Otter.Service.exe.config files.

Configuration File Location

Otter looks for its configuration file at: %PROGRAMDATA%\Inedo\SharedConfig\Otter.config. On most systems, this will resolve to C:\ProgramData\Inedo\SharedConfig\Otter.config.

Configuration File Format

The Otter configuration file is a simple XML format:

  <ConnectionString>[SQL Server database connection string]</ConnectionString>
  <EncryptionKey>[32-character hex key for stored secrets]</EncryptionKey>
  <WebServer Enabled="[true/false]" Urls="[web server listen URLs]" />

The ConnectionString element contains the SQL connection string used by Otter.

The EncryptionKey element is optional and if specified, will be used to encrypt stored credentials for remote resources.

The WebServer element controls the integrated web server. If you are using IIS, the Enabled attribute should be set to false. If Enabled is set to true, then the Urls attribute should contain URLs to listen to (for example http://my.local.otter:80/;http://localhost:1000/).

Legacy Configuration

Previous versions of Otter stored the connection string and encryption key in Web.config and Otter.Service.exe.config. These values can still be defined in these files for compatibility purposes, and if present will override what is specified in the "shared" config file.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.