Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/object-storage.rst @ 766:73ee8a489b24

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
object-storage: EnableLegacyUnknownFiles
author Alain Mazy <am@osimis.io>
date Mon, 06 Sep 2021 17:09:52 +0200
parents b2b1ba11faaa
children c55ab0604d10
comparison
equal deleted inserted replaced
765:608f168fc13b 766:73ee8a489b24
132 ^^^^^^^^^^^^^ 132 ^^^^^^^^^^^^^
133 133
134 Sample configuration:: 134 Sample configuration::
135 135
136 "AwsS3Storage" : { 136 "AwsS3Storage" : {
137 "BucketName": "test-orthanc-s3-plugin", 137 "BucketName": "test-orthanc-s3-plugin",
138 "Region" : "eu-central-1", 138 "Region" : "eu-central-1",
139 "AccessKey" : "AKXXX", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0) 139 "AccessKey" : "AKXXX", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0)
140 "SecretKey" : "RhYYYY", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0) 140 "SecretKey" : "RhYYYY", // optional: if not specified, the plugin will use the default credentials manager (available from version 1.3.0)
141 "Endpoint": "", // optional: custom endpoint 141 "Endpoint": "", // optional: custom endpoint
142 "ConnectionTimeout": 30, // optional: connection timeout in seconds 142 "ConnectionTimeout": 30, // optional: connection timeout in seconds
143 "RequestTimeout": 1200, // optional: request timeout in seconds (max time to upload/download a file) 143 "RequestTimeout": 1200, // optional: request timeout in seconds (max time to upload/download a file)
144 "RootPath": "", // optional: see below 144 "RootPath": "", // optional: see below
145 "MigrationFromFileSystemEnabled": false, // optional: see below 145 "MigrationFromFileSystemEnabled": false, // optional: see below
146 "StorageStructure": "flat", // optional: see below 146 "StorageStructure": "flat", // optional: see below
147 "EnableLegacyUnknownFiles": true, // optional: see below
147 "VirtualAddressing": true, // optional: see the section related to MinIO 148 "VirtualAddressing": true, // optional: see the section related to MinIO
148 "StorageEncryption" : {} // optional: see the section related to encryption 149 "StorageEncryption" : {} // optional: see the section related to encryption
149 } 150 }
150 151
151 The **EndPoint** configuration is used when accessing an S3 compatible cloud provider. I.e. here is a configuration to store data on Scaleway:: 152 The **EndPoint** configuration is used when accessing an S3 compatible cloud provider. I.e. here is a configuration to store data on Scaleway::
222 "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxxxxxxxx;AccountKey=yyyyyyyy===;EndpointSuffix=core.windows.net", 223 "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxxxxxxxx;AccountKey=yyyyyyyy===;EndpointSuffix=core.windows.net",
223 "ContainerName" : "test-orthanc-storage-plugin", 224 "ContainerName" : "test-orthanc-storage-plugin",
224 "CreateContainerIfNotExists": true, // available from version 1.2.0 225 "CreateContainerIfNotExists": true, // available from version 1.2.0
225 "RootPath": "", // see below 226 "RootPath": "", // see below
226 "MigrationFromFileSystemEnabled": false, // see below 227 "MigrationFromFileSystemEnabled": false, // see below
227 "StorageStructure": "flat" // see below 228 "StorageStructure": "flat", // see below
229 "EnableLegacyUnknownFiles": true // optional: see below
228 } 230 }
229 231
230 232
231 Google Storage plugin 233 Google Storage plugin
232 ^^^^^^^^^^^^^^^^^^^^^ 234 ^^^^^^^^^^^^^^^^^^^^^
236 "GoogleCloudStorage" : { 238 "GoogleCloudStorage" : {
237 "ServiceAccountFile": "/path/to/googleServiceAccountFile.json", 239 "ServiceAccountFile": "/path/to/googleServiceAccountFile.json",
238 "BucketName": "test-orthanc-storage-plugin", 240 "BucketName": "test-orthanc-storage-plugin",
239 "RootPath": "", // see below 241 "RootPath": "", // see below
240 "MigrationFromFileSystemEnabled": false, // see below 242 "MigrationFromFileSystemEnabled": false, // see below
241 "StorageStructure": "flat" // see below 243 "StorageStructure": "flat", // see below
244 "EnableLegacyUnknownFiles": true // optional: see below
242 } 245 }
243 246
244 247
245 Migration & Storage structure 248 Migration & Storage structure
246 ----------------------------- 249 -----------------------------
271 object storage. Note that Orthanc is not copying the files from one storage to the other; you'll 274 object storage. Note that Orthanc is not copying the files from one storage to the other; you'll
272 have to use a standard ``sync`` command from the object-storage provider. 275 have to use a standard ``sync`` command from the object-storage provider.
273 276
274 A migration script from File System to Azure Blob Storage is available courtesy of `Steve Hawes <https://github.com/jodogne/OrthancContributed/blob/master/Scripts/Migration/2020-09-08-TransferToAzure.sh>`__ . 277 A migration script from File System to Azure Blob Storage is available courtesy of `Steve Hawes <https://github.com/jodogne/OrthancContributed/blob/master/Scripts/Migration/2020-09-08-TransferToAzure.sh>`__ .
275 278
279 The **EnableLegacyUnknownFiles** configuration has been introduced to allow recent version of the plugins (from 1.3.3)
280 continue working with data that was saved with Orthanc version around 1.9.3 and plugins version around 1.2.0 (e.g. osimis/orthanc:21.5.1 docker images).
281 With these specific versions, some ``.unk`` files were generated instead of ``.dcm.head`` files. With this configuration option enabled,
282 when reading files, the plugin will try both file extensions.
283 If you have ``.unk`` files in your storage, you must enable this configuration.
276 284
277 Sample setups 285 Sample setups
278 ------------- 286 -------------
279 287
280 You'll find sample deployments and more info in the `Orthanc Setup Samples repository <https://bitbucket.org/osimis/orthanc-setup-samples/src/master/#markdown-header-for-osimisorthanc-pro-image-users>`__ . 288 You'll find sample deployments and more info in the `Orthanc Setup Samples repository <https://bitbucket.org/osimis/orthanc-setup-samples/src/master/#markdown-header-for-osimisorthanc-pro-image-users>`__ .