mobiletto 1.1.10 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +48 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +12 -9
  116. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobileto est une couche d'abstraction de stockage JavaScript, avec un chiffrement transparent côté client en option.
5
+
6
+ # Contenu
7
+ * [Pourquoi Mobiletto ?](#Pourquoi-Mobiletto ?)
8
+ * [Démarrage rapide](#Démarrage rapide)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Utilisation de base](#Basic-usage)
12
+ * [Métadonnées](#Métadonnées)
13
+ * [Style d'importation alternatif](#Alternate-import-style)
14
+ * [Mise en cache](#Mise en cache)
15
+ * [Mise en miroir](#Mise en miroir)
16
+ * [Cryptage transparent](#Transparent-encryption)
17
+ * [Rotation des clés](#Rotation des clés)
18
+ * [Interface pilote](#Interface pilote)
19
+ * [Journalisation](#Journalisation)
20
+
21
+ # Lire ceci dans une autre langue
22
+ Ce document README.md a été traduit, via [hokeylization](https://github.com/cobbzilla/hokeylization), en
23
+ **[toutes les langues prises en charge par Google Translate](https://cloud.google.com/translate/docs/languages) !**
24
+
25
+ Je suis certain que ce n'est pas parfait, mais j'espère que c'est mieux que rien !
26
+
27
+ [🇸🇦 Arabe](../ar/README.md)
28
+ [🇧🇩 bengali](../bn/README.md)
29
+ [🇩🇪 allemand](../de/README.md)
30
+ [🇺🇸 Anglais](../en/README.md)
31
+ [🇪🇸 Espagnol](../es/README.md)
32
+ [🇫🇷 Français](../fr/README.md)
33
+ [🇹🇩 Haoussa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonésien](../id/README.md)
36
+ [🇮🇹 Italien](../it/README.md)
37
+ [🇯🇵 japonais](../ja/README.md)
38
+ [🇰🇷 coréen](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 polonais](../pl/README.md)
41
+ [🇧🇷 portugais](../pt/README.md)
42
+ [🇷🇺 russe](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turc](../tr/README.md)
46
+ [🇵🇰 Ourdou](../ur/README.md)
47
+ [🇻🇳 Vietnamien](../vi/README.md)
48
+ [🇨🇳 chinois](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Toutes les langues ...](../README.md)**
52
+ ----
53
+
54
+ ### Y a-t-il un problème avec cette traduction du README ?
55
+ Cette traduction particulière de l'original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ peut être défectueux -- *les corrections sont les bienvenues !* Veuillez envoyer une [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ou si vous n'êtes pas à l'aise pour le faire, [ouvrez un problème](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Lorsque vous créez un nouveau ticket GitHub à propos d'une traduction, veuillez faire :
60
+ * inclure l'URL de la page (copier/coller depuis la barre d'adresse du navigateur)
61
+ * inclure le texte exact qui est erroné (copier/coller depuis le navigateur)
62
+ * veuillez décrire ce qui ne va pas -- la traduction est-elle incorrecte ? le formatage est-il cassé d'une manière ou d'une autre ?
63
+ * veuillez suggérer une meilleure traduction, ou comment le texte doit être correctement formaté
64
+ * **Merci!**
65
+
66
+ ## Pourquoi Mobiletto ?
67
+
68
+ ### Adieu la dépendance vis-à-vis des fournisseurs !
69
+ Les différents fournisseurs de stockage cloud ont des API incompatibles. Même ceux qui aspirent à la "compatibilité S3"
70
+ ont des comportements idiosyncratiques.
71
+
72
+ Lorsque vous choisissez un fournisseur de stockage particulier pour votre application, si vous codez directement dans son API, votre application
73
+ dépend maintenant de ce service. Au fur et à mesure que le temps passe et que le code s'accumule, changer de fournisseur devient
74
+ de plus en plus intenable. Bienvenue dans le monde amusant du verrouillage des fournisseurs !
75
+
76
+ Mobileto a été conçu pour résoudre ce problème. En codant votre application avec l'API de mobiletto, vous pouvez facilement
77
+ changez de fournisseur de stockage et sachez que la couche de stockage de votre application se comportera de manière identique.
78
+
79
+ ### Tests approfondis
80
+ Tous les pilotes sont testés pour un comportement identique avec plus de 60 tests pour chaque pilote.
81
+ Nous testons tous les pilotes avec chaque combinaison de :
82
+ * Cryptage : activé et désactivé
83
+ * Cache Redis : activé et désactivé
84
+
85
+ Cette approche nous donne la tranquillité d'esprit que mobiletto se comportera de la même manière quel que soit le pilote que vous utilisez,
86
+ et que vous activiez ou non la mise en cache et/ou le chiffrement.
87
+
88
+ ### Prise en charge des pilotes
89
+ Pilotes de stockage Mobileto actuels :
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : système de fichiers local
93
+
94
+ *Les contributions pour soutenir plus de fournisseurs de stockage cloud sont les bienvenues !*
95
+
96
+ ## mobiletto-cli
97
+ Mobileto est destiné à être utilisé comme bibliothèque par d'autres codes JavaScript.
98
+
99
+ Pour travailler avec mobiletto en ligne de commande, utilisez [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## La source
102
+ * [mobiletto sur GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto sur npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Démarrage rapide
106
+ Un court exemple utilisant le pilote mobiletto `s3` .
107
+
108
+ Ce code fonctionnerait de la même manière si le pilote était `b2` ou `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Utilisation de base
139
+ Un exemple beaucoup plus complet, montrant la plupart des fonctionnalités offertes :
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Métadonnées
241
+ La commande `metadata` renvoie des métadonnées sur une seule entrée de système de fichiers.
242
+ De même, la valeur de retour de la commande `list` est un tableau d'objets de métadonnées.
243
+
244
+ Un objet de métadonnées ressemble à ceci :
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ La propriété `type` peut être `file` , `dir` , `link` ou `special` .
255
+
256
+ Selon le type de pilote, une commande `list` peut ne pas renvoyer tous les champs. Les propriétés `name` name` et `type`
257
+ doit toujours être présent. Une commande `metadata` ultérieure renverra toutes les propriétés disponibles.
258
+
259
+ ## Style d'importation alternatif
260
+ Importez le module complet et utilisez la fonction `connect` " :
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Mise en cache
268
+ Mobileto fonctionne mieux avec un cache <a href="https://redis.io">Redis</a> .
269
+
270
+ Mobileto tentera de se connecter à une instance redis sur 127.0.0.1:6379
271
+
272
+ Vous pouvez remplacer l'un ou l'autre :
273
+ * Définissez la `MOBILETTO_REDIS_HOST` , mobiletto se connecte ici au lieu de localhost
274
+ * Définissez la `MOBILETTO_REDIS_PORT` , ce port sera utilisé
275
+
276
+ Mobileto stockera toutes ses clés redis avec le préfixe `_mobiletto__` . Vous pouvez changer cela
277
+ en définissant la variable d'environnement `MOBILETTO_REDIS_PREFIX` .
278
+
279
+ Vous pouvez également définir la mise en cache par connexion avec l'objet `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Vous ne voulez pas de mise en cache Redis ?
291
+ Pour désactiver : passez `enabled: false` dans votre objet `opts.redisConfig` lorsque vous établissez votre connexion.
292
+
293
+ Comme indiqué ci-dessous, la désactivation de la mise en cache aura un effet négatif sur les performances et entraînera davantage de requêtes
294
+ au stockage dont vous avez vraiment besoin.
295
+
296
+ ### Conseils de mise en cache
297
+ **Stockage crypté** : la lecture/écriture du stockage crypté n'est qu'un peu plus lente que la normale,
298
+ mais naviguer dans les répertoires (ce que font certaines choses) est assez coûteux. Utiliser un cache Redis
299
+ vous donnera une amélioration significative des performances.
300
+
301
+ Le cache par défaut est sûr, mais ne fonctionne pas bien si vous avez beaucoup d'opérations d'écriture/suppression.
302
+ Toute opération d'écriture ou de suppression invalide l'intégralité du cache, garantissant que les lectures suivantes verront le
303
+ dernières modifications.
304
+
305
+ ### Outils CLI
306
+ Si vous utilisez un outil CLI tel que [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ vous voudrez certainement que le cache redis soit activé, car il dure à travers les invocations de la commande `mo` .
308
+
309
+ ## Mise en miroir
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ La commande `mirror` effectue une copie unique de tous les fichiers d'un mobiletto à un autre.
318
+ Il n'exécute aucun processus pour maintenir le miroir dans le temps. Exécutez à nouveau la commande `mirror`
319
+ pour synchroniser les fichiers manquants.
320
+
321
+ La valeur de retour de `mirror` est un objet simple avec des compteurs pour le nombre de fichiers réussis
322
+ mis en miroir et combien de fichiers avaient des erreurs :
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ AVERTISSEMENT : la mise en miroir de grands ensembles de données peut prendre beaucoup de temps et consommer beaucoup de bande passante
330
+
331
+ Avec la sémantique d'appel `mirror` il peut parfois être déroutant de comprendre qui est le
332
+ lecteur et qui est l'auteur. Imaginez-le comme une déclaration d'affectation : le "mobiletto de gauche"
333
+ est la chose assignée (données en miroir écrites), et le "mobiletto de droite" (le
334
+ argument de la méthode `mirror` ) est la valeur assignée (les données en miroir sont lues).
335
+
336
+ ## Cryptage transparent
337
+ Activez le chiffrement transparent côté client :
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Que ce passe-t-il? Un répertoire séparé "d'entrée de répertoire" (dirent) (crypté) suit les fichiers qui se trouvent dans ce
357
+ répertoire (alias le répertoire dirent).
358
+ * La commande `list` lit les fichiers d'entrée de répertoire, décrypte chaque chemin répertorié ; renvoie ensuite les métadonnées de chaque fichier
359
+ * Les commandes `list` sont plus inefficaces, en particulier pour les répertoires contenant un grand nombre de fichiers
360
+ * La commande `write` écrit des fichiers directs dans le répertoire direct de chaque parent, de manière récursive ; puis écrit le fichier
361
+ * Les commandes `write` entraîneront O(N) écritures, avec N = profondeur dans la hiérarchie des répertoires
362
+ * La commande `remove` supprime le fichier dirent correspondant, et son parent s'il est vide, de manière récursive ; puis supprime le fichier
363
+ * Les commandes de `remove` non récursives entraîneront O (N) lectures et potentiellement autant de suppressions, avec N = profondeur dans la hiérarchie des répertoires
364
+ * Les commandes récursives `remove` sur des systèmes de fichiers volumineux et profonds peuvent être coûteuses
365
+
366
+ Notez que même avec le chiffrement côté client activé, un adversaire avec une visibilité totale sur votre côté serveur chiffré
367
+ le stockage, même sans la clé, peut toujours voir le nombre total de répertoires et le nombre de fichiers dans chacun, et avec
368
+ quelques efforts, découvrir tout ou partie de la structure globale de la hiérarchie des répertoires.
369
+ *Remarque : Utilisez une structure relativement plate pour une meilleure sécurité.*
370
+ L'adversaire ne connaîtrait pas les noms des répertoires/fichiers à moins qu'il ne connaisse également votre cryptage
371
+ clé ou avait autrement réussi à casser le cryptage. Tous les paris sont ouverts alors !
372
+
373
+ ### Performances et mise en cache
374
+ Les opérations sur le stockage chiffré peuvent être lentes. Les listes et les suppressions récursives peuvent être très lentes.
375
+ La mise en cache via redis aide énormément, mais notez que le cache est vidé lors de toute écriture ou suppression.
376
+
377
+ ## Rotation des clés
378
+ Créez un mobiletto avec votre nouvelle clé, puis copiez-y les anciennes données :
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Interface pilote
391
+ Un pilote est un fichier JS qui exporte une fonction 'storageClient' avec cette signature :
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : une chaîne, votre clé API (pour le pilote `local` c'est le répertoire de base)
396
+ * `secret` : une chaîne, votre secret d'API (peut être omis pour le pilote `local` )
397
+ * `opts` : un objet, les propriétés sont par pilote :
398
+ * Pour `local` , les propriétés `fileMode` et `dirMode` déterminent comment les nouveaux fichiers et répertoires sont créés
399
+ * Pour `s3` , la propriété `bucket` est requise. Les propriétés facultatives sont :
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ L'objet renvoyé par la fonction storageClient doit définir ces fonctions :
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Journalisation
431
+ Mobileto utilise la bibliothèque de journalisation [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Les journaux **contiendront** les chemins d'accès aux fichiers et les messages d'erreur, mais ne contiendront **jamais** de clés, de secrets,
434
+ ou toute autre information de configuration de connexion.
435
+
436
+ ### Niveau de journalisation
437
+ Utilisez la variable d'environnement `MOBILETTO_LOG_LEVEL` pour définir le niveau de journalisation, en utilisant un
438
+ des niveaux `npm` définis dans [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Le niveau par défaut est `error` . Le niveau le plus verbeux est `silly` , bien qu'actuellement mobiletto
441
+ ne se connecte pas aux niveaux inférieurs à `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Fichier journal
446
+ Par défaut, le logger écrit sur la console. Pour envoyer les journaux vers un fichier, définissez le `MOBILETTO_LOG_FILE`
447
+ variables d'environnement. Lors de la connexion à un fichier, les journaux ne seront plus écrits sur la console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Pour désactiver la journalisation :
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>