View source for Proxy Support

On some computer networks, you might need a [[wikipedia:Proxy_server|Proxy Server]] to access the internet.

In these cases, you'll need to do some additional setup to make Resonite work with your Proxy Server. You can follow this page to get that setup.

== Creating a Startup Config File ==
Proxy support is configured via a [[Startup Config File]]. So if you don't have one of those, create it in the same folder as Resonite's main executable (Resonite.exe).

By default, the config file should be named <code>Config.json</code>.

== Adding the Proxy Configuration Section ==
Within the Config.json file. You'll need to add the following:
<code>
{
    "proxy": {

    }
}
</code>

== Proxy Configuration Options ==

The <code>Proxy</code> section, contains your proxy configuration. Depending on your setup, you'll need a number of properties:
{| class="wikitable"
! Property !! Description !! Example
|-
| autoDetect || Set this to true, to tell Resonite to try and automatically detect the proxy configuration. || <code>true</code>
|-
| address || Allows you to specify the web address where Resonite can find your Proxy. Include the Url and Port || <code>http://127.0.0.1:8080</code>
|-
| localBypass || When set to true, will bypass the Proxy for local domains such as localhost, 127.0.0.1 || <code>true</code>
|-
| credentialStore || The Credential mode for the proxy. There are a number of options. || See [[#Authentication]] </code>
|-
| username || Username for the proxy, only used when credentialStore is set to "UsernamePassword" || See [[#Authentication]] </code>
|-
| password || Password for the proxy, only used when credentialStore is set to "UsernamePassword" || See [[#Authentication]] </code>
|}

=== Authentication ===
To setup authentication you need to configure the <code>credentialStore</code> property to an appropriate value for your authentication needs, pick one of the following values:
* <code>"UsernamePassword"</code> - Allows you to manually specify a Username and Password for the proxy, specify the username and password with the username and password properties that are described above.
* <code>"NetworkCache"</code> - Retrieves the credentials from the NetworkCache. ''TODO: Prime has no idea what the NetworkCache is.'''
* <code>"Kerberos"</code> - Retrieves the credentials from Kerberos. ''TODO: Prime has no idea what kerberos is.'''
* <code>"DefaultSystemCache"</code> - Retrieves the credentials from the Default System Cache.


== Examples ==
=== A basic proxy ===
<code>
{
    "proxy": {
        "address": "http://127.0.0.1:8080"
    }
}
</code>

=== A basic proxy, with Username and Password Authentication ===
<code>
{
    "proxy": {
        "address": "http://127.0.0.1:8080",
        "credentialStore": "UsernamePassword",
        "username": "ProbablePrime",
        "password": "Cheese"
    }
}
</code>