mobiletto 1.1.10 → 1.1.13

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 +74 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +25 -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 +13 -9
  116. package/util/redis.js +2 -2
@@ -0,0 +1,481 @@
1
+ Mobilettu
2
+ =========
3
+
4
+ Mobiletto hè una strata di astrazione di almacenamiento JavaScript, cù una criptografia trasparente opzionale da u cliente.
5
+
6
+ # Cuntinutu
7
+ * [Perchè Mobiletto?](#Perchè-Mobiletto?)
8
+ * [Inizio rapidu](#Inizio rapidu)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Installazione](#Installazione)
12
+ * [Supportu è Finanziamentu](#Supportu-è-Fundamentu)
13
+ * [Usu di basa](#Usu di basa)
14
+ * [Metadata](#Metadata)
15
+ * [Stile d'importazione alternativu](#Stile d'importazione alternativu)
16
+ * [Caching](#Caching)
17
+ * [Mirroring](#Mirroring)
18
+ * [Cittografia trasparente](#Crittografia-trasparente)
19
+ * [Rotazione di chjave](#Rotazione di chjave)
20
+ * [Interfaccia Driver](#Driver-interface)
21
+ * [Logging](#Logging)
22
+
23
+ # Leghjite questu in un'altra lingua
24
+ Stu documentu README.md hè statu traduttu, via [hokeylization](https://github.com/cobbzilla/hokeylization), in
25
+ **[tutte lingue supportate da Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Sò sicuru chì ùn hè micca perfettu, ma spergu chì hè megliu cà nunda !
28
+
29
+ [🇸🇦 Arabu](../ar/README.md)
30
+ [🇧🇩 Bengali](../bn/README.md)
31
+ [🇩🇪 Tedesco](../de/README.md)
32
+ [🇺🇸 Inglese](../en/README.md)
33
+ [🇪🇸 Spagnolo](../es/README.md)
34
+ [🇫🇷 Francese](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 Hindi](../hi/README.md)
37
+ [🇮🇩 Indonesian](../id/README.md)
38
+ [🇮🇹 Italian](../it/README.md)
39
+ [🇯🇵 Giapponese](../ja/README.md)
40
+ [🇰🇷 Coreano](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 Polacco](../pl/README.md)
43
+ [🇧🇷 Portoghese](../pt/README.md)
44
+ [🇷🇺 Russu](../ru/README.md)
45
+ [🇰🇪 Swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 Turcu](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 Vietnamita](../vi/README.md)
50
+ [🇨🇳 Cinese](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Tutte e lingue ...](../README.md)**
54
+ ----
55
+
56
+ ### Ci hè un prublema cù sta traduzzione di u README ?
57
+ Questa traduzzione particulare di u [README] originale (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ pò esse difettu -- * e currezzione sò assai benvenute ! * Mandate una [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ o se ùn site micca còmode di fà quessa, [apre un prublema](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Quandu create un novu prublema GitHub nantu à una traduzzione, fate:
62
+ * include l'URL di a pagina (copia / incollà da a barra di indirizzu di u navigatore)
63
+ * include u testu esatta chì hè sbagliatu (copia / incollà da u navigatore)
64
+ * per piacè descrivi ciò chì hè sbagliatu -- a traduzzione hè sbagliata? a formattazione hè rotta in qualchì modu?
65
+ * Per piacè offre un suggerimentu di una traduzzione megliu, o cumu u testu deve esse furmatu bè
66
+ * **Grazie!**
67
+
68
+ ## Perchè Mobiletto ?
69
+
70
+ ### Adiu lock-in di u venditore!
71
+ I vari fornitori di almacenamiento in nuvola anu API incompatibili. Ancu quelli chì lottanu per a "compatibilità S3"
72
+ avè cumpurtamenti idiosincratici.
73
+
74
+ Quandu sceglite un venditore di almacenamiento particulari per a vostra app, se codificate direttamente à a so API, a vostra app
75
+ avà dipende di stu serviziu. Quandu u tempu passa è u codice s'accumula, i venditori cambianti diventanu
76
+ sempre più insostenibile. Benvenuti à u mondu divertente di u lock-in di u venditore!
77
+
78
+ Mobiletto hè statu cuncepitu per risolve stu prublema. Codificà a vostra app à l'API di mobiletto, pudete facilmente
79
+ cambia i fornitori di almacenamentu è sapete chì a strata di almacenamentu di a vostra app si comporta in modu identicu.
80
+
81
+ ### Teste estensive
82
+ Tutti i cunduttori sò testati per un cumpurtamentu identicu cù più di 60 teste per ogni cunduttore.
83
+ Testemu tutti i cunduttori cù ogni cumminazione di:
84
+ * Cifratura: sia attivata sia disattivata
85
+ * Cache Redis: sia attivata sia disattivata
86
+
87
+ Stu approcciu ci dà a pace di mente chì u mobiletto si cumportarà u listessu, indipendentemente da quale driver utilizate,
88
+ è indipendentemente da esse attivate a cache è / o a criptografia.
89
+
90
+ ### Supportu di i cunduttori
91
+ Drivers di almacenamento Mobiletto attuali:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : sistema di fugliale locale
95
+
96
+ * I cuntributi per sustene più fornitori di almacenamentu in nuvola sò assai benvenuti ! *
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto hè destinatu à esse usatu cum'è una biblioteca da un altru codice JavaScript.
100
+
101
+ Per travaglià cù mobiletto à a linea di cummanda, utilizate [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Fonte
104
+ * [mobiletto in GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Supportu è Finanziamentu
108
+ Aghju pruvatu à esse un sviluppatore prufessiunale di software open source. Aghju travagliatu in
109
+ l'industria di u software per parechji anni, aghju principiatu cumpagnie di successu è li vende à cumpagnie publica.
110
+ Recentemente aghju persu u mo travagliu, è ùn aghju micca veramente un altru travagliu in linea
111
+
112
+ Dunque, aghju da pruvà à scrive un software utile è vede s'ellu funziona
113
+
114
+ Se ti piace à utilizà stu software, saraghju assai ringraziatu ancu per u
115
+ più chjucu [cuntribuzione mensuale via Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Grazie!*
118
+
119
+ ## Installazione
120
+ Installa cù `npm` o `yarn` . Probabilmente vulete a versione `lite` " chì ùn include micca tutti i
121
+ i file README tradotti:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Se vulete veramente i schedari README in ogni lingua, installate a versione completa:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Inizio rapidu
132
+ Un brevi esempiu utilizendu u driver mobiletto `s3` .
133
+
134
+ Stu codice correrà u listessu se u driver era `b2` o `local` .
135
+
136
+ const storage = require('mobiletto')
137
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
+
139
+ // list objects: returns array of metadata objects
140
+ const listing = await bucket.list()
141
+ const dirList = await bucket.list('some/dir/')
142
+ const everything = await bucket.list('', {recursive: true})
143
+
144
+ // write an entire file
145
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
+
147
+ // write a file from a stream/generator
148
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
+
150
+ // read an entire file
151
+ // returns null if an exception would otherwise be thrown
152
+ const bufferOrNull = await bucket.safeReadFile('some/path')
153
+
154
+ // stream-read a file, passing data to callback
155
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
+
157
+ // remove a file, returns the path removed
158
+ let removed = await bucket.remove('some/path') // removed is a string
159
+
160
+ // remove a directory, returns array of paths removed
161
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
+
163
+ ----
164
+ ## Usu di basa
165
+ Un esempiu assai più estensivu, chì mostra a maiò parte di e caratteristiche offerte:
166
+
167
+ const { mobiletto } = require('mobiletto')
168
+
169
+ // General usage
170
+ const api = await mobiletto(driverName, key, secret, opts)
171
+
172
+ // To use 'local' driver:
173
+ // * key: base directory
174
+ // * secret: ignored, can be null
175
+ // * opts object:
176
+ // * readOnly: optional, never change anything on the filesystem; default is false
177
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
+
181
+ // To use 's3' driver:
182
+ // * key: AWS Access Key ID
183
+ // * secret: AWS Secret Key
184
+ // * opts object:
185
+ // * readOnly: optional, never change anything on the bucket; default is false
186
+ // * bucket: required, name of the S3 bucket
187
+ // * region: optional, the AWS region to communicate with, default is us-east-1
188
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
+
192
+ // To use 'b2' driver:
193
+ // * key: Backblaze Key ID
194
+ // * secret: Backblaze Application Key
195
+ // * opts object:
196
+ // * readOnly: optional, never change anything on the bucket; default is false
197
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
198
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
+ // * partSize: optional, large files will be split into chunks of this size when uploading
201
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
+
203
+ // List files
204
+ api.list() // --> returns an array of metadata objects
205
+
206
+ // List files recursively
207
+ api.list({ recursive: true })
208
+
209
+ // List files in a directory
210
+ const path = 'some/path'
211
+ api.list(path)
212
+ api.list(path, { recursive: true }) // also supports recursive flag
213
+
214
+ // Visit files in a directory -- visitor function must be async
215
+ api.list(path, { visitor: myAsyncFunc })
216
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
217
+
218
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
219
+ // When you call `safeList` on a non-existent path, it returns an empty array
220
+ api.safeList('/path/that/does/not/exist') // returns []
221
+
222
+ // Read metadata for a file
223
+ api.metadata(path) // returns metadata object
224
+
225
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
+ // When you call `safeMetadata` on a non-existent path, it returns null
227
+ api.safeMetadata('/tmp/does_not_exist') // returns null
228
+
229
+ // Read a file
230
+ // Provide a callback that writes the data someplace
231
+ const callback = (chunk) => { ... write chunk somewhere ... }
232
+ api.read(path, callback) // returns count of bytes read
233
+
234
+ // Read an entire file at once
235
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
+
237
+ // Read an entire file at once
238
+ // returns null if an exception would otherwise be thrown
239
+ const bufferOrNull = await bucket.safeReadFile('some/path')
240
+
241
+ // Write a file
242
+ // Provide a generator function that yields chunks of data
243
+ const generator = function* () {
244
+ while ( ... more-data-to-return ... ) {
245
+ data = ... load-data ...
246
+ yield data
247
+ }
248
+ }
249
+ local.api(path, generator) // returns count of bytes written
250
+
251
+ // Write an entire file at once (convenience method)
252
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
253
+
254
+ // Delete a file
255
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
+ // Always returns a value or throws an error.
257
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
+ const quiet = true
259
+ api.remove(path, {quiet}) // returns single path removed
260
+
261
+ // Recursively delete a directory and do it quietly (do not report errors)
262
+ const recursive = true
263
+ const quiet = true
264
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
265
+
266
+ ## Metadata
267
+ U cumandamentu `metadata` torna metadata nantu à una sola entrata di sistema di filesystem.
268
+ In listessu modu, u valore di ritornu da u cumandamentu `list` hè un array di oggetti di metadata.
269
+
270
+ Un oggettu di metadata s'assumiglia cusì:
271
+
272
+ {
273
+ "name": "fully/qualified/path/to/file",
274
+ "type": "entry-type",
275
+ "size": size-in-bytes,
276
+ "ctime": creation-time-epoch-millis,
277
+ "mtime": modification-time-epoch-millis
278
+ }
279
+
280
+ A pruprietà `type` pò esse `file` , `dir` , `link` , o `special` .
281
+
282
+ Sicondu u tipu di driver, un cumandamentu `list` pò micca restituverà tutti i campi. E `name` è `type`
283
+ deve esse sempre presente. Un cumandamentu `metadata` sussegwente restituverà tutte e pruprietà dispunibili.
284
+
285
+ ## Stile d'importazione alternativu
286
+ Impurtà u modulu cumpletu cumpletu è utilizate a funzione `connect` :
287
+
288
+ const storage = require('mobiletto')
289
+ const opts = {bucket: 'bk', region: 'us-east-1'}
290
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
+ const objectData = await s3.readFile('some/path')
292
+
293
+ ## Caching
294
+ Mobiletto funziona megliu cù una cache <a href="https://redis.io">redis</a> .
295
+
296
+ Mobiletto pruverà à cunnette à una istanza redis in 127.0.0.1:6379
297
+
298
+ Pudete annullà unu di questi:
299
+ * Impostate l'env var `MOBILETTO_REDIS_HOST` , mobiletto cunnetta quì invece di localhost
300
+ * Stabilite u `MOBILETTO_REDIS_PORT` env var, stu portu serà utilizatu
301
+
302
+ Mobiletto salvarà tutte e so chjave redis cù u prefissu `_mobiletto__` . Pudete cambià questu
303
+ insettendu u `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Pudete ancu stabilisce a cache per cunnessione cù l'ughjettu `opts.redisConfig` :
306
+
307
+ const redisConfig = {
308
+ enabled: true, // optional, default is true. if false other props are ignored
309
+ host: '127.0.0.1',
310
+ port: 6379,
311
+ prefix: '_mobiletto__'
312
+ }
313
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
+
316
+ ### Ùn vogliu micca caching redis ?
317
+ Per disattivà: passate `enabled: false` in u vostru ughjettu `opts.redisConfig` quandu stabilisce a vostra cunnessione.
318
+
319
+ Comu discutitu quì sottu, disattivà a cache averà un effettu avversu nantu à u rendiment è incurrà più richieste
320
+ à u almacenamentu chì avete veramente bisognu.
321
+
322
+ ### Guida di caching
323
+ **Almacenamiento criptatu**: a lettura/scrittura di u almacenamentu criptatu hè solu un pocu più lento di u normale,
324
+ ma a navigazione intornu à i cartulari (chì alcune cose facenu) hè abbastanza caru. Utilizendu una cache redis
325
+ vi darà un impulsu significativu di rendiment.
326
+
327
+ A cache predeterminata hè sicura, ma ùn funziona micca bè si avete assai operazioni di scrittura / rimuzione.
328
+ Ogni operazione di scrittura o rimozione invalida tutta a cache, assicurendu chì e letture successive vedenu u
329
+ l'ultimi cambiamenti.
330
+
331
+ ### Strumenti CLI
332
+ Sè vo aduprate un strumentu CLI cum'è [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ Definitivamente vulete chì a cache di redis sia attivata, postu chì dura in l'invucazioni di u cumandamentu `mo` .
334
+
335
+ ## Mirroring
336
+
337
+ // Copy a local filesystem mobiletto to S3
338
+ s3.mirror(local)
339
+
340
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
+
343
+ U cumandamentu `mirror` una copia unica di tutti i schedari da un mobiletto à l'altru.
344
+ Ùn eseguisce nisun prucessu per mantene u specchiu cù u tempu. `mirror` di novu
345
+ per sincronizà qualsiasi fugliali mancanti.
346
+
347
+ U valore di ritornu da `mirror` hè un ughjettu simplice cù cuntatori per quanti schedari sò stati successu
348
+ mirrored è quanti schedari avianu errore:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ AVVERTENZA: Mirroring setti grandi di dati pò esse assai tempu è intensivi in larghezza di banda
356
+
357
+ Cù a `mirror` " pò esse cunfusu per capisce quale hè u
358
+ lettore è quale hè u scrittore. Immaginate cum'è una dichjarazione di assignazione: u "mobiletto di manca"
359
+ hè a cosa chì hè attribuita à (dati specchiati scritti), è u "mobiletto à destra" (u
360
+ argumentu à u metudu `mirror` ) hè u valore chì hè assignatu (i dati specchi sò letti).
361
+
362
+ ## Criptazione trasparente
363
+ Abilita a criptografia trasparente di u cliente:
364
+
365
+ // Pass encryption parameters
366
+ const encryption = {
367
+ // key is required, must be >= 16 chars
368
+ key: randomstring.generate(128),
369
+
370
+ // optional, the default is to derive IV from key
371
+ // when set, IV must be >= 16 chars
372
+ iv: randomstring.generate(128),
373
+
374
+ // optional, the default is aes-256-cbc
375
+ algo: 'aes-256-cbc'
376
+ }
377
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
378
+
379
+ // Subsequent write operations will encrypt data (client side) when writing
380
+ // Subsequent read operations will decrypt data (client side) when reading
381
+
382
+ Chì succede ? Un repertoriu separatu di "entrata di u repertoriu" (direttivu) (cifratu) traccia ciò chì i schedari sò in questu
383
+ annuariu (aka u cartulare dirent).
384
+ * U cumandamentu `list` leghje i fugliali di entrata di u cartulare, decripta ogni percorsu listatu; poi torna metadata per ogni schedariu
385
+ * I cumandamenti `list` sò più inefficienti, in particulare per i cartulari cù un gran numaru di schedari
386
+ * U cumandimu `write` scrive i fugliali dirent in u cartulare dirent di ogni genitore, recursivamente; poi scrive u schedariu
387
+ * I cumandamenti `write` O (N) scrive, cù N = prufundità in a ghjerarchia di u cartulare
388
+ * U cumandamentu `remove` elimina u schedariu dirent currispundente, è u so parente s'ellu hè viotu, recursivamente; poi sguassate u schedariu
389
+ * I cumandamenti "rimuove" non-recursivi `remove` O (N) letture è potenzalmentu quant'è eliminazioni, cù N = prufundità in a ghjerarchia di u cartulare
390
+ * I cumandamenti recursivi `remove` nantu à i sistemi di fugliali grandi è profondi ponu esse caru
391
+
392
+ Nota chì ancu cù a criptografia di u cliente attivata, un avversariu cù visibilità cumpleta in u vostru latu di u servitore criptatu.
393
+ almacenamiento, ancu senza a chjave, pò sempre vede u numeru tutali di cartulari è quanti schedari sò in ognunu, è cù
394
+ qualchì sforzu, scopre una parte o tutta a struttura generale di a ghjerarchia di u repertoriu.
395
+ * Nota: Aduprate una struttura relativamente piatta per una sicurità megliu.*
396
+ L'avversu ùn sapia micca i nomi di i cartulari / fugliali, salvu ch'elli anu cunnisciutu ancu a vostra criptografia
397
+ chjave o avia altrimenti crackatu cù successu a criptografia. Allora tutte e scumesse sò spente!
398
+
399
+ ### Prestazione è cache
400
+ L'operazioni nantu à l'almacenamiento criptatu ponu esse lente. Elenchi recursivi è rimozioni ponu esse assai lenti.
401
+ Caching via redis aiuta tremendamente, ma nutate chì a cache hè sguassata annantu à qualsiasi scrittura o eliminazione.
402
+
403
+ ## Rotazione di chjave
404
+ Crea un mobiletto cù a vostra nova chjave, poi riflette i vechji dati in questu:
405
+
406
+ const storage = require('mobiletto')
407
+
408
+ const oldEncryption = { key: .... }
409
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
+
411
+ const newEncryption = { key: .... }
412
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
+
414
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
+
416
+ ## Interfaccia di driver
417
+ Un driver hè qualsiasi fugliale JS chì esporta una funzione "storageClient" cù questa firma:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : una stringa, a vostra chjave API (per u driver `local` questu hè u cartulare di basa)
422
+ * `secret` : una stringa, u vostru secretu API (pò esse omessi per u driver `local` )
423
+ * `opts` : un oggettu, e proprietà sò per driver:
424
+ * Per `local` , e `fileMode` è `dirMode` determinanu cumu si creanu novi fugliali è cartulari di creazione
425
+ * Per `s3` , a pruprietà `bucket` hè necessaria. Proprietà opzionali sò:
426
+ * `region`: the S3 region, default is us-east-1
427
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
+ * `delimiter`: the directory delimiter, default is '/'
429
+
430
+ L'ughjettu chì torna a funzione storageClient deve definisce queste funzioni:
431
+
432
+ // Test the driver before using, ensure proper configuration
433
+ async testConfig ()
434
+
435
+ // List files in path (or from base-directory)
436
+ // If recursive is true, list recursively
437
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
438
+ // Otherwise, perform the listing and return an array of objects
439
+ async list (path, recursive = false, visitor = null) // path may be omitted
440
+
441
+ // Read metadata for a path
442
+ async metadata (path)
443
+
444
+ // Read a file
445
+ // callback receives a chunk of data. endCallback is called at end-of-stream
446
+ async read (path, callback, endCallback = null)
447
+
448
+ // Write a file
449
+ // driver must be able to handle a generator or a stream
450
+ async write (path, generatorOrReadableStream)
451
+
452
+ // Remove a file, or recursively delete a directory
453
+ // returns a string of a single path removed, or an array of multiple paths removed
454
+ async remove (path, recursive = false, quiet = false)
455
+
456
+ ## Logging
457
+ Mobiletto usa a libreria di log [winston](https://www.npmjs.com/package/winston).
458
+
459
+ I logs **conteneranu ** percorsi di fugliali è missaghji d'errore, ma **mai** cuntenenu chjave, secreti,
460
+ o qualsiasi altra infurmazione di cunfigurazione di cunnessione.
461
+
462
+ ### Livellu di log
463
+ Aduprate a variabile d'ambiente `MOBILETTO_LOG_LEVEL` per stabilisce u livellu di log, usendu unu
464
+ di i livelli `npm` definiti in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ U livellu predeterminatu hè `error` . U livellu più verbose hè `silly` , ancu s'ellu hè attualmente mobiletto
467
+ ùn registra micca à i livelli sottu à `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### File di log
472
+ Per automaticamente, u logger scrive à a cunsola. Per mandà logs à un schedariu, stabilisce u `MOBILETTO_LOG_FILE`
473
+ variabile ambientale. Quandu si accede à un schedariu, i logs ùn saranu più scritti à a cunsola.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Per disattivà u logu:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>