Skip to content

Environment Variables

To work with remote datasets or accessing resources on remote paths, the CLI looks up the required authentication data from environment variables.

Webknossos Datasets

When working with non-public webknossos datasets or an own webknossos instance, these variables can be used:

  • WK_TOKEN
    This is the auth token to identify against webknossos. It can be generated here.
  • WK_URL
    This is the base URL for webknossos APIs and datasets. If it is unset the default https://webknossos.org is used.

AWS S3 Configuration

Use these variables when accessing datasets stored on AWS S3 or compatible services:

  • AWS_ACCESS_KEY_ID
    Your AWS access key ID used for authenticating with S3 services.
  • AWS_SECRET_ACCESS_KEY
    Your AWS secret access key required for S3 authentication.
  • S3_ENDPOINT_URL
    The endpoint URL for the S3 service; useful for S3-compatible storage providers.

HTTP Basic Authentication

Use these variables when HTTP basic authentication is required:

  • HTTP_BASIC_USER
    Username for HTTP basic authentication.
  • HTTP_BASIC_PASSWORD
    Password associated with the HTTP basic username.