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 is een JavaScript-opslagabstractielaag, met optionele transparante versleuteling aan de clientzijde.
5
+
6
+ # Inhoud
7
+ * [Waarom Mobiletto?](#Waarom-Mobiletto?)
8
+ * [Snelstart](#Snelstart)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Bron](#Bron)
11
+ * [Basisgebruik](#Basic-gebruik)
12
+ * [Metagegevens](#Metagegevens)
13
+ * [Alternatieve importstijl](#Alternatieve-importstijl)
14
+ * [Caching](#Caching)
15
+ * [Spiegelen](#Spiegelen)
16
+ * [Transparante encryptie](#Transparante-encryptie)
17
+ * [Sleutelrotatie](#Sleutelrotatie)
18
+ * [Driver-interface](#Driver-interface)
19
+ * [Logboekregistratie](#logboekregistratie)
20
+
21
+ # Lees dit in een andere taal
22
+ Dit README.md-document is via [hokeylization](https://github.com/cobbzilla/hokeylization) vertaald in
23
+ **[elke taal ondersteund door Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Ik weet zeker dat het niet perfect is, maar ik hoop dat het beter is dan niets!
26
+
27
+ [🇸🇦 Arabisch](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Duits](../de/README.md)
30
+ [🇺🇸 Nederlands](../en/README.md)
31
+ [🇪🇸 Spaans](../es/README.md)
32
+ [🇫🇷 Frans](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesisch](../id/README.md)
36
+ [🇮🇹 Italiaans](../it/README.md)
37
+ [🇯🇵 Japans](../ja/README.md)
38
+ [🇰🇷 Koreaans](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Pools](../pl/README.md)
41
+ [🇧🇷 Portugees](../pt/README.md)
42
+ [🇷🇺 Russisch](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turks](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamees](../vi/README.md)
48
+ [🇨🇳 Chinees](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Alle talen ...](../README.md)**
52
+ ----
53
+
54
+ ### Is er een probleem met deze vertaling van de README?
55
+ Deze specifieke vertaling van het origineel [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ kan gebrekkig zijn -- *correcties zijn zeer welkom!* Stuur een [pull-verzoek op GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ of als u zich daar niet prettig bij voelt, [open een probleem](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Wanneer u een nieuw GitHub-probleem maakt over een vertaling, doet u het volgende:
60
+ * inclusief de pagina-URL (kopiëren/plakken uit de adresbalk van de browser)
61
+ * voeg de exacte tekst toe die fout is (kopiëren/plakken vanuit browser)
62
+ * beschrijf a.u.b. wat er mis is -- is de vertaling onjuist? is de opmaak op de een of andere manier kapot?
63
+ * graag een suggestie voor een betere vertaling, of hoe de tekst correct moet worden opgemaakt
64
+ * **Dank je!**
65
+
66
+ ## Waarom Mobiletto?
67
+
68
+ ### Vaarwel vendor lock-in!
69
+ De verschillende cloudopslagproviders hebben incompatibele API's. Zelfs degenen die streven naar "S3-compatibiliteit"
70
+ eigenzinnig gedrag hebben.
71
+
72
+ Wanneer u een bepaalde opslagleverancier voor uw app kiest en u rechtstreeks codeert naar hun API, uw app
73
+ is nu afhankelijk van die dienst. Naarmate de tijd verstrijkt en de code zich opstapelt, wordt het veranderen van leverancier
74
+ steeds onhoudbaarder. Welkom in de leuke wereld van vendor lock-in!
75
+
76
+ Mobiletto is ontworpen om dit probleem op te lossen. Door uw app te coderen naar de API van mobiletto, kunt u gemakkelijk
77
+ verander opslagproviders en weet dat de opslaglaag van uw app zich identiek zal gedragen.
78
+
79
+ ### Uitgebreid testen
80
+ Alle chauffeurs worden getest op identiek gedrag met 60+ tests voor elke chauffeur.
81
+ We testen alle chauffeurs met elke combinatie van:
82
+ * Encryptie: zowel ingeschakeld als uitgeschakeld
83
+ * Redis-cache: zowel ingeschakeld als uitgeschakeld
84
+
85
+ Deze aanpak geeft ons gemoedsrust dat mobiletto zich hetzelfde zal gedragen, ongeacht welke driver je gebruikt,
86
+ en ongeacht of u caching en/of encryptie inschakelt.
87
+
88
+ ### Bestuurdersondersteuning
89
+ Huidige Mobiletto-opslagstuurprogramma's:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokaal bestandssysteem
93
+
94
+ *Bijdragen om meer cloudopslagproviders te ondersteunen zijn van harte welkom!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto is bedoeld om te worden gebruikt als bibliotheek door andere JavaScript-code.
98
+
99
+ Gebruik [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) om met mobiletto op de opdrachtregel te werken
100
+
101
+ ## Bron
102
+ * [mobiletto op GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto op npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Snelle start
106
+ Een kort voorbeeld met de mobiletto `s3` driver.
107
+
108
+ Deze code zou hetzelfde werken als het stuurprogramma `b2` of `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
+ ## Basisgebruik
139
+ Een veel uitgebreider voorbeeld dat de meeste aangeboden functies laat zien:
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
+ ## Metagegevens
241
+ De opdracht `metadata` retourneert metadata over een enkele invoer in het bestandssysteem.
242
+ Evenzo is de retourwaarde van de opdracht `list` een array van metadata-objecten.
243
+
244
+ Een metadata-object ziet er als volgt uit:
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
+ De eigenschap `type` kan `file` , `dir` , `link` of `special` .
255
+
256
+ Afhankelijk van het type stuurprogramma, kan het zijn dat een `list` opdracht niet alle velden retourneert. De eigenschappen `name` en `type`
257
+ moet altijd aanwezig zijn. Een volgend `metadata` commando retourneert alle beschikbare eigenschappen.
258
+
259
+ ## Alternatieve importstijl
260
+ Importeer de full-scoped module en gebruik de `connect` functie:
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
+ ## Caching
268
+ Mobiletto werkt het beste met een <a href="https://redis.io">redis-</a> cache.
269
+
270
+ Mobiletto zal proberen verbinding te maken met een redis-instantie op 127.0.0.1:6379
271
+
272
+ U kunt een van deze overschrijven:
273
+ * Stel de `MOBILETTO_REDIS_HOST` env var, mobiletto hier verbinden in plaats van localhost
274
+ * Stel de `MOBILETTO_REDIS_PORT` env var in, deze poort zal worden gebruikt
275
+
276
+ Mobiletto slaat al zijn redis-sleutels op met het voorvoegsel `_mobiletto__` . Je kunt dit veranderen
277
+ door de `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ U kunt caching per verbinding ook instellen met het object `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
+ ### Wil je geen redis-caching?
291
+ Om uit te schakelen: geef `enabled: false` in uw `opts.redisConfig` object wanneer u uw verbinding tot stand brengt.
292
+
293
+ Zoals hieronder wordt besproken, zal het uitschakelen van caching een negatief effect hebben op de prestaties en meer verzoeken veroorzaken
294
+ tot opslag die u echt nodig heeft.
295
+
296
+ ### Caching-begeleiding
297
+ **Versleutelde opslag**: lezen/schrijven van versleutelde opslag gaat maar iets langzamer dan normaal,
298
+ maar navigeren door mappen (wat sommige dingen doen) is vrij duur. Een redis-cache gebruiken
299
+ geeft u een aanzienlijke prestatieverbetering.
300
+
301
+ De standaardcache is veilig, maar werkt niet goed als u veel schrijf-/verwijderbewerkingen uitvoert.
302
+ Elke schrijf- of verwijderbewerking maakt de hele cache ongeldig, zodat bij volgende leesbewerkingen de
303
+ laatste wijzigingen.
304
+
305
+ ### CLI-tools
306
+ Als u een CLI-tool zoals [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) gebruikt,
307
+ je wilt zeker dat de redis-cache is ingeschakeld, omdat deze blijft bestaan bij het aanroepen van het `mo` commando.
308
+
309
+ ## Spiegelen
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
+ Het `mirror` commando voert een eenmalige kopie uit van alle bestanden van de ene mobiletto naar de andere.
318
+ Er wordt geen proces uitgevoerd om de spiegel in de loop van de tijd te onderhouden. Voer de opdracht `mirror` opnieuw uit
319
+ om ontbrekende bestanden te synchroniseren.
320
+
321
+ De retourwaarde van `mirror` is een eenvoudig object met tellers voor het aantal bestanden dat met succes is uitgevoerd
322
+ gespiegeld en hoeveel bestanden fouten bevatten:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ WAARSCHUWING: Het spiegelen van grote datasets kan erg tijdrovend en bandbreedte-intensief zijn
330
+
331
+ Met de `mirror` -oproepsemantiek kan het soms verwarrend zijn om te begrijpen wie de
332
+ lezer en wie is de schrijver. Stel je het voor als een opdrachtverklaring: de "linkse mobiletto"
333
+ is het ding dat wordt toegewezen aan (gespiegelde gegevens geschreven), en de "right-hand mobiletto" (de
334
+ argument voor de `mirror` methode) is de waarde die wordt toegewezen (gespiegelde gegevens worden gelezen).
335
+
336
+ ## Transparante encryptie
337
+ Schakel transparante versleuteling aan de clientzijde in:
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
+ Wat is er gaande? Een aparte "directory entry" (dirent) directory (gecodeerd) houdt bij welke bestanden daarin staan
357
+ directory (ook wel de dirent directory genoemd).
358
+ * Het `list` commando leest de directory-invoerbestanden, decodeert elk vermeld pad; retourneert vervolgens metadata voor elk bestand
359
+ * `list` commando's zijn inefficiënter, vooral voor mappen met een groot aantal bestanden
360
+ * Het `write` commando schrijft recursief dirent-bestanden in de dirent-directory van elke ouder; schrijft vervolgens het bestand
361
+ * `write` commando's zullen O(N) schrijfacties veroorzaken, met N = diepte in de directoryhiërarchie
362
+ * Het `remove` commando verwijdert het corresponderende dirent-bestand, en zijn ouder indien leeg, recursief; verwijdert vervolgens het bestand
363
+ * Niet-recursieve `remove` -commando's leiden tot O(N)-leesbewerkingen en mogelijk evenveel verwijderingen, met N = diepte in de directoryhiërarchie
364
+ * Recursieve `remove` commando's op grote en diepe bestandssystemen kunnen duur zijn
365
+
366
+ Merk op dat zelfs als versleuteling aan de clientzijde is ingeschakeld, een tegenstander volledig inzicht heeft in uw versleutelde server-side
367
+ opslag, zelfs zonder de sleutel, kan nog steeds het totale aantal mappen zien en hoeveel bestanden zich in elke map bevinden, en met
368
+ enige moeite, ontdek dan een deel of de hele algemene structuur van de directoryhiërarchie.
369
+ *Opmerking: gebruik een relatief platte structuur voor een betere beveiliging.*
370
+ De tegenstander zou de namen van de mappen/bestanden niet kennen, tenzij ze ook uw encryptie kenden
371
+ sleutel of de codering op een andere manier succesvol had gekraakt. Alle weddenschappen zijn dan af!
372
+
373
+ ### Prestaties en caching
374
+ Bewerkingen op versleutelde opslag kunnen traag zijn. Recursieve vermeldingen en verwijderingen kunnen erg traag zijn.
375
+ Caching via redis helpt enorm, maar houd er rekening mee dat de cache wordt leeggemaakt bij elke schrijf- of verwijderingsactie.
376
+
377
+ ## Sleutelrotatie
378
+ Maak een mobiletto met uw nieuwe sleutel en spiegel de oude gegevens erin:
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
+ ## Driver-interface
391
+ Een stuurprogramma is elk JS-bestand dat een 'storageClient'-functie exporteert met deze handtekening:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : een string, je API-sleutel (voor de `local` driver is dit de basisdirectory)
396
+ * `secret` : een string, uw API-geheim (kan worden weggelaten voor de `local` driver)
397
+ * `opts` : een object, de eigenschappen zijn per driver:
398
+ * Voor `local` bepalen de eigenschappen `fileMode` en `dirMode` hoe nieuwe bestanden en mappen worden aangemaakt
399
+ * Voor `s3` is de eigenschap `bucket` vereist. Optionele eigenschappen zijn:
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
+ Het object dat de functie storageClient retourneert, moet deze functies definiëren:
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
+ ## Loggen
431
+ Mobiletto gebruikt de logbibliotheek van [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Logboeken **zal** bestandspaden en foutmeldingen bevatten, maar **nooit** sleutels, geheimen,
434
+ of andere informatie over de verbindingsconfiguratie.
435
+
436
+ ### Log niveau
437
+ Gebruik de `MOBILETTO_LOG_LEVEL` omgevingsvariabele om het logniveau in te stellen, met één
438
+ van de `npm` niveaus gedefinieerd in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Het standaardniveau is `error` . Het meest uitgebreide niveau is `silly` , hoewel momenteel mobiletto
441
+ logt niet in op niveaus onder `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Logbestand
446
+ Standaard schrijft de logger naar de console. Om logs naar een bestand te sturen, stelt u de `MOBILETTO_LOG_FILE`
447
+ omgevingsvariabele. Wanneer u zich aanmeldt bij een bestand, worden er geen logboeken meer naar de console geschreven.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Logboekregistratie uitschakelen:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>