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
+ Mobiletto és una capa d'abstracció d'emmagatzematge de JavaScript, amb xifratge transparent opcional del costat del client.
5
+
6
+ # Continguts
7
+ * [Per què Mobiletto?](#Per què-Mobiletto?)
8
+ * [Inici ràpid](#Inici ràpid)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Font](#Font)
11
+ * [Ús bàsic](#Ús bàsic)
12
+ * [Metadades](#Metadades)
13
+ * [Estil d'importació alternatiu](#Estil d'importació alternatiu)
14
+ * [Memòria en memòria cau](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Xifrat transparent](#Transparent-encryption)
17
+ * [Rotació de tecles](#Rotació de tecles)
18
+ * [Interfície del controlador](#Interfície del controlador)
19
+ * [Registre](#Registre)
20
+
21
+ # Llegeix això en un altre idioma
22
+ Aquest document README.md s'ha traduït, mitjançant [hokeylization](https://github.com/cobbzilla/hokeylization), a
23
+ **[cada idioma compatible amb Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Estic segur que no és perfecte, però espero que sigui millor que res!
26
+
27
+ [🇸🇦 Àrab](../ar/README.md)
28
+ [🇧🇩 bengalí](../bn/README.md)
29
+ [🇩🇪 Alemany](../de/README.md)
30
+ [🇺🇸 Anglès](../en/README.md)
31
+ [🇪🇸 Espanyol](../es/README.md)
32
+ [🇫🇷 Francès](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 indonesi](../id/README.md)
36
+ [🇮🇹 italià](../it/README.md)
37
+ [🇯🇵 Japonès](../ja/README.md)
38
+ [🇰🇷 coreà](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polonès](../pl/README.md)
41
+ [🇧🇷 portuguès](../pt/README.md)
42
+ [🇷🇺 Rus](../ru/README.md)
43
+ [🇰🇪 suahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turc](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 vietnamita](../vi/README.md)
48
+ [🇨🇳 Xinès](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Tots els idiomes ...](../README.md)**
52
+ ----
53
+
54
+ ### Hi ha algun problema amb aquesta traducció del README?
55
+ Aquesta traducció particular de l'original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ pot ser defectuós -- *les correccions són molt benvingudes!* Envieu una [sol·licitud d'extracció a GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ o si no et sents còmode fent-ho, [obre un problema](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Quan creeu un nou problema de GitHub sobre una traducció, feu el següent:
60
+ * incloure l'URL de la pàgina (copiar/enganxar des de la barra d'adreces del navegador)
61
+ * inclou el text exacte que és incorrecte (copiar/enganxar des del navegador)
62
+ * si us plau, descriu què està malament: la traducció és incorrecta? el format està trencat d'alguna manera?
63
+ * Oferiu amablement un suggeriment d'una millor traducció o com s'hauria de formatar correctament el text
64
+ * **Gràcies!**
65
+
66
+ ## Per què Mobiletto?
67
+
68
+ ### Adéu bloqueig de venedors!
69
+ Els diferents proveïdors d'emmagatzematge al núvol tenen API incompatibles. Fins i tot aquells que s'esforcen per la "compatibilitat S3"
70
+ tenen comportaments idiosincràtics.
71
+
72
+ Quan trieu un proveïdor d'emmagatzematge concret per a la vostra aplicació, si codifiqueu directament a la seva API, la vostra aplicació
73
+ ara depèn d'aquest servei. A mesura que passa el temps i el codi s'acumula, els venedors esdevenen canviants
74
+ cada cop més insostenible. Benvingut al divertit món del bloqueig de venedors!
75
+
76
+ Mobiletto va ser dissenyat per resoldre aquest problema. Si codifiqueu la vostra aplicació a l'API de mobiletto, podeu fer-ho fàcilment
77
+ canvieu de proveïdor d'emmagatzematge i sàpiga que la capa d'emmagatzematge de la vostra aplicació es comportarà de la mateixa manera.
78
+
79
+ ### Extenses proves
80
+ Tots els conductors són provats per a un comportament idèntic amb més de 60 proves per a cada conductor.
81
+ Provem tots els controladors amb totes les combinacions de:
82
+ * Xifratge: tant activat com desactivat
83
+ * Memòria cau Redis: tant activada com desactivada
84
+
85
+ Aquest enfocament ens proporciona tranquil·litat que mobiletto es comportarà de la mateixa manera independentment del controlador que utilitzeu,
86
+ i independentment de si activeu la memòria cau i/o el xifratge.
87
+
88
+ ### Suport al conductor
89
+ Controladors d'emmagatzematge de Mobiletto actuals:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistema de fitxers local
93
+
94
+ *Les contribucions per donar suport a més proveïdors d'emmagatzematge al núvol són molt benvingudes!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto està pensat per ser utilitzat com a biblioteca per altres codis JavaScript.
98
+
99
+ Per treballar amb mobiletto a la línia d'ordres, utilitzeu [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Font
102
+ * [mobiletto a GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto a npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Començament ràpid
106
+ Un breu exemple amb el controlador mobiletto `s3` .
107
+
108
+ Aquest codi s'executaria igual si el controlador fos `b2` o `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
+ ## Ús bàsic
139
+ Un exemple molt més ampli, que mostra la majoria de les funcions que s'ofereixen:
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
+ ## Metadades
241
+ L'ordre `metadata` retorna metadades sobre una única entrada del sistema de fitxers.
242
+ De la mateixa manera, el valor de retorn de l'ordre `list` és una matriu d'objectes de metadades.
243
+
244
+ Un objecte de metadades té aquest aspecte:
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 propietat " `type` pot ser `file` ", `dir` ", `link` o `special` .
255
+
256
+ Depenent del tipus de controlador, una ordre `list` pot no retornar tots els camps. Les propietats `name` " i `type` .
257
+ hauria d'estar sempre present. Una ordre `metadata` posterior retornarà totes les propietats disponibles.
258
+
259
+ ## Estil d'importació alternatiu
260
+ Importeu el mòdul d'abast complet i utilitzeu la funció `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
+ ## Emmagatzematge a la memòria cau
268
+ Mobiletto funciona millor amb una memòria cau <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto intentarà connectar-se a una instància redis a 127.0.0.1:6379
271
+
272
+ Podeu anul·lar qualsevol d'aquests:
273
+ * Establiu la var env `MOBILETTO_REDIS_HOST` , mobileper connectar-vos aquí en lloc de localhost
274
+ * Establiu la var env `MOBILETTO_REDIS_PORT` , s'utilitzarà aquest port
275
+
276
+ Mobiletto emmagatzemarà totes les seves claus redis amb el prefix `_mobiletto__` . Podeu canviar això
277
+ mitjançant la configuració de la var env `MOBILETTO_REDIS_PREFIX`
278
+
279
+ També podeu establir la memòria cau per connexió amb l'objecte `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
+ ### No voleu la memòria cau de redis?
291
+ Per desactivar: passeu `enabled: false` al vostre objecte `opts.redisConfig` quan establiu la vostra connexió.
292
+
293
+ Com es comenta a continuació, la desactivació de la memòria cau tindrà un efecte advers en el rendiment i generarà més sol·licituds
294
+ a l'emmagatzematge que realment necessiteu.
295
+
296
+ ### Guia per a la memòria cau
297
+ **Emmagatzematge encriptat**: la lectura/escriptura d'emmagatzematge encriptat és només una mica més lent del normal,
298
+ però navegar pels directoris (cosa que fan algunes coses) és bastant car. Utilitzant una memòria cau redis
299
+ us donarà un augment significatiu del rendiment.
300
+
301
+ La memòria cau per defecte és segura, però no funciona bé si teniu moltes operacions d'escriptura/eliminació.
302
+ Qualsevol operació d'escriptura o eliminació invalida tota la memòria cau, assegurant que les lectures posteriors veuran el fitxer
303
+ els últims canvis.
304
+
305
+ ### Eines CLI
306
+ Si utilitzeu una eina CLI com [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Definitivament, voldreu que la memòria cau redis estigui habilitada, ja que dura durant les invocacions de l'ordre `mo` .
308
+
309
+ ## Mirall
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
+ L'ordre `mirror` realitza una còpia única de tots els fitxers d'un mòbil a un altre.
318
+ No executa cap procés per mantenir el mirall al llarg del temps. Executeu l'ordre `mirror` nou
319
+ per sincronitzar els fitxers que falten.
320
+
321
+ El valor de retorn de `mirror` és un objecte senzill amb comptadors per quants fitxers s'han realitzat correctament
322
+ duplicats i quants fitxers tenien errors:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ ADVERTÈNCIA: La duplicació de grans conjunts de dades pot consumir molt de temps i ample de banda
330
+
331
+ Amb la semàntica de la crida `mirror` vegades pot resultar confús entendre qui és
332
+ lector i qui és l'escriptor. Imagineu-ho com una declaració d'assignació: el "mobiletto de la mà esquerra"
333
+ és la cosa a què s'assigna (dades escrites reflectides) i el "mobiletto de la dreta" (el
334
+ argument al mètode `mirror` ) és el valor que s'assigna (es llegeixen les dades reflectides).
335
+
336
+ ## Xifratge transparent
337
+ Activa el xifratge transparent del costat del 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 està passant? Un directori separat (xifrat) "entrada de directori" (directori) fa un seguiment dels fitxers que hi ha
357
+ directori (també conegut com el directori dirent).
358
+ * L'ordre `list` llegeix els fitxers d'entrada del directori, desxifra cada camí de la llista; després retorna les metadades per a cada fitxer
359
+ * Les ordres `list` són més ineficients, especialment per a directoris amb un gran nombre de fitxers
360
+ * L'ordre `write` escriu fitxers dirent al directori dirent de cada pare, de manera recursiva; després escriu el fitxer
361
+ * `write` ordres d'escriptura provocaran escriptures O(N), amb N = profunditat a la jerarquia de directoris
362
+ * L'ordre `remove` elimina el fitxer dirent corresponent, i el seu pare si està buit, de forma recursiva; llavors elimina el fitxer
363
+ * Les ordres `remove` no recursives provocaran lectures O (N) i potencialment tantes supressions, amb N = profunditat a la jerarquia de directoris
364
+ * Les ordres recursives `remove` en sistemes de fitxers grans i profunds poden ser cares
365
+
366
+ Tingueu en compte que fins i tot amb el xifratge del costat del client habilitat, un adversari amb visibilitat total del vostre servidor xifrat
367
+ L'emmagatzematge, fins i tot sense la clau, encara pot veure el nombre total de directoris i quants fitxers hi ha a cadascun, i amb
368
+ algun esforç, descobrir part o tota l'estructura global de la jerarquia de directoris.
369
+ *Nota: utilitzeu una estructura relativament plana per a una millor seguretat.*
370
+ L'adversari no sabria els noms dels directoris/fitxers tret que també conegués el vostre xifratge
371
+ clau o hagués trencat el xifratge amb èxit. Aleshores, totes les apostes estan desactivades!
372
+
373
+ ### Rendiment i memòria cau
374
+ Les operacions d'emmagatzematge xifrat poden ser lentes. Les fitxes recursives i les eliminacions poden ser molt lentes.
375
+ L'emmagatzematge a la memòria cau mitjançant redis ajuda enormement, però tingueu en compte que la memòria cau s'esborra en qualsevol escriptura o eliminació.
376
+
377
+ ## Rotació de tecles
378
+ Creeu un mòbiltto amb la vostra clau nova i, a continuació, reflectiu-hi les dades antigues:
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
+ ## Interfície del controlador
391
+ Un controlador és qualsevol fitxer JS que exporti una funció "storageClient" amb aquesta signatura:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : una cadena, la vostra clau API (per al controlador `local` aquest és el directori base)
396
+ * `secret` : una cadena, el vostre secret de l'API (es pot ometre per al controlador `local` )
397
+ * `opts` : un objecte, les propietats són per controlador:
398
+ * Per a `local` , les `fileMode` i `dirMode` determinen com es creen fitxers i directoris de creació nous
399
+ * Per a `s3` , la propietat `bucket` és necessària. Les propietats opcionals són:
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'objecte que retorna la funció storageClient ha de definir aquestes funcions:
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
+ ## Registre
431
+ Mobiletto utilitza la biblioteca de registre [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Els registres **contindran** els camins dels fitxers i els missatges d'error, però **mai** contindran claus, secrets,
434
+ o qualsevol altra informació de configuració de connexió.
435
+
436
+ ### Nivell de registre
437
+ Utilitzeu la variable d'entorn `MOBILETTO_LOG_LEVEL` per establir el nivell de registre, utilitzant-ne un
438
+ dels nivells `npm` definits a [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ El nivell predeterminat és `error` . El nivell més detallat és `silly` , encara que actualment mobiletto
441
+ no registra en nivells inferiors a `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Fitxer de registre
446
+ Per defecte, el registrador escriu a la consola. Per enviar registres a un fitxer, configureu el `MOBILETTO_LOG_FILE`
447
+ variable d'entorn. Quan inicieu sessió en un fitxer, els registres ja no s'escriuran a la consola.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Per desactivar el registre:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>