Skip to content

Configuration

Jump to bottom
Shannon Atkinson edited this page Oct 30, 2024 · 1 revision

Configuration

This section details the environment variables and settings required to configure the No-Code Architects Toolkit. Based on your chosen setup (Google Cloud Platform or S3-compatible storage), ensure you have the correct environment variables in place.

Environment Variables

General Settings

These variables are required regardless of your storage provider:

  • API_KEY: Used for authenticating requests to the API.
  • DEFAULT_BITRATE (optional): The default bitrate for media conversions, such as converting files to MP3. If not specified, the system defaults to 128k.

Google Cloud Platform (GCP) Configuration

If you are using Google Cloud Platform for storage, configure the following variables:

  • GCP_SA_CREDENTIALS: Path to your Google Cloud service account JSON key file, which provides access to GCP services.
  • GCP_BUCKET_NAME: The name of the Google Cloud Storage bucket where files will be uploaded.

Example GCP .env Configuration

API_KEY=your_api_key
GCP_SA_CREDENTIALS=/path/to/your-gcp-credentials.json
GCP_BUCKET_NAME=your_gcp_bucket_name
DEFAULT_BITRATE=128k

S3-Compatible Storage Configuration

For DigitalOcean Spaces or any other S3-compatible storage provider, configure the following variables:

  • S3_ENDPOINT_URL: The endpoint URL for your S3-compatible storage. For example, DigitalOcean Spaces in NYC would use https://nyc3.digitaloceanspaces.com.
  • S3_ACCESS_KEY: Your access key for the S3-compatible storage service.
  • S3_SECRET_KEY: Your secret key for the S3-compatible storage service.
  • S3_BUCKET_NAME: The name of your S3-compatible bucket.

Example S3-Compatible .env Configuration

API_KEY=your_api_key
S3_ENDPOINT_URL=https://nyc3.digitaloceanspaces.com
S3_ACCESS_KEY=your_digitalocean_access_key
S3_SECRET_KEY=your_digitalocean_secret_key
S3_BUCKET_NAME=your_s3_bucket_name
DEFAULT_BITRATE=128k

Optional Variables

  • WEBHOOK_URL: URL to send notifications on task completion (e.g., media conversion or transcription). If set, the toolkit will post to this URL when a job is complete.
  • PROXY_SERVER: Optional proxy server settings, useful for projects requiring external API calls through a proxy. Configure as needed if you’re using proxies.

Configuring the Environment

  1. Create a .env file at the project root to store environment variables securely.
  2. Populate the file with the necessary environment variables based on the chosen configuration.

Note: Ensure sensitive values like API keys and secrets are not hard-coded in your scripts. Using a .env file provides better security and flexibility for configuration management.

With your environment variables properly configured, you can proceed to run the application and access its full functionality.

Clone this wiki locally