Skip to content

Commit

Permalink
chore(README): Format local/system parameters as table (#211)
Browse files Browse the repository at this point in the history
  • Loading branch information
guicamest authored Oct 17, 2023
1 parent 6726734 commit 9406f59
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,23 +133,24 @@ If no configuration is supplied the values in `resources/s3-nio-spi.properties`
Each fragment is downloaded concurrently on a unique thread.

#### Local parameters
**aws.region** specifies the default region for API calls
**aws.accessKey** specifies the key id to use for authentication
**aws.secretAccessKey** specifies the secret to use for authentication

**s3.spi.read.fragment-number** buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)
**s3.spi.read.fragment-size** size of each fragment (currently 5MB)
**s3.spi.endpoint** the endpoint to use to access the bucket; this is extracted from the uri by the S3X provider
**s3.spi.force-path-style** (true|false) to set if path-style shall be used instead of host style; unless otherwise
specified, this is undefined for the S3 provider and set to true when using the S3X provider.
|parameter|description|
|---------|-----------|
|**aws.region**|specifies the default region for API calls|
|**aws.accessKey**|specifies the key id to use for authentication|
|**aws.secretAccessKey**|specifies the secret to use for authentication|
|**s3.spi.read.fragment-number**|buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)|
|**s3.spi.read.fragment-size**|size of each fragment (currently 5MB)|
|**s3.spi.endpoint**|the endpoint to use to access the bucket; this is extracted from the uri by the S3X provider|
|**s3.spi.force-path-style**|(true\|false) to set if path-style shall be used instead of host style; unless otherwise specified, this is undefined for the S3 provider and set to true when using the S3X provider.|

#### System parameter ####
**aws.region** specifies the default region for API calls
**aws.accessKey** specifies the key id to use for authentication
**aws.secretAccessKey** specifies the secret to use for authentication

**s3.spi.read.fragment-number** buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)
**s3.spi.read.fragment-size** size of each fragment (currently 5MB)
|parameter|description|
|---------|-----------|
|**aws.region**|specifies the default region for API calls|
|**aws.accessKey**|specifies the key id to use for authentication|
|**aws.secretAccessKey**|specifies the secret to use for authentication|
|**s3.spi.read.fragment-number**|buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)|
|**s3.spi.read.fragment-size**|size of each fragment (currently 5MB)|

#### Environment Variables

Expand Down

0 comments on commit 9406f59

Please sign in to comment.