Skip to content

Commit

Permalink
Add documentation for TC_AWS_ROOT_IMAGE_NAME
Browse files Browse the repository at this point in the history
  • Loading branch information
Bladrak committed Mar 6, 2018
1 parent 9fcc5a4 commit c045adb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This is set to False by default to preserve backwards compatibility.

**Warning**: enabling this option will result in re-generating all your cached files on your storages.

### 6.2.2 - Adding a root image name

A new option ``TC_AWS_ROOT_IMAGE_NAME`` is available in the configuration that allows to set a default name for images which URL ends with a trailing ``/``. By default, it is set to ``root_image`` but you can set it to whatever you'd like.

## 6.1 - Custom endpoint

You can now specify a custom AWS API endpoint by setting this in the configuration:
Expand Down
3 changes: 2 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,11 @@ TC_AWS_MAX_RETRY=0 # Max retries for get image from S3 Bucket. Default is 0
TC_AWS_STORE_METADATA=False # Store result with metadata (for instance content-type)
```

### Optimization settings
### Key settings

```.ini
TC_AWS_RANDOMIZE_KEYS=False # Adds some randomization in the S3 keys for the Storage and Result Storage. Defaults to False for Backwards Compatibility, set it to True for performance.
TC_AWS_ROOT_IMAGE_NAME='root_image' # Sets a default name for requested images ending with a trailing /. Those images will be stored in result_storage and storage under the name set in this configuration.
```

## Troubleshooting
Expand Down

0 comments on commit c045adb

Please sign in to comment.