Overview

Application level settings allow you to configure settings that impact all the channel types in your app. Our backend SDKs make it easy to change the app settings. You can also change most of these using the CLI or the dashboard. Here’s an example on changing the disable_auth_checks setting:

// disable auth checks, allows dev token usage
await client.updateAppSettings({
  disable_auth_checks: true,
});

// re-enable auth checks
await client.updateAppSettings({
  disable_auth_checks: false,
});

# disable auth checks, allows dev token usage
client.update_app_settings(disable_auth_checks=True)

# re-enable auth checks
client.update_app_settings(disable_auth_checks=False)

// disable auth checks, allows dev token usage
$update = $client->updateAppSettings([
	'disable_auth_checks' => true
]);

// re-enable auth checks
$update = $client->updateAppSettings([
	'disable_auth_checks' => false
]);

// disable auth checks, allows dev token usage
	settings := NewAppSettings().SetDisableAuth(true)
	err = client.UpdateAppSettings(settings)
	if err != nil {
		log.Fatalf("Err: %v", err)
	}

	// re-enable auth checks
	err = client.UpdateAppSettings(NewAppSettings().SetDisableAuth(false))
	if err != nil {
		log.Fatalf("Err: %v", err)
	}

# require 'stream-chat'

# disable auth checks, allows dev token usage
client.update_app_settings({ 'disable_auth_checks' => true })

# re-enable auth checks
client.update_app_settings({ 'disable_auth_checks' => false })

await appClient.UpdateAppSettingsAsync(new AppSettingsRequest
{
  DisableAuth = true,
});

// re-enable auth checks
await appClient.UpdateAppSettingsAsync(new AppSettingsRequest
{
  DisableAuth = false,
});

// disable auth checks, allows dev token usage
App.update().disableAuthChecks(true).request();

// re-enable auth checks
App.update().disableAuthChecks(false).request();

// This is a server-side only feature, choose any of our server-side SDKs to use it

A full overview of available settings can be found below:

Permissions

The following app settings allow you to control how permissions work for your app:

Push

CDN

Hooks

Hooks enable you to listen to changes in chat. You can use either webhooks or SQS.

Features

The following settings allow you to control features of your application:

Moderation & Translation

The following settings allow you to control moderation for your chat:

File Uploads

You can set restrictions on file uploads by including a file_upload_config object. You can set either an inclusive list using allowed_file_extensions and allowed_mime_types or an exclusive list using blocked_file_extensions and blocked_mime_types .

The file_upload_config object accepts the following fields:

For example, the following code shows how to block all attempts to upload any files that are not .csv:

// Only accept .CSV files
await client.updateAppSettings({
  file_upload_config: {
   allowed_file_extensions: [".csv"],
   allowed_mime_types: ["text/csv"]
});

# Only accept .CSV files

client.update_app_settings({
  "file_upload_config": {
   "allowed_file_extensions": [".csv"],
   "allowed_mime_types": ["text/csv"],
}})

$settings = ["file_upload_config" => [
  "allowed_file_extensions" => [".csv"],
  "allowed_mime_types" => ["text/csv"]
 ]
]
client->updateAppSettings($settings);

settings := &AppSettings{FileUploadConfig: &FileUploadConfig{
	AllowedFileExtensions: []string{".csv"},
	AllowedMimeTypes:   []string{"text/csv"},
}}

resp, err = client.UpdateAppSettings(ctx, settings)

client.update_app_settings({
 'file_upload_config' => {
  'allowed_file_extensions' => ['.csv'],
  'allowed_mime_types' => ['text/csv']
 }
})

await appClient.UpdateAppSettingsAsync(new AppSettingsRequest
{
  FileUploadConfig = new FileUploadConfig
  {
    AllowedFileExtensions = new List<string> { ".csv" },
    AllowedMimeTypes = new List<string> { "text/csv" },
  },
});

var cfg = App.FileUploadConfigRequestObject
 .builder()
 .allowedFileExtensions(List.of(".csv"))
 .allowedMimeTypes("text/csv")
 .build();

App.update().fileUploadConfig(cfg).request();

// This is a server-side only feature, choose any of our server-side SDKs to use it

Image Uploads

You can set restrictions on file uploads by including an image_upload_config object. You can set either an inclusive list using allowed_file_extensions and allowed_mime_types or an exclusive list using blocked_file_extensions and blocked_mime_types .

The image_upload_config object accepts the following fields:

For example, the following code shows how to block all attempts to upload any files that are not gif, jpeg, or png files:

// Only accept gif, jpeg, or png files.
await client.updateAppSettings({
  image_upload_config: {
   allowed_file_extensions: [".gif", ".jpeg", ".png"],
   allowed_mime_types: ["image/gif", "image/jpeg", "image/png"]
});

# Only accept gif, jpeg, or png files.

client.update_app_settings({
  "image_upload_config": {
   "allowed_file_extensions": [".gif", ".jpeg", ".png"],
   "allowed_mime_types": ["image/gif", "image/jpeg", "image/png"],
}})

$settings = ["image_upload_config" => [
  "allowed_file_extensions" => [".gif", ".jpeg", ".png"],
  "allowed_mime_types" => ["image/gif", "image/jpeg", "image/png"]
 ]
]
client->updateAppSettings($settings);

settings := &AppSettings{ImageUploadConfig: &FileUploadConfig{
	AllowedFileExtensions: []string{".gif", ".jpeg", ".png"},
	AllowedMimeTypes:   []string{"image/gif", "image/jpeg", "image/png"},
}}

resp, err = client.UpdateAppSettings(ctx, settings)

client.update_app_settings({
 'file_upload_config' => {
  'allowed_file_extensions' => ['.gif', '.jpeg', '.png'],
  'allowed_mime_types' => ['image/gif', 'image/jpeg', 'image/png']
 }
})

await appClient.UpdateAppSettingsAsync(new AppSettingsRequest
{
  ImageUploadConfig = new FileUploadConfig
  {
    AllowedFileExtensions = new List<string> { ".gif", ".jpeg", ".png" },
    AllowedMimeTypes = new List<string> { "image/gif", "image/jpeg", "image/png" },
  },
});

var cfg = App.FileUploadConfigRequestObject
 .builder()
 .allowedFileExtensions(List.of(".gif", ".jpeg", ".png"))
 .allowedMimeTypes("image/gif", "image/jpeg", "image/png")
 .build();

App.update().imageUploadConfig(cfg).request();

// This is a server-side only feature, choose any of our server-side SDKs to use it