Setting the S3 bucket for file uploads and redactions

For a self-hosted instance, you configure an S3 bucket to use to store dataset files and individual files that you use the Textual SDK to redact. If an S3 bucket is not configured, then:

• The dataset and individual redacted files are stored in the Textual application database.
• You cannot use Amazon Textract for PDF and image processing. If you configured Textual to use Amazon Textract, Textual instead uses Tesseract.

The authentication credentials for the S3 bucket include:

• The AWS Region where the S3 bucket is located.
• An AWS access key that is associated with an IAM user or role.
• The secret key that is associated with the access key.

To provide the authentication credentials, you can either:

• Provide the values directly as environment variable values.
• Use the instance profile of the compute instance where Textual runs.

You can also optionally override the default encryption used by the S3 bucket.

For an example IAM role that has the required permissions, go to Example IAM role for file uploads and redactions.

Docker

Connection settings

In .env, add the following settings:

• SOLAR_INTERNAL_BUCKET_NAME= <S3 bucket path>
• AWS_DEFAULT_REGION= <AWS Region>
• AWS_ACCESS_KEY_ID= <AWS access key>
• AWS_SECRET_ACCESS_KEY= <AWS secret key>

If you use the instance profile of the compute instance, then only the bucket name is required.

Encryption override

To override the default encryption, add:

SOLAR_INTERNAL_BUCKET_S3_SERVER_SIDE_ENCRYPTION_TYPE= <S3 or Kms>

If you set the encryption type to Kms, then also add:

SOLAR_INTERNAL_BUCKET_S3_SERVER_SIDE_ENCRYPTION_KEY = <AWS KMS key ID, key ARN, or key alias>

Kubernetes

Connection settings

In values.yaml, within env: { } under both textual_api_server and textual_worker, add the following settings:

• SOLAR_INTERNAL_BUCKET_NAME - S3 bucket path
• AWS_DEFAULT_REGION - AWS Region
• AWS_ACCESS_KEY_ID - AWS access key
• AWS_SECRET_ACCESS_KEY - AWS secret key

For example, if no other environment variables are defined:

  env: {
        "SOLAR_INTERNAL_BUCKET_NAME": "<S3 bucket path>",
        "AWS_DEFAULT_REGION": "<AWS Region>",
        "AWS_ACCESS_KEY_ID": "<AWS access key>",
        "AWS_SECRET_ACCESS_KEY": "<AWS secret key>"
       }

If you use the instance profile of the compute instance, then only the bucket name is required.

Encryption override

To override the default encryption, add:

SOLAR_INTERNAL_BUCKET_S3_SERVER_SIDE_ENCRYPTION_TYPE - Either S3 or Kms.

If you set the encryption type to Kms, then also add:

SOLAR_INTERNAL_BUCKET_S3_SERVER_SIDE_ENCRYPTION_KEY -The AWS KMS key ID, key ARN, or key alias.