This is an automated email from the ASF dual-hosted git repository. rouazana pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 57cf0f18b5bb222702b9b55d1b2e57f684ead4c4 Author: Tran Tien Duc <[email protected]> AuthorDate: Wed Jul 17 15:43:27 2019 +0700 JAMES-2834 blob.properties add comments with explanations --- .../destination/conf/blob.properties | 115 ++++++++++++++++++++- .../destination/conf/blob.properties | 115 ++++++++++++++++++++- 2 files changed, 224 insertions(+), 6 deletions(-) diff --git a/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/blob.properties b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/blob.properties index 664e7ec..e92c045 100644 --- a/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/blob.properties +++ b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/blob.properties @@ -1,17 +1,126 @@ +# ============================================= BlobStore Implementation ================================== +# Choose your BlobStore implementation +# Mandatory, allowed values are: cassandra, objectstorage, union +# union is using both objectstorage as the current BlobStore & cassandra as the legacy BlobStore implementation=objectstorage -# Configuration for swift BlobStore +# ============================================== ObjectStorage ============================================ + +# ========================================= ObjectStorage Codec ====================================== +# Codec for blob contents +# Mandatory, allowed values are: DEFAULT, AES256 +# DEFAULT: no encryption +# AES256: AES-256 encryption objectstorage.payload.codec=DEFAULT + +# ===================================== ObjectStorage AES256 Encryption ==================================== +# Mandatory if you choose AES256 encryption, salt value in string for the encryption +# objectstorage.aes256.hexsalt=salt + +# Mandatory if you choose AES256 encryption, password for the encryption +# objectstorage.aes256.password=password + +# ========================================= ObjectStorage providers ======================================== +# Choosing blob storage service +# Mandatory, Allowed values are: swift, aws-s3 objectstorage.provider=swift -objectstorage.namespace=james + +# ========================================= ObjectStorage Buckets ========================================== +# bucket names prefix +# Optional, default no prefix +# objectstorage.bucketPrefix=prod- + +# Default bucket name +# Optional, default is bucketPrefix + `default` +# objectstorage.namespace=james + +# ========================================= ObjectStorage on Swift ========================================= +# Specify the geography region which the BlobStore will connect to a in Swift ObjectStorage +# Optional, possible values are those of your Swift service +# objectstorage.swift.region=HKG + +# Specify the authentication mechanism of Swift +# Mandatory, allowed values are: tmpauth, keystone2, keystone3 objectstorage.swift.authapi=tmpauth + +# Mandatory, authentication endpoint objectstorage.swift.endpoint=http://swift:8080/auth/v1.0 + +# Openstack Swift authentication mechanisms require you to pass the user information +# to get the access tokens. User information usually include two parts: +# identity: user identification like username +# credential: like password, here it is the Secret Access Key in Jcloud +# Mandatory objectstorage.swift.credentials=testing + +# =================================== ObjectStorage on Swift with Temp Auth ================================ +# Mandatory, authentication identity, the identity contains two part, username and tenantname +# Should be the username & tenant name configured in Swift +# Mandatory objectstorage.swift.tempauth.username=tester +# Mandatory objectstorage.swift.tempauth.tenantname=test + +# Specify http header name for carrying credential information +# Mandatory objectstorage.swift.tempauth.passheadername=X-Storage-Pass + +# Specify http header name for carrying identity information +# Mandatory objectstorage.swift.tempauth.userheadername=X-Storage-User +# ================================ ObjectStorage on Swift with Keystone 2 Auth ============================== +# Similar to tempAuth +# Mandatory if you choose keystone 2 auth +# objectstorage.swift.keystone2.username=tester +# Mandatory if you choose keystone 2 auth +# objectstorage.swift.keystone2.tenantname=test + +# ================================ ObjectStorage on Swift with Keystone 3 Auth ============================== +# Specifying identity information with Keystone 3 Auth +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.user.name=demo +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.user.domain=Default +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.scope.domainid=default + +# Specifying project information in KeyStone 3 Auth (similar to tenant in KeyStone 2) +# Optional +# objectstorage.swift.keystone3.scope.project.name=test +# Optional +# objectstorage.swift.keystone3.scope.project.domainname=Default +# Optional +# objectstorage.swift.keystone3.scope.project.domainid=default + +# ========================================= ObjectStorage on S3 ============================================= +# Mandatory if you choose aws-s3 storage service, S3 authentication endpoint +# objectstorage.s3.endPoint=http://james-s3:8000 +# Mandatory if you choose aws-s3 storage service, access key id configured in S3 +# objectstorage.s3.accessKeyId=accessKey + +# Mandatory if you choose aws-s3 storage service, secret key configured in S3 +# objectstorage.s3.secretKey=secretKey + +# ============================================ Blobs Exporting ============================================== +# Choosing blob exporting mechanism, allowed mechanism are: localFile, linshare +# LinShare is a file sharing service, will be explained in the below section +# Optional, default is localFile blob.export.implementation=localFile -blob.export.localFile.directory=file://var/blobExporting \ No newline at end of file + +# ======================================= Local File Blobs Exporting ======================================== +# Optional, directory to store exported blob, directory path follows James file system format +# default is file://var/blobExporting +blob.export.localFile.directory=file://var/blobExporting + +# ======================================= LinShare File Blobs Exporting ======================================== +# LinShare is a sharing service where you can use james, connects to an existing LinShare server and shares files to +# other mail addresses as long as those addresses available in LinShare. For example you can deploy James and LinShare +# sharing the same LDAP repository +# Mandatory if you choose LinShare, url to connect to LinShare service +# blob.export.linshare.url=http://linshare:8080 + +# Mandatory if you choose LinShare, access token to connect to LinShare service. It will be formalized to `Bearer` + a space + access token +# So, no need to pass (`Bearer` + <space>) prefix +# blob.export.linshare.token=LinShare-Access-Token-In-String diff --git a/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/blob.properties b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/blob.properties index 664e7ec..e92c045 100644 --- a/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/blob.properties +++ b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/blob.properties @@ -1,17 +1,126 @@ +# ============================================= BlobStore Implementation ================================== +# Choose your BlobStore implementation +# Mandatory, allowed values are: cassandra, objectstorage, union +# union is using both objectstorage as the current BlobStore & cassandra as the legacy BlobStore implementation=objectstorage -# Configuration for swift BlobStore +# ============================================== ObjectStorage ============================================ + +# ========================================= ObjectStorage Codec ====================================== +# Codec for blob contents +# Mandatory, allowed values are: DEFAULT, AES256 +# DEFAULT: no encryption +# AES256: AES-256 encryption objectstorage.payload.codec=DEFAULT + +# ===================================== ObjectStorage AES256 Encryption ==================================== +# Mandatory if you choose AES256 encryption, salt value in string for the encryption +# objectstorage.aes256.hexsalt=salt + +# Mandatory if you choose AES256 encryption, password for the encryption +# objectstorage.aes256.password=password + +# ========================================= ObjectStorage providers ======================================== +# Choosing blob storage service +# Mandatory, Allowed values are: swift, aws-s3 objectstorage.provider=swift -objectstorage.namespace=james + +# ========================================= ObjectStorage Buckets ========================================== +# bucket names prefix +# Optional, default no prefix +# objectstorage.bucketPrefix=prod- + +# Default bucket name +# Optional, default is bucketPrefix + `default` +# objectstorage.namespace=james + +# ========================================= ObjectStorage on Swift ========================================= +# Specify the geography region which the BlobStore will connect to a in Swift ObjectStorage +# Optional, possible values are those of your Swift service +# objectstorage.swift.region=HKG + +# Specify the authentication mechanism of Swift +# Mandatory, allowed values are: tmpauth, keystone2, keystone3 objectstorage.swift.authapi=tmpauth + +# Mandatory, authentication endpoint objectstorage.swift.endpoint=http://swift:8080/auth/v1.0 + +# Openstack Swift authentication mechanisms require you to pass the user information +# to get the access tokens. User information usually include two parts: +# identity: user identification like username +# credential: like password, here it is the Secret Access Key in Jcloud +# Mandatory objectstorage.swift.credentials=testing + +# =================================== ObjectStorage on Swift with Temp Auth ================================ +# Mandatory, authentication identity, the identity contains two part, username and tenantname +# Should be the username & tenant name configured in Swift +# Mandatory objectstorage.swift.tempauth.username=tester +# Mandatory objectstorage.swift.tempauth.tenantname=test + +# Specify http header name for carrying credential information +# Mandatory objectstorage.swift.tempauth.passheadername=X-Storage-Pass + +# Specify http header name for carrying identity information +# Mandatory objectstorage.swift.tempauth.userheadername=X-Storage-User +# ================================ ObjectStorage on Swift with Keystone 2 Auth ============================== +# Similar to tempAuth +# Mandatory if you choose keystone 2 auth +# objectstorage.swift.keystone2.username=tester +# Mandatory if you choose keystone 2 auth +# objectstorage.swift.keystone2.tenantname=test + +# ================================ ObjectStorage on Swift with Keystone 3 Auth ============================== +# Specifying identity information with Keystone 3 Auth +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.user.name=demo +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.user.domain=Default +# Mandatory if you choose keystone 3 auth +# objectstorage.swift.keystone3.scope.domainid=default + +# Specifying project information in KeyStone 3 Auth (similar to tenant in KeyStone 2) +# Optional +# objectstorage.swift.keystone3.scope.project.name=test +# Optional +# objectstorage.swift.keystone3.scope.project.domainname=Default +# Optional +# objectstorage.swift.keystone3.scope.project.domainid=default + +# ========================================= ObjectStorage on S3 ============================================= +# Mandatory if you choose aws-s3 storage service, S3 authentication endpoint +# objectstorage.s3.endPoint=http://james-s3:8000 +# Mandatory if you choose aws-s3 storage service, access key id configured in S3 +# objectstorage.s3.accessKeyId=accessKey + +# Mandatory if you choose aws-s3 storage service, secret key configured in S3 +# objectstorage.s3.secretKey=secretKey + +# ============================================ Blobs Exporting ============================================== +# Choosing blob exporting mechanism, allowed mechanism are: localFile, linshare +# LinShare is a file sharing service, will be explained in the below section +# Optional, default is localFile blob.export.implementation=localFile -blob.export.localFile.directory=file://var/blobExporting \ No newline at end of file + +# ======================================= Local File Blobs Exporting ======================================== +# Optional, directory to store exported blob, directory path follows James file system format +# default is file://var/blobExporting +blob.export.localFile.directory=file://var/blobExporting + +# ======================================= LinShare File Blobs Exporting ======================================== +# LinShare is a sharing service where you can use james, connects to an existing LinShare server and shares files to +# other mail addresses as long as those addresses available in LinShare. For example you can deploy James and LinShare +# sharing the same LDAP repository +# Mandatory if you choose LinShare, url to connect to LinShare service +# blob.export.linshare.url=http://linshare:8080 + +# Mandatory if you choose LinShare, access token to connect to LinShare service. It will be formalized to `Bearer` + a space + access token +# So, no need to pass (`Bearer` + <space>) prefix +# blob.export.linshare.token=LinShare-Access-Token-In-String --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
