Configuration

The Ruby SDK is configured by setting attributes on the Files object.

Configuration Options

Base URL

Set this to the full https:// URL of your Files.com subdomain (e.g. https://MY-SUBDOMAIN.files.com). This is not required in most cases, but one benefit of setting it is that it ensures that authentication failures will be logged to your site's API logs. Without setting this, we won't know which site to associate the authentication failure with, and it won't be logged to your site's API logs. This is always required if your site is configured to disable global acceleration. This can also be set to use a mock server in development or CI.

Example setting

Files.base_url = "https://SUBDOMAIN.files.com"

Log Level

Supported values:

  • nil
  • "info"
  • "debug"

Example setting

Files.log_level = 'info'

Proxy

Proxy configuration in Faraday format.

Example setting

Files.proxy = {
  uri: 'https://proxy.example.com',
  user: 'proxy_me',
  password: 'my_password',
}

Open Timeout

Open timeout in seconds. The default value is 30.

Example setting

Files.open_timeout = 60

Read Timeout

Read timeout in seconds. The default value is 60.

Example setting

Files.read_timeout = 90

Initial Network Retry Delay

Initial retry delay in seconds. The default value is 0.5.

Example setting

Files.initial_network_retry_delay = 1

Maximum Retry Delay

Maximum network retry delay in seconds. The default value is 2.

Example setting

Files.max_network_retry_delay = 5

Maximum Network Retries

Maximum number of retries. The default value is 3.

Example setting

Files.max_network_retries = 5