Configuration

Configuration is a value object holding the SDK configuration. We can use it in two ways:

1. When using Actor class, we can get the instance configuration via sdk.config

   import { Actor } from 'apify';
   import { BasicCrawler } from 'crawlee';
   
   const sdk = new Actor({ token: '123' });
   console.log(sdk.config.get('token')); // '123'
   
   const crawler = new BasicCrawler({
       // ... crawler options
   }, sdk.config);
2. To get the global configuration (singleton instance). It will respect the environment variables.

   import { BasicCrawler, Configuration } from 'crawlee';
   
   // Get the global configuration
   const config = Configuration.getGlobalConfig();
   // Set the 'persistStateIntervalMillis' option
   // of global configuration to 30 seconds
   config.set('persistStateIntervalMillis', 30_000);
   
   // No need to pass the configuration to the crawler,
   // as it's using the global configuration by default
   const crawler = new BasicCrawler();

Supported Configuration Options

Key	Environment Variable	Default Value
memoryMbytes	ACTOR_MEMORY_MBYTES	-
headless	APIFY_HEADLESS	-
persistStateIntervalMillis	APIFY_PERSIST_STATE_INTERVAL_MILLIS	60e3
token	APIFY_TOKEN	-
isAtHome	APIFY_IS_AT_HOME	-
defaultDatasetId	ACTOR_DEFAULT_DATASET_ID	'default'
defaultKeyValueStoreId	ACTOR_DEFAULT_KEY_VALUE_STORE_ID	'default'
defaultRequestQueueId	ACTOR_DEFAULT_REQUEST_QUEUE_ID	'default'

Advanced Configuration Options

Key	Environment Variable	Default Value
actorEventsWsUrl	ACTOR_EVENTS_WEBSOCKET_URL	-
actorId	ACTOR_ID	-
actorRunId	ACTOR_RUN_ID	-
actorTaskId	ACTOR_TASK_ID	-
apiBaseUrl	APIFY_API_BASE_URL	'https://api.apify.com'
containerPort	ACTOR_WEB_SERVER_PORT	4321
containerUrl	ACTOR_WEB_SERVER_URL	'http://localhost:4321'
inputKey	ACTOR_INPUT_KEY	'INPUT'
metamorphAfterSleepMillis	APIFY_METAMORPH_AFTER_SLEEP_MILLIS	300e3
proxyHostname	APIFY_PROXY_HOSTNAME	'proxy.apify.com'
proxyPassword	APIFY_PROXY_PASSWORD	-
proxyPort	APIFY_PROXY_PORT	8000
proxyStatusUrl	APIFY_PROXY_STATUS_URL	'http://proxy.apify.com'
userId	APIFY_USER_ID	-
xvfb	APIFY_XVFB	-
chromeExecutablePath	APIFY_CHROME_EXECUTABLE_PATH	-
defaultBrowserPath	APIFY_DEFAULT_BROWSER_PATH	-

Hierarchy

• Configuration
  • Configuration

Index

Constructors

• constructor

Properties

• globalConfig

Methods

• get
• getEventManager
• set
• useEventManager
• useStorageClient
• getEventManager
• getGlobalConfig
• getStorageClient
• resetGlobalState
• set
• useStorageClient

Constructors

externalconstructor

• new Configuration(options?: ConfigurationOptions): Configuration

• Inherited from CoreConfiguration.constructor

  Creates new Configuration instance with provided options. Env vars will have precedence over those.

  ---

  Parameters

  • externaloptionaloptions: ConfigurationOptions

  Returns Configuration

Properties

staticoptionalglobalConfig

globalConfig?: Configuration

Overrides CoreConfiguration.globalConfig

@inheritDoc

Methods

get

• get<T, U>(key: T, defaultValue?: U): U

• Overrides CoreConfiguration.get

  @inheritDoc

  ---

  Type parameters

  • T: keyof ConfigurationOptions
  • U: undefined | string | number | boolean | Dictionary<any> | StorageClient | EventManager | (radix?: number) => string | (fractionDigits?: number) => string | (fractionDigits?: number) => string | (precision?: number) => string | () => number | ({ (locales?: string | string[], options?: NumberFormatOptions): string; (locales?: LocalesArgument, options?: NumberFormatOptions): string })

  Parameters

  • key: T

  • optionaldefaultValue: U

  Returns U

externalgetEventManager

• getEventManager(): EventManager

• Inherited from CoreConfiguration.getEventManager

  Returns EventManager

set

• set(key: keyof ConfigurationOptions, value?: any): void

• Overrides CoreConfiguration.set

  @inheritDoc

  ---

  Parameters

  • key: keyof ConfigurationOptions

  • optionalvalue: any

  Returns void

externaluseEventManager

• useEventManager(events: EventManager): void

• Inherited from CoreConfiguration.useEventManager

  Parameters

  • externalevents: EventManager

  Returns void

externaluseStorageClient

• useStorageClient(client: StorageClient): void

• Inherited from CoreConfiguration.useStorageClient

  Parameters

  • externalclient: StorageClient

  Returns void

staticexternalgetEventManager

• getEventManager(): EventManager

• Inherited from CoreConfiguration.getEventManager

  Gets default EventManager instance.

  ---

  Returns EventManager

staticgetGlobalConfig

• getGlobalConfig(): Configuration

• Overrides CoreConfiguration.getGlobalConfig

  @inheritDoc

  ---

  Returns Configuration

staticexternalgetStorageClient

• getStorageClient(): StorageClient

• Inherited from CoreConfiguration.getStorageClient

  Gets default StorageClient instance.

  ---

  Returns StorageClient

staticresetGlobalState

• resetGlobalState(): void

• Overrides CoreConfiguration.resetGlobalState

  Resets global configuration instance. The default instance holds configuration based on env vars, if we want to change them, we need to first reset the global state. Used mainly for testing purposes.

  ---

  Returns void

staticexternalset

• set(key: keyof ConfigurationOptions, value?: any): void

• Inherited from CoreConfiguration.set

  Sets value for given option. Only affects the global Configuration instance, the value will not be propagated down to the env var. To reset a value, we can omit the value argument or pass undefined there.

  ---

  Parameters

  • externalkey: keyof ConfigurationOptions

  • externaloptionalvalue: any

  Returns void

staticexternaluseStorageClient

• useStorageClient(client: StorageClient): void

• Inherited from CoreConfiguration.useStorageClient

  Parameters

  • externalclient: StorageClient

  Returns void