Sleet client settings

March 7, 2026 · View on GitHub

sleet.json

The standard way of setting up feeds is with a sleet.json file.

To get started use the createconfig command to generate a sample sleet.json file.

sleet createconfig --azure

The example file contains a set of sources. If only feed exists in the file sleet will automatically use it. Once there two or more sources the --source parameter will be required to select the correct source.

.netconfig

Additionally, Sleet supports configuration via .netconfig which provides a uniform way of configuring multiple tools with a single file and format. In addition, using .netconfig brings support for hierarchical configurations (i.e. reuse source configurations across the entire machine, with a single .netconfig in your user profile root directory).

Source properties

Property	Description
name	Feed name used for `--source` [Required]
type	Feed type [Required]
baseURI	Specify a URI to write to the feed json files instead of the container's URI. Useful if serving up the content from a different endpoint.

Azure specific properties

By default, the sleet will use the credentials types specified by DefaultAzureCredential. If you need to use a service principal credential type, set the AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_CERTIFICATE_PATH environment variables for the EnvironmentalCredential. More options can be found in the Azure.Identity README.

Property	Description
container	Name of an existing container in the storage account. [Required]
connectionString	Azure storage connection string. Note, either connectionString or path must be specified. [Discouraged]
path	Full URI of the azure storage container. If specified this value will be verified against the container's URI. Note, either connectionString or path must be specified. [Encouraged].
feedSubPath	Provides a sub directory path within the container where the feed should be added. This allows for multiple feeds within a single container.

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "azure",
      "container": "feed",
      "path": "https://yourStorageAccount.blob.core.windows.net/feed"
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = azure
    container = feed
    path = https://yourStorageAccount.blob.core.windows.net/feed/

Amazon s3 specific properties

Property	Description
profileName	AWS credentials file profile name. [Cannot be used with accessKeyId or secretAccessKey]
accessKeyId	Access key id [Cannot be used with profileName]
secretAccessKey	Secret access key [Cannot be used with profileName]
bucketName	S3 bucket name [Required]
region	S3 region [Cannot be used with serviceURL]
serviceURL	S3 service URL [Cannot be used with region]
path	Full URI of the storage bucket. If not specified a default URI will be used.
feedSubPath	Provides a sub directory path within the bucket where the feed should be added. This allows for multiple feeds within a single bucket.
serverSideEncryptionMethod	The encryption to use for uploaded objects. Only `AES256` and `None` are currently supported. Default is `None`
compress	Compress JSON files with GZIP before uploading. Default is true
acl	A acl can be set for uploaded files. By default, no specific canned acl is set and bucket defaults and/or policies are in effect. If the bucket is created by sleet and an acl is set, then the default bucket acl will be set to that acl.
disablePayloadSigning	S3 payload signing is a requirement of AWS SigV4, some S3 compatible storage providers do not implement this. Default is `false`

Either region or serviceURL should be specified but not both.

Using an AWS credentials file

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "s3",
      "path": "https://s3.amazonaws.com/my-bucket-feed/",
      "profileName": "sleetProfile",
      "bucketName": "my-bucket-feed",
      "region": "us-west-2"
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = s3
    path = https://s3.amazonaws.com/my-bucket-feed/
    profileName = sleetProfile
    bucketName = my-bucket-feed
    region = us-west-2

Using accessKeyId and secretAccessKey in sleet.json

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "s3",
      "path": "https://s3.amazonaws.com/my-bucket-feed/",
      "bucketName": "my-bucket-feed",
      "region": "us-east-1",
      "accessKeyId": "IAM_ACCESS_KEY_ID",
      "secretAccessKey": "IAM_SECRET_ACCESS_KEY"
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = s3
    path = https://s3.amazonaws.com/my-bucket-feed/
    bucketName = my-bucket-feed
    region = us-west-2
    accessKeyId = IAM_ACCESS_KEY_ID
    secretAccessKey = IAM_SECRET_ACCESS_KEY

Using AWS environments

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "s3",
      "path": "https://s3.amazonaws.com/my-bucket-feed/",
      "bucketName": "my-bucket-feed",
      "region": "us-east-1"
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = s3
    path = https://s3.amazonaws.com/my-bucket-feed/
    bucketName = my-bucket-feed
    region = us-west-2

Using serviceURL

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "s3",
      "path": "https://s3.amazonaws.com/my-bucket-feed/",
      "bucketName": "my-bucket-feed",
      "serviceURL": "https://s3.us-east-1.amazonaws.com"
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = s3
    path = https://s3.amazonaws.com/my-bucket-feed/
    bucketName = my-bucket-feed
    serviceURL = https://s3.us-east-1.amazonaws.com

When running Sleet with AWS environment variables leave accessKeyId, secretAccessKey, and profileName blank. If these properties are not set in sleet.json Sleet will try to set up the S3 feed using the environment.

Folder feed specific properties

Property	Description
path	Path is the output directory of the feed.

sleet.json:

{
  "sources": [
    {
      "name": "myLocalFeed",
      "type": "local",
      "path": "C:\\myFeed"
    }
  ]
}

.netconfig:

[sleet "myLocalFeed"]
    type = local
    path = C:\\myFeed

Tokens in configuration

Property values in sleet.json and .netconfig can be tokenized similar to nuget .pp files.

Given an environment variable myKey the following file would replace $myKey$ with the value of the environment variable if it exists.

sleet.json:

{
  "sources": [
    {
      "name": "feed",
      "type": "azure",
      "container": "feed",
      "connectionString": "DefaultEndpointsProtocol=https;AccountName=;AccountKey=$myKey$;BlobEndpoint="
    }
  ]
}

.netconfig:

[sleet "feed"]
    type = azure
    container = feed
    connectionString = "DefaultEndpointsProtocol=https;AccountName=;AccountKey=$myKey$;BlobEndpoint="

Tokens that resolve to a tokenized string will also be resolved, allowing environment variables to point to and combine additional environment variables.

To escape $ use $$.

Caching configuration

It is possible to configure caching header for both Azure and S3 backed feeds. This is useful when serving the feed content through a CDN. By default, caching is disabled with a value of no-store. You can configure caching for both mutable and immutable files. Immutable files (files which aren't supposed to change, since they are stored per version - .nupkg, /readme, /icon, .nuspec, .xml, .dll, .pdb) should have a long cache lifetime (unless you are making changes to live packages). Mutable files (files which are expected to change, such as index.json and flatcontainer/{id}/index.json) should have a short cache lifetime (~1 hour or whatever you are comfortable with), since it can make clients see stale feed.

Property	Description
immutableCacheControl	Cache-Control header value for immutable versioned files (.nupkg, /readme, /icon, .nuspec, .xml, .dll, .pdb). Default is `no-store`. Example: `public, max-age=31536000, immutable`
mutableCacheControl	Cache-Control header value for mutable files (.json, .svg). Default is `no-store`. Example: `public, max-age=300, must-revalidate`

Sleet.json loading order

If --config was passed the path given will be used.
If no config path was given sleet will search all parent directories starting with the working directory for sleet.json files.
Environment variables will be used if no sleet.json files were found.

.netconfig loading order

If --config was passed the path given will be used.
Standard .netconfig probing happens next (current directory and all parent directories, plus global and system locations).
Environment variables will be used if no sleet setting is found.

Environment variables

Feeds can be defined using only environment variables.

SLEET_FEED_{property} env vars will be treated the same as properties under a source.

Example of defining an azure feed using only environment variables:

Property	Value
`SLEET_FEED_TYPE`	`azure`
`SLEET_FEED_CONTAINER`	`feed`
`SLEET_FEED_CONNECTIONSTRING`	`DefaultEndpointsProtocol=https;AccountName=;AccountKey=;BlobEndpoint=`

To avoid loading up any sleet.json files when using env vars pass --config none to block it from loading.

Note that if sleet.json is used environment variables will be ignored. It is not possible to mix settings between the two input options.

Command line properties

Key value pairs can be passed on the command line and are treated the same as environment variables would be.

Command line properties are favored over environment variables.

Properties can be passed with -p or --property with a format of "key=value".

In this example a new feed is initialized without a sleet.json file. All values are passed in on the command line.

sleet init --config none -p SLEET_FEED_TYPE=azure -p SLEET_FEED_CONTAINER=feed \
 -p "SLEET_FEED_CONNECTIONSTRING=DefaultEndpointsProtocol=https;AccountName=;AccountKey=;BlobEndpoint="

Network proxy settings

Authenticated proxy that use windows credentials should enable the following setting in sleet.json

{
  "proxy": {
    "useDefaultCredentials": true
  },
  "sources": [
  ]
}

This setting can be set through an environment variable or command line property if sleet.json is not used.

Property	Value
`SLEET_FEED_PROXY_USEDEFAULTCREDENTIALS`	`true`