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
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto är ett JavaScript-lagringsabstraktionslager, med valfri transparent kryptering på klientsidan.
5
+
6
+ # Innehåll
7
+ * [Varför Mobiletto?](#Why-Mobiletto?)
8
+ * [Snabbstart](#Snabbstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Källa](#Källa)
11
+ * [Installation](#Installation)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Basic usage](#Basic-usage)
14
+ * [Metadata](#Metadata)
15
+ * [Alternativ importstil](#Alternate-import-style)
16
+ * [Caching](#Caching)
17
+ * [Spegling](#Spegling)
18
+ * [Transparent kryptering](#Transparent-kryptering)
19
+ * [Nyckelrotation](#Key-rotation)
20
+ * [Driver interface](#Driver-interface)
21
+ * [Logging](#Logging)
22
+
23
+ # Läs detta på ett annat språk
24
+ Detta README.md-dokument har översatts, via [hokeylization](https://github.com/cobbzilla/hokeylization), till
25
+ **[alla språk som stöds av Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Jag är säker på att det inte är perfekt, men jag hoppas att det är bättre än ingenting!
28
+
29
+ [🇸🇦 arabiska](../ar/README.md)
30
+ [🇧🇩 bengaliska](../bn/README.md)
31
+ [🇩🇪 tyska](../de/README.md)
32
+ [🇺🇸 engelska](../en/README.md)
33
+ [🇪🇸 spanska](../es/README.md)
34
+ [🇫🇷 franska](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 hindi](../hi/README.md)
37
+ [🇮🇩 indonesiska](../id/README.md)
38
+ [🇮🇹 italienska](../it/README.md)
39
+ [🇯🇵 japanska](../ja/README.md)
40
+ [🇰🇷 koreanska](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 polska](../pl/README.md)
43
+ [🇧🇷 portugisiska](../pt/README.md)
44
+ [🇷🇺 ryska](../ru/README.md)
45
+ [🇰🇪 swahili](../sw/README.md)
46
+ [🇵🇭 Tagalog](../tl/README.md)
47
+ [🇹🇷 turkiska](../tr/README.md)
48
+ [🇵🇰 Urdu](../ur/README.md)
49
+ [🇻🇳 vietnamesiska](../vi/README.md)
50
+ [🇨🇳 kinesiska](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Alla språk ...](../README.md)**
54
+ ----
55
+
56
+ ### Finns det ett problem med denna översättning av README?
57
+ Denna speciella översättning av originalet [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ kan vara felaktiga -- *korrigeringar är mycket välkomna!* Skicka en [pull request på GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ eller om du inte är bekväm med att göra det, [öppna ett problem](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ När du skapar ett nytt GitHub-nummer om en översättning, vänligen gör:
62
+ * inkludera sidans URL (kopiera/klistra in från webbläsarens adressfält)
63
+ * inkludera den exakta texten som är fel (kopiera/klistra in från webbläsaren)
64
+ * vänligen beskriv vad som är fel -- är översättningen felaktig? är formateringen trasig på något sätt?
65
+ * kom gärna med ett förslag på en bättre översättning eller hur texten bör formateras korrekt
66
+ * **Tack!**
67
+
68
+ ## Varför Mobiletto?
69
+
70
+ ### Adjö leverantörens inlåsning!
71
+ De olika molnlagringsleverantörerna har inkompatibla API:er. Även de som strävar efter "S3-kompatibilitet"
72
+ har idiosynkratiska beteenden.
73
+
74
+ När du väljer en viss lagringsleverantör för din app, om du kodar direkt till deras API, din app
75
+ är nu beroende av den tjänsten. Allt eftersom tiden går och koden ackumuleras, byter leverantörer
76
+ allt mer ohållbar. Välkommen till den roliga världen av leverantörslåsning!
77
+
78
+ Mobiletto designades för att lösa detta problem. Genom att koda din app till mobilettos API kan du enkelt
79
+ byt lagringsleverantör och vet att din apps lagringslager kommer att bete sig identiskt.
80
+
81
+ ### Omfattande testning
82
+ Alla förare testas för identiskt beteende med 60+ tester för varje förare.
83
+ Vi testar alla förare med varje kombination av:
84
+ * Kryptering: både aktiverad och inaktiverad
85
+ * Redis cache: både aktiverad och inaktiverad
86
+
87
+ Detta tillvägagångssätt ger oss trygghet i att mobiletto kommer att bete sig likadant oavsett vilken drivrutin du använder,
88
+ och oavsett om du aktiverar cachning och/eller kryptering.
89
+
90
+ ### Drivrutinsstöd
91
+ Aktuella Mobiletto-lagringsdrivrutiner:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : lokalt filsystem
95
+
96
+ *Bidrag för att stödja fler molnlagringsleverantörer är mycket välkomna!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto är avsedd att användas som ett bibliotek av annan JavaScript-kod.
100
+
101
+ För att arbeta med mobiletto på kommandoraden, använd [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Källa
104
+ * [mobiletto på GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto på npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Stöd och finansiering
108
+ Jag försöker bli en professionell mjukvaruutvecklare med öppen källkod. Jag har jobbat i
109
+ mjukvaruindustrin i många år har jag startat framgångsrika företag och sålt dem till offentliga företag.
110
+ Nyligen förlorade jag mitt jobb, och jag har egentligen inget annat arbete på gång
111
+
112
+ Så jag ska försöka skriva användbar programvara och se om det fungerar
113
+
114
+ Om du gillar att använda den här programvaran skulle jag vara mycket tacksam för även den
115
+ minsta [månadsbidrag via Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Tack!*
118
+
119
+ ## Installation
120
+ Installera med `npm` eller `yarn` . Du vill förmodligen ha `lite` -versionen som inte inkluderar alla
121
+ översatta README-filer:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Om du verkligen vill ha README-filerna på alla språk, installera den fullständiga versionen:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Snabbstart
132
+ Ett kort exempel med drivrutinen för mobiletto `s3` .
133
+
134
+ Den här koden skulle köras på samma sätt om drivrutinen var `b2` eller `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
+ ## Grundläggande användning
165
+ Ett mycket mer omfattande exempel som visar de flesta funktioner som erbjuds:
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
+ Kommandot `metadata` returnerar metadata om en enda filsystempost.
268
+ På samma sätt är returvärdet från kommandot `list` en array av metadataobjekt.
269
+
270
+ Ett metadataobjekt ser ut så här:
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
+ `type` kan vara `file` , `dir` , `link` eller `special` .
281
+
282
+ Beroende på typ av drivrutin kan ett `list` kommando inte returnera alla fält. `name` och `type`
283
+ ska alltid vara närvarande. Ett efterföljande `metadata` kommando kommer att returnera alla tillgängliga egenskaper.
284
+
285
+ ## Alternativ importstil
286
+ Importera den fullständiga modulen och använd `connect` -funktionen:
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
+ ## Cachning
294
+ Mobiletto fungerar bäst med en <a href="https://redis.io">redis-</a> cache.
295
+
296
+ Mobiletto kommer att försöka ansluta till en redis-instans på 127.0.0.1:6379
297
+
298
+ Du kan åsidosätta någon av dessa:
299
+ * Ställ in `MOBILETTO_REDIS_HOST` var, mobiletto ansluta här istället för localhost
300
+ * Ställ in `MOBILETTO_REDIS_PORT` var, denna port kommer att användas
301
+
302
+ Mobiletto kommer att lagra alla sina redis-nycklar med prefixet `_mobiletto__` . Du kan ändra detta
303
+ genom att ställa in `MOBILETTO_REDIS_PREFIX` var.
304
+
305
+ Du kan också ställa in cachelagring per anslutning med objektet `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
+ ### Vill du inte ha redis caching?
317
+ För att inaktivera: skicka `enabled: false` i ditt `opts.redisConfig` objekt när du upprättar din anslutning.
318
+
319
+ Som diskuteras nedan kommer att inaktivera cachning ha en negativ effekt på prestandan och få fler förfrågningar
320
+ till förvaring som du verkligen behöver.
321
+
322
+ ### Cachningsvägledning
323
+ **Krypterad lagring**: läsning/skrivning av krypterad lagring är bara lite långsammare än normalt,
324
+ men att navigera runt i kataloger (vilket vissa saker gör) är ganska dyrt. Använder en redis cache
325
+ kommer att ge dig en betydande prestandaökning.
326
+
327
+ Standardcachen är säker, men fungerar inte bra om du har många skriv-/borttagningsåtgärder.
328
+ Varje skriv- eller borttagningsoperation ogiltigförklarar hela cachen, vilket säkerställer att efterföljande läsningar kommer att se
329
+ senaste ändringarna.
330
+
331
+ ### CLI-verktyg
332
+ Om du använder ett CLI-verktyg som [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ du vill definitivt att redis-cachen är aktiverad, eftersom den varar över anrop av kommandot `mo` .
334
+
335
+ ## Spegling
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
+ `mirror` utför en engångskopia av alla filer från en mobiltto till en annan.
344
+ Den kör ingen process för att underhålla spegeln över tid. Kör kommandot `mirror` igen
345
+ för att synkronisera eventuella saknade filer.
346
+
347
+ Returvärdet från `mirror` är ett enkelt objekt med räknare för hur många filer som lyckades
348
+ speglade och hur många filer hade fel:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ VARNING: Spegling av stora datamängder kan vara mycket tidskrävande och bandbreddskrävande
356
+
357
+ Med `mirror` kan det ibland vara förvirrande att förstå vem som är
358
+ läsare och vem som är författare. Föreställ dig det som en uppgiftsbeskrivning: "vänsterhandsmobilen"
359
+ är saken som tilldelas (speglad data skriven), och "höger mobiltto" (den
360
+ argument till `mirror` ) är värdet som tilldelas (speglad data läses).
361
+
362
+ ## Transparent kryptering
363
+ Aktivera transparent kryptering på klientsidan:
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
+ Vad händer? En separat "katalogpost" (dirent) katalog (krypterad) spårar vilka filer som finns i den
383
+ katalog (alias dirent-katalogen).
384
+ * `list` läser kataloginmatningsfilerna, dekrypterar varje listad sökväg; returnerar sedan metadata för varje fil
385
+ * `list` kommandon är mer ineffektiva, speciellt för kataloger med ett stort antal filer
386
+ * `write` skriver dirent-filer i varje förälders dirent-katalog, rekursivt; skriver sedan filen
387
+ * `write` kommandon kommer att medföra O(N)-skrivningar, med N = djup i kataloghierarkin
388
+ * `remove` tar bort motsvarande dirent-fil och dess överordnade om den är tom, rekursivt; tar sedan bort filen
389
+ * Icke-rekursiva `remove` kommandon kommer att medföra O(N)-läsningar och potentiellt lika många borttagningar, med N = djup i kataloghierarkin
390
+ * Rekursiva `remove` kommandon på stora och djupa filsystem kan vara dyrt
391
+
392
+ Observera att även med kryptering på klientsidan aktiverad, en motståndare med full insyn i din krypterade serversida
393
+ lagring, även utan nyckel, kan fortfarande se det totala antalet kataloger och hur många filer som finns i varje, och med
394
+ lite ansträngning, upptäck en del eller hela den övergripande strukturen i kataloghierarkin.
395
+ *Obs! Använd en relativt platt struktur för bättre säkerhet.*
396
+ Motståndaren skulle inte veta namnen på katalogerna/filerna om de inte också kände till din kryptering
397
+ nyckel eller på annat sätt hade lyckats knäcka krypteringen. Då är alla spel avstängda!
398
+
399
+ ### Prestanda och cachelagring
400
+ Operationer på krypterad lagring kan vara långsamma. Rekursiva listor och borttagningar kan vara mycket långsamma.
401
+ Cachning via redis hjälper enormt, men observera att cachen töms vid alla skrivningar eller borttagningar.
402
+
403
+ ## Tangentrotation
404
+ Skapa en mobiltto med din nya nyckel och spegla sedan den gamla datan i den:
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
+ ## Drivrutinsgränssnitt
417
+ En drivrutin är en JS-fil som exporterar en 'storageClient'-funktion med denna signatur:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : en sträng, din API-nyckel (för den `local` drivrutinen är detta baskatalogen)
422
+ * `secret` : en sträng, din API-hemlighet (kan utelämnas för den `local` drivrutinen)
423
+ * `opts` : ett objekt, egenskaperna är per drivrutin:
424
+ * För `local` bestämmer egenskaperna `fileMode` och `dirMode` hur nya skapande filer och kataloger skapas
425
+ * För `s3` krävs egenskapen `bucket` . Valfria egenskaper är:
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
+ Objektet som storageClient-funktionen returnerar måste definiera dessa funktioner:
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
+ ## Loggning
457
+ Mobiletto använder loggningsbiblioteket [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Loggar **kommer** att innehålla sökvägar och felmeddelanden, men kommer **aldrig** att innehålla nycklar, hemligheter,
460
+ eller annan information om anslutningskonfiguration.
461
+
462
+ ### Loggnivå
463
+ Använd `MOBILETTO_LOG_LEVEL` för att ställa in loggnivån med en
464
+ av `npm` som definieras i [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Standardnivån är `error` . Den mest utförliga nivån är "fånigt", även om `silly` för närvarande är
467
+ loggar inte på nivåer under `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Loggfil
472
+ Som standard skriver loggern till konsolen. För att skicka loggar till en fil, ställ in `MOBILETTO_LOG_FILE`
473
+ miljöfaktor. När du loggar till en fil kommer loggar inte längre att skrivas till konsolen.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Så här stänger du av loggning:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>