Custom Agent Configuration for US Domain or VPC
This section guides users operating Encord with the US domain (https://api.us.encord.com) or within their private Virtual Private Cloud (VPC) on how to configure their Custom Agents.
STEP 1: Set the ENCORD_DOMAIN Environment Variable
Define the Encord API domain, not the front-end application domain.
- Running Locally:
- Deploying with a GCP Cloud Function: Create a GCP secret and pass in the domain:
STEP 2: Set the ENCORD_SSH_KEY or ENCORD_SSH_KEY_FILE Environment Variables
Provide your access key for authentication.
- Running Locally:
or
- Deploying with a GCP Cloud Function: Create a GCP secret and pass in the key:
STEP 3: Pass the Front-end Domain to the Custom Agent Declaration
Pass the Encord front-end domain into the@editor_agent declaration to ensure the function respects Cross-Origin Resource Sharing (CORS):