Skip to main content

Configuration

A class for specifying the configuration of an Actor.

Can be used either globally via Configuration.get_global_configuration(), or it can be specific to each Actor instance on the actor.config property.

Index

Methods

Properties

Methods

disable_browser_sandbox_on_platform

  • disable_browser_sandbox_on_platform(): Self

  • Disable the browser sandbox mode when running on the Apify platform.

    Running in environment where is_at_home is True does not benefit from browser sandbox as it is already running in a container. It can be on the contrary undesired as the process in the container might be running as root and this will crash chromium that was started with browser sandbox mode.

    Returns Self

from_configuration

  • Create Apify Configuration from existing Crawlee Configuration.

    Parameters

    • configuration: CrawleeConfiguration

      The existing Crawlee Configuration.

    Returns Configuration

get_global_configuration

  • Retrieve the global instance of the configuration.

    This method ensures that ApifyConfigration is returned, even if CrawleeConfiguration was set in the service locator.

    Returns Configuration

Properties

actor_build_id

actor_build_id: str | None

actor_build_number

actor_build_number: str | None

actor_build_tags

actor_build_tags: list[str] | None

actor_events_ws_url

actor_events_ws_url: str | None

actor_full_name

actor_full_name: str | None

actor_id

actor_id: str | None

actor_run_id

actor_run_id: str | None

actor_task_id

actor_task_id: str | None

api_base_url

api_base_url: str

api_public_base_url

api_public_base_url: str

dedicated_cpus

dedicated_cpus: float | None

default_dataset_id

default_dataset_id: str | None

default_key_value_store_id

default_key_value_store_id: str | None

default_request_queue_id

default_request_queue_id: str | None

disable_outdated_warning

disable_outdated_warning: bool

fact

fact: str | None

input_key

input_key: str

input_secrets_private_key_file

input_secrets_private_key_file: str | None

input_secrets_private_key_passphrase

input_secrets_private_key_passphrase: str | None

is_at_home

is_at_home: bool

latest_sdk_version

latest_sdk_version: str | None

log_format

log_format: str | None

max_paid_dataset_items

max_paid_dataset_items: int | None

max_total_charge_usd

max_total_charge_usd: Decimal | None

meta_origin

meta_origin: str | None

metamorph_after_sleep

metamorph_after_sleep: timedelta_ms

proxy_hostname

proxy_hostname: str

proxy_password

proxy_password: str | None

proxy_port

proxy_port: int

proxy_status_url

proxy_status_url: str

standby_port

standby_port: int

standby_url

standby_url: str

started_at

started_at: datetime | None

test_pay_per_event

test_pay_per_event: bool

timeout_at

timeout_at: datetime | None

token

token: str | None

user_id

user_id: str | None

user_is_paying

user_is_paying: bool

web_server_port

web_server_port: int

web_server_url

web_server_url: str

workflow_key

workflow_key: str | None
Page Options